[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/Gapps/Extension/ -> Login.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 485 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_Gapps_Extension_Login:: (18 methods):
  __construct()
  getDOM()
  takeAttributeFromDOM()
  getUsername()
  setUsername()
  getPassword()
  setPassword()
  getHashFunctionName()
  setHashFunctionName()
  getAdmin()
  setAdmin()
  getAgreedToTerms()
  setAgreedToTerms()
  getSuspended()
  setSuspended()
  getChangePasswordAtNextLogin()
  setChangePasswordAtNextLogin()
  __toString()


Class: Zend_Gdata_Gapps_Extension_Login  - X-Ref

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.

__construct($username = null, $password = null,$hashFunctionName = null, $admin = null, $suspended = null,$changePasswordAtNextLogin = null, $agreedToTerms = null)   X-Ref
Constructs a new Zend_Gdata_Gapps_Extension_Login object.

param: string $username (optional) The username to be used for this
param: string $password (optional) The password to be used for this
param: string $hashFunctionName (optional) The name of the hash
param: boolean $admin (optional) Whether the user is an administrator
param: boolean $suspended (optional) Whether this login is suspended or not.
param: boolean $changePasswordAtNextLogin (optional) Whether
param: boolean $agreedToTerms (optional) Whether the user has

getDOM($doc = null, $majorVersion = 1, $minorVersion = null)   X-Ref
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.

param: DOMDocument $doc The DOMDocument used to construct DOMElements
return: DOMElement The DOMElement representing this element and all

takeAttributeFromDOM($attribute)   X-Ref
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.

param: DOMNode $attribute The DOMNode attribute needed to be handled

getUsername()   X-Ref
Get the value for this element's username attribute.

return: string The attribute being modified.

setUsername($value)   X-Ref
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.

param: string $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getPassword()   X-Ref
Get the value for this element's password attribute.

return: string The requested attribute.

setPassword($value)   X-Ref
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().

param: string $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getHashFunctionName()   X-Ref
Get the value for this element's hashFunctionName attribute.

return: string The requested attribute.

setHashFunctionName($value)   X-Ref
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'.

param: string $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getAdmin()   X-Ref
Get the value for this element's admin attribute.

return: boolean The requested attribute.

setAdmin($value)   X-Ref
Set the value for this element's admin attribute. This indicates
whether this user is an administrator for this domain.

param: boolean $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getAgreedToTerms()   X-Ref
Get the value for this element's agreedToTerms attribute.

return: boolean The requested attribute.

setAgreedToTerms($value)   X-Ref
Set the value for this element's agreedToTerms attribute. This
indicates whether this user has agreed to the terms of service.

param: boolean $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getSuspended()   X-Ref
Get the value for this element's suspended attribute.

return: boolean The requested attribute.

setSuspended($value)   X-Ref
Set the value for this element's suspended attribute. If true, the
user will not be able to login to this domain until unsuspended.

param: boolean $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

getChangePasswordAtNextLogin()   X-Ref
Get the value for this element's changePasswordAtNextLogin attribute.

return: boolean The requested attribute.

setChangePasswordAtNextLogin($value)   X-Ref
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.

param: boolean $value The desired value for this attribute.
return: Zend_Gdata_Gapps_Extension_Login Provides a fluent interface.

__toString()   X-Ref
Magic toString method allows using this directly via echo
Works best in PHP >= 4.2.0




Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1