PHP Interface Adldap\Schemas\SchemaInterface

Show file Open project: adldap2/adldap2 Interface Usage Examples

Public Methods

Method Description
accountExpires ( ) : string The date when the account expires. This value represents the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 or 0x7FFFFFFFFFFFFFFF (9223372036854775807) indicates that the account never expires.
accountName ( ) : string The logon name used to support clients and servers running earlier versions of the operating system, such as Windows NT 4.0, Windows 95, Windows 98, and LAN Manager. This attribute must be 20 characters or less to support earlier clients.
accountType ( ) : string This attribute contains information about every account type object.
adminDisplayName ( ) : string The name to be displayed on admin screens.
anr ( ) : string Ambiguous name resolution attribute to be used when choosing between objects.
badPasswordCount ( ) : string The number of times the user tried to log on to the account using an incorrect password. A value of 0 indicates that the value is unknown.
badPasswordTime ( ) : string The last time and date that an attempt to log on to this account was made with a password that is not valid.
commonName ( ) : string The name that represents an object.
company ( ) : string The user's company name.
computer ( ) : string The object class computer string.
configurationNamingContext ( ) : string DN enterprise configuration naming context.
contact ( ) : string The object class contact string.
country ( ) : string The entry's country attribute.
createdAt ( ) : string The entry's created at attribute.
currentTime ( ) : string The entry's current time attribute.
defaultNamingContext ( ) : string This is the default NC for a particular server.
department ( ) : string Contains the name for the department in which the user works.
departmentNumber ( ) : string Identifies a department within an organization.
description ( ) : string Contains the description to display for an object. This value is restricted as single-valued for backward compatibility in some cases but is allowed to be multi-valued in others.
displayName ( ) : string The display name for an object. This is usually the combination of the users first name, middle initial, and last name.
distinguishedName ( ) : string The LDAP API references an LDAP object by its distinguished name (DN).
distinguishedNameSubKey ( ) : integer | null The LDAP API references an LDAP object by its distinguished name (DN).
dnsHostName ( ) : string Name of computer as registered in DNS.
domainComponent ( ) : string Domain Component located inside an RDN.
driverName ( ) : string The device driver name.
driverVersion ( ) : string The Version number of device driver.
email ( ) : string The list of email addresses for a contact.
emailNickname ( ) : string The email nickname for the user.
employeeId ( ) : string The ID of an employee.
employeeNumber ( ) : string The number assigned to an employee other than the ID.
employeeType ( ) : string The job category for an employee.
false ( ) : string The AD false bool in string form for conversion.
firstName ( ) : string Contains the given name (first name) of the user.
groupType ( ) : string Contains a set of flags that define the type and scope of a group object.
homeAddress ( ) : string A user's home address.
homeMdb ( ) : string The users mailbox database location.
info ( ) : string The users extra notable information.
initials ( ) : string Contains the initials for parts of the user's full name.
instanceType ( ) : string A bitfield that dictates how the object is instantiated on a particular server.
isCriticalSystemObject ( ) : string If TRUE, the object hosting this attribute must be replicated during installation of a new replica.
jpegPhoto ( ) : string Used to store one or more images of a person using the JPEG File Interchange Format [JFIF].
lastLogOff ( ) : string This attribute is not used.
lastLogOn ( ) : string The last time the user logged on. This value is stored as a large integer that represents the number of 100-nanosecond intervals since January 1, 1601 (UTC).
lastLogOnTimestamp ( ) : string This is the time that the user last logged into the domain.
lastName ( ) : string This attribute contains the family or last name for a user.
legacyExchangeDn ( ) : string The distinguished name previously used by Exchange.
locale ( ) : string The users locale.
location ( ) : string The user's location, such as office number.
lockoutTime ( ) : string The date and time (UTC) that this account was locked out. This value is stored as a large integer that represents the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of zero means that the account is not currently locked out.
manager ( ) : string Contains the distinguished name of the user who is the user's manager.
maxPasswordAge ( ) : string The maximum amount of time, in 100-nanosecond intervals, a password is valid.
member ( ) : string The list of users that belong to the group.
memberOf ( ) : string The distinguished name of the groups to which this object belongs.
memberRange ( string | integer $from, string | integer $to ) : string The range limited list of users that belong to the group. See range limit in Active Directory (Range Retrieval of Attribute Values https://msdn.microsoft.com/en-us/library/cc223242.aspx) Issue #342
messageTrackingEnabled ( ) : string
msExchangeServer ( ) : string The object category of an exchange server.
name ( ) : string The general name of the entry.
neverExpiresDate ( ) : string Returns a string value indicating that an account does not expire.
objectCategory ( ) : string An object class name used to group objects of this or derived classes.
objectCategoryComputer ( ) : string The computer object category.
objectCategoryContainer ( ) : string The container object category.
objectCategoryExchangePrivateMdb ( ) : string The exchange private MDB category.
objectCategoryExchangeServer ( ) : string The exchange server object category.
objectCategoryExchangeStorageGroup ( ) : string The exchange storage group object category.
objectCategoryGroup ( ) : string The group object category.
objectCategoryOrganizationalUnit ( ) : string The organizational unit category.
objectCategoryPerson ( ) : string The person object category.
objectCategoryPrinter ( ) : string The printer object category.
objectClass ( ) : string The list of classes from which this class is derived.
objectClassComputer ( ) : string The computer object class.
objectClassContact ( ) : string The contact object class.
objectClassContainer ( ) : string The container object class.
objectClassGroup ( ) : string The group object class.
objectClassOu ( ) : string The ou object class.
objectClassPerson ( ) : string The person object class.
objectClassPrinter ( ) : string The printer object class.
objectClassUser ( ) : string The user object class.
objectGuid ( ) : string The unique identifier for an object.
objectSid ( ) : string A binary value that specifies the security identifier (SID) of the user.
operatingSystem ( ) : string The Operating System name, for example, Windows Vista Enterprise.
operatingSystemServicePack ( ) : string The operating system service pack ID string (for example, SP3).
operatingSystemVersion ( ) : string The operating system version string, for example, 4.0.
organizationName ( ) : mixed The RDN version of organization name for use in distinguished names.
organizationalPerson ( ) : string This class is used for objects that contain organizational information about a user, such as the employee number, department, manager, title, office address, and so on.
organizationalUnit ( ) : string A container for storing users, computers, and other account objects.
organizationalUnitShort ( ) : string The RDN version of organizational unit for use in distinguished names.
otherMailbox ( ) : string Contains other additional mail addresses in a form such as CCMAIL: JohnDoe.
passwordLastSet ( ) : string The date and time that the password for this account was last changed.
person ( ) : string The person object class.
personalTitle ( ) : string The user's title.
physicalDeliveryOfficeName ( ) : string Contains the office location in the user's place of business.
portName ( ) : string List of port names. For example, for printer ports or comm ports.
postalCode ( ) : string The postal or zip code for mail delivery.
primaryGroupId ( ) : string Contains the relative identifier (RID) for the primary group of the user.
printerBinNames ( ) : string A list of printer bin names.
printerColorSupported ( ) : string If a printer can print in color.
printerDuplexSupported ( ) : string Indicates the type of duplex support a printer has.
printerEndTime ( ) : string The time a print queue stops servicing jobs.
printerMaxResolutionSupported ( ) : string The maximum printer resolution.
printerMediaSupported ( ) : string A list of media supported by a printer.
printerMemory ( ) : string The amount of memory installed in a printer.
printerName ( ) : string The display name of an attached printer.
printerOrientationSupported ( ) : string The page rotation for landscape printing.
printerPrintRate ( ) : string Driver-supplied print rate.
printerPrintRateUnit ( ) : string Driver-supplied print rate unit.
printerShareName ( ) : string The printer's share name.
printerStaplingSupported ( ) : string If the printer supports stapling. Supplied by the driver.
printerStartTime ( ) : string The time a print queue begins servicing jobs.
priority ( ) : string The current priority (of a process, print job, and so on).
profilePath ( ) : string Specifies a path to the user's profile. This value can be a null string, a local absolute path, or a UNC path.
proxyAddresses ( ) : string A proxy address is the address by which a Microsoft Exchange Server recipient object is recognized in a foreign mail system. Proxy addresses are required for all recipient objects, such as custom recipients and distribution lists.
roomNumber ( ) : string The room number of an object.
rootDomainNamingContext ( ) : mixed The DN of the root domain NC for this DC's forest.
schemaNamingContext ( ) : mixed The attribute.
scriptPath ( ) : string This attribute specifies the path for the user's logon script. The string can be null.
serialNumber ( ) : string Part of X.500 specification. Not used by Active Directory.
serverName ( ) : string The name of a server.
showInAddressBook ( ) : string This attribute is used to indicate in which MAPI address books an object will appear.
street ( ) : string The street address.
streetAddress ( ) : string The street address.
systemFlags ( ) : string An integer value that contains flags that define additional properties of the class.
telephone ( ) : string The primary telephone number.
thumbnail ( ) : string The users thumbnail photo path.
title ( ) : string Contains the user's job title.
top ( ) : string The top level class from which all classes are derived.
true ( ) : string The AD true bool in string form for conversion.
unicodePassword ( ) : string The password of the user in Windows NT one-way format (OWF). Windows 2000 uses the Windows NT OWF.
updatedAt ( ) : string The date when this object was last changed.
url ( ) : string The entry's URL attribute.
user ( ) : string The user object class.
userAccountControl ( ) : string Flags that control the behavior of the user account.
userId ( ) : string The user ID attribute.
userPrincipalName ( ) : string This attribute contains the UPN that is an Internet-style login name for a user based on the Internet standard RFC 822.
versionNumber ( ) : string A general purpose version number.

Method Details

accountExpires() public method

The date when the account expires. This value represents the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 or 0x7FFFFFFFFFFFFFFF (9223372036854775807) indicates that the account never expires.
public accountExpires ( ) : string
return string

accountName() public method

The logon name used to support clients and servers running earlier versions of the operating system, such as Windows NT 4.0, Windows 95, Windows 98, and LAN Manager. This attribute must be 20 characters or less to support earlier clients.
public accountName ( ) : string
return string

accountType() public method

This attribute contains information about every account type object.
public accountType ( ) : string
return string

adminDisplayName() public method

The name to be displayed on admin screens.
public adminDisplayName ( ) : string
return string

anr() public method

Ambiguous name resolution attribute to be used when choosing between objects.
public anr ( ) : string
return string

badPasswordCount() public method

The number of times the user tried to log on to the account using an incorrect password. A value of 0 indicates that the value is unknown.
public badPasswordCount ( ) : string
return string

badPasswordTime() public method

The last time and date that an attempt to log on to this account was made with a password that is not valid.
public badPasswordTime ( ) : string
return string

commonName() public method

The name that represents an object.
public commonName ( ) : string
return string

company() public method

The user's company name.
public company ( ) : string
return string

computer() public method

Used when constructing new Computer models.
public computer ( ) : string
return string

configurationNamingContext() public method

DN enterprise configuration naming context.

contact() public method

Used when constructing new User models.
public contact ( ) : string
return string

country() public method

The entry's country attribute.
public country ( ) : string
return string

createdAt() public method

The entry's created at attribute.
public createdAt ( ) : string
return string

currentTime() public method

This attribute is only available with the Root DSE record.
public currentTime ( ) : string
return string

defaultNamingContext() public method

By default, the DN for the domain of which this directory server is a member.
public defaultNamingContext ( ) : string
return string

department() public method

Contains the name for the department in which the user works.
public department ( ) : string
return string

departmentNumber() public method

Identifies a department within an organization.
public departmentNumber ( ) : string
return string

description() public method

Contains the description to display for an object. This value is restricted as single-valued for backward compatibility in some cases but is allowed to be multi-valued in others.
public description ( ) : string
return string

displayName() public method

The display name for an object. This is usually the combination of the users first name, middle initial, and last name.
public displayName ( ) : string
return string

distinguishedName() public method

A DN is a sequence of relative distinguished names (RDN) connected by commas.
public distinguishedName ( ) : string
return string

distinguishedNameSubKey() public method

Different vendors expect the value of the distinguished name to be in different places. For example ActiveDirectory expects distinguishedname value to be the first element in an array, however OpenLDAP expects the dn attribute to contain the value, not an array.
public distinguishedNameSubKey ( ) : integer | null
return integer | null

dnsHostName() public method

Name of computer as registered in DNS.
public dnsHostName ( ) : string
return string

domainComponent() public method

Domain Component located inside an RDN.
public domainComponent ( ) : string
return string

driverName() public method

The device driver name.
public driverName ( ) : string
return string

driverVersion() public method

The Version number of device driver.
public driverVersion ( ) : string
return string

email() public method

The list of email addresses for a contact.
public email ( ) : string
return string

emailNickname() public method

The email nickname for the user.
public emailNickname ( ) : string
return string

employeeId() public method

The ID of an employee.
public employeeId ( ) : string
return string

employeeNumber() public method

The number assigned to an employee other than the ID.
public employeeNumber ( ) : string
return string

employeeType() public method

The job category for an employee.
public employeeType ( ) : string
return string

false() public method

The AD false bool in string form for conversion.
public false ( ) : string
return string

firstName() public method

Contains the given name (first name) of the user.
public firstName ( ) : string
return string

groupType() public method

Contains a set of flags that define the type and scope of a group object.
public groupType ( ) : string
return string

homeAddress() public method

A user's home address.
public homeAddress ( ) : string
return string

homeMdb() public method

The users mailbox database location.
public homeMdb ( ) : string
return string

info() public method

The users extra notable information.
public info ( ) : string
return string

initials() public method

This may be used as the middle initial in the Windows Address Book.
public initials ( ) : string
return string

instanceType() public method

The value of this attribute can differ on different replicas even if the replicas are in sync.
public instanceType ( ) : string
return string

isCriticalSystemObject() public method

If TRUE, the object hosting this attribute must be replicated during installation of a new replica.
public isCriticalSystemObject ( ) : string
return string

jpegPhoto() public method

Used to store one or more images of a person using the JPEG File Interchange Format [JFIF].
public jpegPhoto ( ) : string
return string

lastLogOff() public method

This attribute is not used.
public lastLogOff ( ) : string
return string

lastLogOn() public method

A value of zero means that the last logon time is unknown.
public lastLogOn ( ) : string
return string

lastLogOnTimestamp() public method

This is the time that the user last logged into the domain.
public lastLogOnTimestamp ( ) : string
return string

lastName() public method

This attribute contains the family or last name for a user.
public lastName ( ) : string
return string

legacyExchangeDn() public method

The distinguished name previously used by Exchange.
public legacyExchangeDn ( ) : string
return string

locale() public method

The users locale.
public locale ( ) : string
return string

location() public method

The user's location, such as office number.
public location ( ) : string
return string

lockoutTime() public method

The date and time (UTC) that this account was locked out. This value is stored as a large integer that represents the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of zero means that the account is not currently locked out.
public lockoutTime ( ) : string
return string

manager() public method

The manager's user object contains a directReports property that contains references to all user objects that have their manager properties set to this distinguished name.
public manager ( ) : string
return string

maxPasswordAge() public method

This value is stored as a large integer that represents the number of 100-nanosecond intervals from the time the password was set before the password expires.
public maxPasswordAge ( ) : string
return string

member() public method

The list of users that belong to the group.
public member ( ) : string
return string

memberOf() public method

The distinguished name of the groups to which this object belongs.
public memberOf ( ) : string
return string

memberRange() public method

The range limited list of users that belong to the group. See range limit in Active Directory (Range Retrieval of Attribute Values https://msdn.microsoft.com/en-us/library/cc223242.aspx) Issue #342
public memberRange ( string | integer $from, string | integer $to ) : string
$from string | integer
$to string | integer
return string

messageTrackingEnabled() public method

public messageTrackingEnabled ( ) : string
return string

msExchangeServer() public method

The object category of an exchange server.
public msExchangeServer ( ) : string
return string

name() public method

The general name of the entry.
public name ( ) : string
return string

neverExpiresDate() public method

Returns a string value indicating that an account does not expire.
public neverExpiresDate ( ) : string
return string

objectCategory() public method

An object class name used to group objects of this or derived classes.
public objectCategory ( ) : string
return string

objectCategoryComputer() public method

The computer object category.
public objectCategoryComputer ( ) : string
return string

objectCategoryContainer() public method

The container object category.
public objectCategoryContainer ( ) : string
return string

objectCategoryExchangePrivateMdb() public method

The exchange private MDB category.

objectCategoryExchangeServer() public method

The exchange server object category.

objectCategoryExchangeStorageGroup() public method

The exchange storage group object category.

objectCategoryGroup() public method

The group object category.
public objectCategoryGroup ( ) : string
return string

objectCategoryOrganizationalUnit() public method

The organizational unit category.

objectCategoryPerson() public method

The person object category.
public objectCategoryPerson ( ) : string
return string

objectCategoryPrinter() public method

The printer object category.
public objectCategoryPrinter ( ) : string
return string

objectClass() public method

The list of classes from which this class is derived.
public objectClass ( ) : string
return string

objectClassComputer() public method

The computer object class.
public objectClassComputer ( ) : string
return string

objectClassContact() public method

The contact object class.
public objectClassContact ( ) : string
return string

objectClassContainer() public method

The container object class.
public objectClassContainer ( ) : string
return string

objectClassGroup() public method

The group object class.
public objectClassGroup ( ) : string
return string

objectClassOu() public method

The ou object class.
public objectClassOu ( ) : string
return string

objectClassPerson() public method

Represents people who are associated with an organization in some way.
public objectClassPerson ( ) : string
return string

objectClassPrinter() public method

The printer object class.
public objectClassPrinter ( ) : string
return string

objectClassUser() public method

The user object class.
public objectClassUser ( ) : string
return string

objectGuid() public method

The unique identifier for an object.
public objectGuid ( ) : string
return string

objectSid() public method

The SID is a unique value used to identify the user as a security principal.
public objectSid ( ) : string
return string

operatingSystem() public method

The Operating System name, for example, Windows Vista Enterprise.
public operatingSystem ( ) : string
return string

operatingSystemServicePack() public method

The operating system service pack ID string (for example, SP3).

operatingSystemVersion() public method

The operating system version string, for example, 4.0.
public operatingSystemVersion ( ) : string
return string

organizationName() public method

The RDN version of organization name for use in distinguished names.
public organizationName ( ) : mixed
return mixed

organizationalPerson() public method

This class is used for objects that contain organizational information about a user, such as the employee number, department, manager, title, office address, and so on.
public organizationalPerson ( ) : string
return string

organizationalUnit() public method

A container for storing users, computers, and other account objects.
public organizationalUnit ( ) : string
return string

organizationalUnitShort() public method

The RDN version of organizational unit for use in distinguished names.
public organizationalUnitShort ( ) : string
return string

otherMailbox() public method

Contains other additional mail addresses in a form such as CCMAIL: JohnDoe.
public otherMailbox ( ) : string
return string

passwordLastSet() public method

This value is stored as a large integer that represents the number of 100 nanosecond intervals since January 1, 1601 (UTC). If this value is set to 0 and the User-Account-Control attribute does not contain the UF_DONT_EXPIRE_PASSWD flag, then the user must set the password at the next logon.
public passwordLastSet ( ) : string
return string

person() public method

The person object class.
public person ( ) : string
return string

personalTitle() public method

The user's title.
public personalTitle ( ) : string
return string

physicalDeliveryOfficeName() public method

Contains the office location in the user's place of business.

portName() public method

List of port names. For example, for printer ports or comm ports.
public portName ( ) : string
return string

postalCode() public method

The postal or zip code for mail delivery.
public postalCode ( ) : string
return string

primaryGroupId() public method

By default, this is the RID for the Domain Users group.
public primaryGroupId ( ) : string
return string

printerBinNames() public method

A list of printer bin names.
public printerBinNames ( ) : string
return string

printerColorSupported() public method

If a printer can print in color.
public printerColorSupported ( ) : string
return string

printerDuplexSupported() public method

Indicates the type of duplex support a printer has.
public printerDuplexSupported ( ) : string
return string

printerEndTime() public method

The time a print queue stops servicing jobs.
public printerEndTime ( ) : string
return string

printerMaxResolutionSupported() public method

The maximum printer resolution.

printerMediaSupported() public method

A list of media supported by a printer.
public printerMediaSupported ( ) : string
return string

printerMemory() public method

The amount of memory installed in a printer.
public printerMemory ( ) : string
return string

printerName() public method

The display name of an attached printer.
public printerName ( ) : string
return string

printerOrientationSupported() public method

The page rotation for landscape printing.

printerPrintRate() public method

Driver-supplied print rate.
public printerPrintRate ( ) : string
return string

printerPrintRateUnit() public method

Driver-supplied print rate unit.
public printerPrintRateUnit ( ) : string
return string

printerShareName() public method

The printer's share name.
public printerShareName ( ) : string
return string

printerStaplingSupported() public method

If the printer supports stapling. Supplied by the driver.
public printerStaplingSupported ( ) : string
return string

printerStartTime() public method

The time a print queue begins servicing jobs.
public printerStartTime ( ) : string
return string

priority() public method

The current priority (of a process, print job, and so on).
public priority ( ) : string
return string

profilePath() public method

Specifies a path to the user's profile. This value can be a null string, a local absolute path, or a UNC path.
public profilePath ( ) : string
return string

proxyAddresses() public method

A proxy address is the address by which a Microsoft Exchange Server recipient object is recognized in a foreign mail system. Proxy addresses are required for all recipient objects, such as custom recipients and distribution lists.
public proxyAddresses ( ) : string
return string

roomNumber() public method

The room number of an object.
public roomNumber ( ) : string
return string

rootDomainNamingContext() public method

The DN of the root domain NC for this DC's forest.
public rootDomainNamingContext ( ) : mixed
return mixed

schemaNamingContext() public method

The attribute.
public schemaNamingContext ( ) : mixed
return mixed

scriptPath() public method

This attribute specifies the path for the user's logon script. The string can be null.
public scriptPath ( ) : string
return string

serialNumber() public method

Part of X.500 specification. Not used by Active Directory.
public serialNumber ( ) : string
return string

serverName() public method

The name of a server.
public serverName ( ) : string
return string

showInAddressBook() public method

It is usually maintained by the Exchange Recipient Update Service.
public showInAddressBook ( ) : string
return string

street() public method

The street address.
public street ( ) : string
return string

streetAddress() public method

The street address.
public streetAddress ( ) : string
return string

systemFlags() public method

An integer value that contains flags that define additional properties of the class.
public systemFlags ( ) : string
return string

telephone() public method

The primary telephone number.
public telephone ( ) : string
return string

thumbnail() public method

The users thumbnail photo path.
public thumbnail ( ) : string
return string

title() public method

Contains the user's job title.
public title ( ) : string
return string

top() public method

The top level class from which all classes are derived.
public top ( ) : string
return string

true() public method

The AD true bool in string form for conversion.
public true ( ) : string
return string

unicodePassword() public method

The password of the user in Windows NT one-way format (OWF). Windows 2000 uses the Windows NT OWF.
public unicodePassword ( ) : string
return string

updatedAt() public method

The date when this object was last changed.
public updatedAt ( ) : string
return string

url() public method

The entry's URL attribute.
public url ( ) : string
return string

user() public method

This class is used to store information about an employee or contractor who works for an organization.
public user ( ) : string
return string

userAccountControl() public method

Flags that control the behavior of the user account.
public userAccountControl ( ) : string
return string

userId() public method

The user ID attribute.
public userId ( ) : string
return string

userPrincipalName() public method

This attribute contains the UPN that is an Internet-style login name for a user based on the Internet standard RFC 822.
public userPrincipalName ( ) : string
return string

versionNumber() public method

A general purpose version number.
public versionNumber ( ) : string
return string