API Documentation

Zend/Gdata/Gapps/Extension/Login.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: Login.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Gapps_Extension_Login

Package: Zend\Gdata\Gapps

Represents the apps:login element used by the Apps data API. This class is used to describe properties of a user, and is usually contained within instances of Zene_Gdata_Gapps_UserEntry or any other class which is linked to a particular username.

Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedboolean  $_admin= 'null'

True if the user has administrative rights for this domain, false otherwise.

Default valuenullDetails
Type
boolean
Propertyprotected\boolean.  $_agreedToTerms= 'null'

True if the user has agreed to the terms of service for Google Apps, false otherwise.

Default valuenullDetails
Type
\boolean.
Propertyprotectedboolean  $_changePasswordAtNextLogin= 'null'

True if the user will be required to change their password at their next login, false otherwise.

Default valuenullDetails
Type
boolean
Propertyprotectedstring  $_hashFunctionName= 'null'

Specifies whether the password stored in _password is in cleartext or is an SHA-1 digest of a password. If the password is cleartext, then this should be null. If the password is an SHA-1 digest, then this should be set to 'SHA-1'.

At the time of writing, no other hash functions are supported

Default valuenullDetails
Type
string
Propertyprotectedstring  $_password= 'null'

The password for the user. May be in cleartext or as an SHA-1 digest, depending on the value of _hashFunctionName.

Default valuenullDetails
Type
string
Propertyprotected  $_rootElement= ''login''
Default value'login'Details
Type
Propertyprotected  $_rootNamespace= ''apps''
Default value'apps'Details
Type
Propertyprotectedboolean  $_suspended= 'null'

True if this user has been suspended, false otherwise.

Default valuenullDetails
Type
boolean
Propertyprotectedstring  $_username= 'null'

The username for this user. This is used as the user's email address and when logging in to Google Apps-hosted services.

Default valuenullDetails
Type
string

Methods

methodpublic__construct( string $username = null, string $password = null, string $hashFunctionName = null, boolean $admin = null, boolean $suspended = null, boolean $changePasswordAtNextLogin = null, boolean $agreedToTerms = null ) : void

Constructs a new Zend_Gdata_Gapps_Extension_Login object.

Parameters
Name Type Description
$username string

(optional) The username to be used for this login.

$password string

(optional) The password to be used for this login.

$hashFunctionName string

(optional) The name of the hash function used to protect the password, or null if no has function has been applied. As of this writing, the only valid values are 'SHA-1' or null.

$admin boolean

(optional) Whether the user is an administrator or not.

$suspended boolean

(optional) Whether this login is suspended or not.

$changePasswordAtNextLogin boolean

(optional) Whether the user is required to change their password at their next login.

$agreedToTerms boolean

(optional) Whether the user has agreed to the terms of service.

methodpublic__toString( ) : void

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

methodpublicgetAdmin( ) : boolean

Get the value for this element's admin attribute.

Returns
Type Description
boolean The requested attribute.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\setAdmin  
methodpublicgetAgreedToTerms( ) : boolean

Get the value for this element's agreedToTerms attribute.

Returns
Type Description
boolean The requested attribute.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\setAgreedToTerms  
methodpublicgetChangePasswordAtNextLogin( ) : boolean

Get the value for this element's changePasswordAtNextLogin attribute.

Returns
Type Description
boolean The requested attribute.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\setChangePasswordAtNextLogin  
methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetHashFunctionName( ) : string

Get the value for this element's hashFunctionName attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setHashFunctionName  
methodpublicgetPassword( ) : string

Get the value for this element's password attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setPassword  
methodpublicgetSuspended( ) : boolean

Get the value for this element's suspended attribute.

Returns
Type Description
boolean The requested attribute.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
See
\setSuspended  
methodpublicgetUsername( ) : string

Get the value for this element's username attribute.

Returns
Type Description
string The attribute being modified.
Details
See
\setUsername  
methodpublicsetAdmin( boolean $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's admin attribute. This indicates whether this user is an administrator for this domain.

Parameters
Name Type Description
$value boolean

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetAgreedToTerms( boolean $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's agreedToTerms attribute. This indicates whether this user has agreed to the terms of service.

Parameters
Name Type Description
$value boolean

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetChangePasswordAtNextLogin( boolean $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's changePasswordAtNextLogin attribute.

If true, the user will be forced to set a new password the next time they login.

Parameters
Name Type Description
$value boolean

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetHashFunctionName( string $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's hashFunctionName attribute. This indicates whether the password supplied with setPassword() is in plaintext or has had a hash function applied to it. If null, plaintext is assumed. As of this writing, the only valid hash function is 'SHA-1'.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
methodpublicsetPassword( string $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's password attribute. As of this writing, this can be either be provided as plaintext or hashed using the SHA-1 algorithm for protection. If using a hash function, this must be indicated by calling setHashFunctionName().

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
methodpublicsetSuspended( boolean $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's suspended attribute. If true, the user will not be able to login to this domain until unsuspended.

Parameters
Name Type Description
$value boolean

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetUsername( string $value ) : \Zend_Gdata_Gapps_Extension_Login

Set the value for this element's username attribute. This string is used to uniquely identify the user in this domian and is used to form this user's email address.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

Parameters
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Documentation was generated by DocBlox 0.15.1.