Method | Description | |
---|---|---|
addProxyAddress ( string $address ) : |
Add's a single proxy address to the user. | |
changePassword ( string $oldPassword, string $newPassword, boolean $replaceNotRemove = false ) : boolean | Change the password of the current user. This must be performed over SSL. | |
expirationDate ( ) : DateTim\DateTime | null | Return the expiration date of the user account. | |
getAccountExpiry ( ) : string | Returns the users account expiry date. | |
getAuthIdentifier ( ) : mixed | Get the unique identifier for the user. | |
getAuthIdentifierName ( ) : string | Get the name of the unique identifier for the user. | |
getAuthPassword ( ) : string | Get the password for the user. | |
getBadPasswordCount ( ) : string | Returns the users bad password count. | |
getBadPasswordTime ( ) : string | Returns the users bad password time. | |
getCompany ( ) : string | Returns the users company. | |
getCountry ( ) : string | Returns the users country. | |
getDepartment ( ) : string | Returns the users department. | |
getDepartmentNumber ( ) : string | Returns the department number. | |
getDisplayName ( ) : string | Returns the users display name. | |
getEmail ( ) : string | Returns the users primary email address. | |
getEmails ( ) : array | Returns the users email addresses. | |
getEmployeeId ( ) : string | Return the employee ID. | |
getEmployeeNumber ( ) : string | Returns the employee number. | |
getFirstName ( ) : mixed | Returns the users first name. | |
getHomeMdb ( ) : string | Returns the users mailbox store DN. | |
getInfo ( ) : mixed | Returns the users info. | |
getInitials ( ) : mixed | Returns the users initials. | |
getJpegPhoto ( ) : mixed | Returns the users jpeg photo. | |
getJpegPhotoEncoded ( ) : null | string | Returns the users jpeg photo. | |
getLastName ( ) : mixed | Returns the users last name. | |
getLegacyExchangeDn ( ) : string | Returns the users legacy exchange distinguished name. | |
getLocale ( ) : string | Returns the users locale. | |
getLockoutTime ( ) : string | Returns the users lockout time. | |
getMailNickname ( ) : string | Returns the users mail nickname. | |
getManager ( ) : string | Returns the distinguished name of the user who is the user's manager. | |
getOtherMailbox ( ) : array | Returns the users other mailbox attribute. | |
getPasswordLastSet ( ) : string | Returns the time when the users password was set last. | |
getPasswordLastSetDate ( ) : string | null | Returns the formatted timestamp of the password last set date. | |
getPasswordLastSetTimestamp ( ) : float | null | Returns the password last set unix timestamp. | |
getPersonalTitle ( ) : |
Return the personal title. | |
getPhysicalDeliveryOfficeName ( ) : string | Returns the users physical delivery office name. | |
getPostalCode ( ) : string | Returns the users postal code. | |
getPrimaryGroup ( ) : |
Retrieves the primary group of the current user. | |
getProfilePath ( ) : string | Returns the users profile file path. | |
getProxyAddresses ( ) : array | Returns the users proxy addresses. | |
getRememberToken ( ) : string | Get the token value for the "remember me" session. | |
getRememberTokenName ( ) : string | Get the column name for the "remember me" token. | |
getRoomNumber ( ) : string | Returns the room number. | |
getScriptPath ( ) : string | Returns the users script path if the user has one. | |
getShowInAddressBook ( ) : array | Returns an array of address book DNs that the user is listed to be shown in. | |
getStreetAddress ( ) : |
Returns the users street address. | |
getTelephoneNumber ( ) : string | Returns the users telephone number. | |
getThumbnail ( ) : mixed | Returns the users thumbnail photo. | |
getThumbnailEncoded ( ) : null | string | Returns the users thumbnail photo base 64 encoded. | |
getTitle ( ) : string | Returns the users title. | |
getUserAccountControl ( ) : string | Returns the users user account control integer. | |
getUserPrincipalName ( ) : string | Returns the users principal name. | |
isActive ( ) : boolean | Return true / false if AD User is active (enabled & not expired). | |
isDisabled ( ) : boolean | Returns if the user is disabled. | |
isEnabled ( ) : boolean | Returns if the user is enabled. | |
isExpired ( DateTim\DateTime $date = null ) : boolean | Return true / false if the AD User is expired. | |
passwordExpired ( ) : boolean | Returns true / false if the users password is expired. | |
setAccountExpiry ( float $expiryTime ) : |
Sets the users account expiry date. | |
setCompany ( string $company ) : |
Sets the users company. | |
setCountry ( string $country ) : |
Sets the users country. | |
setDepartment ( string $department ) : |
Sets the users department. | |
setDepartmentNumber ( string $number ) : |
Sets the department number. | |
setDisplayName ( string $displayName ) : |
Sets the users display name. | |
setEmail ( string $email ) : |
Sets the users email. | |
setEmails ( array $emails = [] ) : |
Sets the users email addresses. | |
setEmployeeId ( string $employeeId ) : |
Sets the employee ID. | |
setEmployeeNumber ( string $number ) : |
Sets the employee number. | |
setFirstName ( string $firstName ) : |
Sets the users first name. | |
setInfo ( string $info ) : |
Sets the users info. | |
setInitials ( string $initials ) : |
Sets the users initials. | |
setLastName ( string $lastName ) : |
Sets the users last name. | |
setLocale ( string $locale ) : |
Sets the users locale. | |
setManager ( string $managerDn ) : |
Sets the distinguished name of the user who is the user's manager. | |
setOtherMailbox ( array $otherMailbox = [] ) : |
Sets the users other mailboxes. | |
setPassword ( string $password ) | Sets the password on the current user. | |
setPersonalTitle ( string $personalTitle ) : |
Sets the personal title. | |
setPhysicalDeliveryOfficeName ( string $deliveryOffice ) : |
Sets the users physical delivery office name. | |
setPostalCode ( string $postalCode ) : |
Sets the users postal code. | |
setProfilePath ( string $path ) : |
Sets the users profile path. | |
setProxyAddresses ( array $addresses = [] ) : |
Sets the users proxy addresses. | |
setRememberToken ( string $value ) : void | Set the token value for the "remember me" session. | |
setRoomNumber ( string $number ) : |
Sets the room number. | |
setScriptPath ( string $path ) : |
Sets the users script path. | |
setStreetAddress ( string $address ) : |
Sets the users street address. | |
setTelephoneNumber ( string $number ) : |
Sets the users telephone number. | |
setTitle ( string $title ) : |
Sets the users title. | |
setUserAccountControl ( integer | string | |
Sets the users account control property. | |
setUserPrincipalName ( string $userPrincipalName ) : |
Sets the users user principal name. |
public addProxyAddress ( string $address ) : |
||
$address | string | |
return |
public changePassword ( string $oldPassword, string $newPassword, boolean $replaceNotRemove = false ) : boolean | ||
$oldPassword | string | The new password |
$newPassword | string | The old password |
$replaceNotRemove | boolean | Alternative password change method. Set to true if you're receiving 'CONSTRAINT' errors. |
return | boolean |
public expirationDate ( ) : DateTim\DateTime | null | ||
return | DateTim\DateTime | null |
public getAccountExpiry ( ) : string | ||
return | string |
public getAuthIdentifier ( ) : mixed | ||
return | mixed |
public getAuthIdentifierName ( ) : string | ||
return | string |
public getAuthPassword ( ) : string | ||
return | string |
public getBadPasswordCount ( ) : string | ||
return | string |
public getBadPasswordTime ( ) : string | ||
return | string |
public getCompany ( ) : string | ||
return | string |
public getDepartment ( ) : string | ||
return | string |
public getDepartmentNumber ( ) : string | ||
return | string |
public getDisplayName ( ) : string | ||
return | string |
public getEmployeeId ( ) : string | ||
return | string |
public getEmployeeNumber ( ) : string | ||
return | string |
public getFirstName ( ) : mixed | ||
return | mixed |
public getHomeMdb ( ) : string | ||
return | string |
public getJpegPhoto ( ) : mixed | ||
return | mixed |
public getJpegPhotoEncoded ( ) : null | string | ||
return | null | string |
public getLastName ( ) : mixed | ||
return | mixed |
public getLegacyExchangeDn ( ) : string | ||
return | string |
public getLockoutTime ( ) : string | ||
return | string |
public getMailNickname ( ) : string | ||
return | string |
public getManager ( ) : string | ||
return | string |
public getOtherMailbox ( ) : array | ||
return | array |
public getPasswordLastSet ( ) : string | ||
return | string |
public getPasswordLastSetDate ( ) : string | null | ||
return | string | null |
public getPasswordLastSetTimestamp ( ) : float | null | ||
return | float | null |
public getPersonalTitle ( ) : |
||
return |
public getPhysicalDeliveryOfficeName ( ) : string | ||
return | string |
public getPostalCode ( ) : string | ||
return | string |
public getPrimaryGroup ( ) : |
||
return |
public getProfilePath ( ) : string | ||
return | string |
public getProxyAddresses ( ) : array | ||
return | array |
public getRememberToken ( ) : string | ||
return | string |
public getRememberTokenName ( ) : string | ||
return | string |
public getRoomNumber ( ) : string | ||
return | string |
public getScriptPath ( ) : string | ||
return | string |
public getShowInAddressBook ( ) : array | ||
return | array |
public getStreetAddress ( ) : |
||
return |
public getTelephoneNumber ( ) : string | ||
return | string |
public getThumbnail ( ) : mixed | ||
return | mixed |
public getThumbnailEncoded ( ) : null | string | ||
return | null | string |
public getUserAccountControl ( ) : string | ||
return | string |
public getUserPrincipalName ( ) : string | ||
return | string |
public isDisabled ( ) : boolean | ||
return | boolean |
public passwordExpired ( ) : boolean | ||
return | boolean |
public setAccountExpiry ( float $expiryTime ) : |
||
$expiryTime | float | |
return |
public setCompany ( string $company ) : |
||
$company | string | |
return |
public setCountry ( string $country ) : |
||
$country | string | |
return |
public setDepartment ( string $department ) : |
||
$department | string | |
return |
public setDepartmentNumber ( string $number ) : |
||
$number | string | |
return |
public setDisplayName ( string $displayName ) : |
||
$displayName | string | |
return |
public setEmployeeId ( string $employeeId ) : |
||
$employeeId | string | |
return |
public setEmployeeNumber ( string $number ) : |
||
$number | string | |
return |
public setFirstName ( string $firstName ) : |
||
$firstName | string | |
return |
public setInitials ( string $initials ) : |
||
$initials | string | |
return |
public setLastName ( string $lastName ) : |
||
$lastName | string | |
return |
public setManager ( string $managerDn ) : |
||
$managerDn | string | |
return |
public setOtherMailbox ( array $otherMailbox = [] ) : |
||
$otherMailbox | array | |
return |
public setPassword ( string $password ) | ||
$password | string |
public setPersonalTitle ( string $personalTitle ) : |
||
$personalTitle | string | |
return |
public setPhysicalDeliveryOfficeName ( string $deliveryOffice ) : |
||
$deliveryOffice | string | |
return |
public setPostalCode ( string $postalCode ) : |
||
$postalCode | string | |
return |
public setProfilePath ( string $path ) : |
||
$path | string | |
return |
public setProxyAddresses ( array $addresses = [] ) : |
||
$addresses | array | |
return |
public setRememberToken ( string $value ) : void | ||
$value | string | |
return | void |
public setRoomNumber ( string $number ) : |
||
$number | string | |
return |
public setScriptPath ( string $path ) : |
||
$path | string | |
return |
public setStreetAddress ( string $address ) : |
||
$address | string | |
return |
public setTelephoneNumber ( string $number ) : |
||
$number | string | |
return |
public setUserAccountControl ( integer | string | |
||
$accountControl | integer | string | |
|
return |
public setUserPrincipalName ( string $userPrincipalName ) : |
||
$userPrincipalName | string | |
return |