Ldap/Node/Schema.php

Show: PublicProtectedPrivateinherited
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_Ldap  
Subpackage
Schema  
Version
$Id: Schema.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Ldap_Node_Schema

Package: Zend\Ldap\Schema
Zend_Ldap_Node_Schema provides a simple data-container for the Schema node.
Parent(s)
\Zend_Ldap_Node_Abstract
Children
\Zend_Ldap_Node_Schema_ActiveDirectory
\Zend_Ldap_Node_Schema_OpenLdap
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  OBJECTCLASS_TYPE_UNKNOWN = 0
>VConstant  OBJECTCLASS_TYPE_STRUCTURAL = 1
>VConstant  OBJECTCLASS_TYPE_ABSTRACT = 3
>VConstant  OBJECTCLASS_TYPE_AUXILIARY = 4

Properties

>VPropertyprotectedarray $_currentData
inherited
Holds the node's current data.
Inherited from: \Zend_Ldap_Node_Abstract::$$_currentData
Details
Type
array
Inherited_from
\Zend_Ldap_Node_Abstract::$$_currentData  
>VPropertyprotected\Zend_Ldap_Dn $_dn
inherited
Holds the node's DN.
Inherited from: \Zend_Ldap_Node_Abstract::$$_dn
>VPropertyprotected$_systemAttributes = array('createtimestamp', 'creatorsname', 'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname', 'modifytimestamp', 'structuralobjectclass', 'subschemasubentry', 'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid', 'usnchanged', 'usncreated', 'whenchanged', 'whencreated')
staticinheritedInherited from: \Zend_Ldap_Node_Abstract::$$_systemAttributes
Default valuearray('createtimestamp', 'creatorsname', 'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname', 'modifytimestamp', 'structuralobjectclass', 'subschemasubentry', 'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid', 'usnchanged', 'usncreated', 'whenchanged', 'whencreated')Details
Type
n/a
Inherited_from
\Zend_Ldap_Node_Abstract::$$_systemAttributes  

Methods

methodprotected__construct(\Zend_Ldap_Dn $dn, array $data, \Zend_Ldap $ldap) : void

Constructor.

Constructor is protected to enforce the use of factory methods.

Parameters
NameTypeDescription
$dn\Zend_Ldap_Dn
$dataarray
$ldap\Zend_Ldap
methodpublic__get(string $name) : array
inherited

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__get()

This is an offline method.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublic__isset(string $name) : boolean
inherited

Checks whether a given attribute exists.

Inherited from: \Zend_Ldap_Node_Abstract::__isset()

Empty attributes will be treated as non-existent.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublic__set(string $name, mixed $value) : null
inherited

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__set()

This is an offline method.

Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
null
Throws
ExceptionDescription
\BadMethodCallException
methodpublic__toString() : string
inherited

Cast to string representation {@see toString()}

Inherited from: \Zend_Ldap_Node_Abstract::__toString()
Returns
TypeDescription
string
methodpublic__unset(string $name) : null
inherited

Deletes a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__unset()

This method deletes the attribute.

This is an offline method.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
null
Throws
ExceptionDescription
\BadMethodCallException
methodprotected_getDn() : \Zend_Ldap_Dn
inherited

Gets the DN of the current node as a Zend_Ldap_Dn.

Inherited from: \Zend_Ldap_Node_Abstract::_getDn()

This is an offline method.

Returns
TypeDescription
\Zend_Ldap_Dn
methodprotected_loadData(array $data, boolean $fromDataSource) : void
inherited

Inherited from: \Zend_Ldap_Node_Abstract::_loadData()
Parameters
NameTypeDescription
$dataarray
$fromDataSourceboolean
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodprotected_parseSchema(\Zend_Ldap_Dn $dn, \Zend_Ldap $ldap) : \Zend_Ldap_Node_Schema

Parses the schema

Parameters
NameTypeDescription
$dn\Zend_Ldap_Dn
$ldap\Zend_Ldap
Returns
TypeDescription
\Zend_Ldap_Node_SchemaProvides a fluid interface
methodpublicattributeHasValue(string $attribName, mixed | array $value) : boolean
inherited

Checks if the given value(s) exist in the attribute

Inherited from: \Zend_Ldap_Node_Abstract::attributeHasValue()
Parameters
NameTypeDescription
$attribNamestring
$valuemixed | array
Returns
TypeDescription
boolean
methodpubliccount() : int
inherited

Returns the number of attributes in node.

Inherited from: \Zend_Ldap_Node_Abstract::count()

Implements Countable

Returns
TypeDescription
int
methodpubliccreate(\Zend_Ldap $ldap) : \Zend_Ldap_Node_Schema
static

Factory method to create the Schema node.

Parameters
NameTypeDescription
$ldap\Zend_Ldap
Returns
TypeDescription
\Zend_Ldap_Node_Schema
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublicexistsAttribute(string $name, boolean $emptyExists = false) : boolean
inherited

Checks whether a given attribute exists.

Inherited from: \Zend_Ldap_Node_Abstract::existsAttribute()

If $emptyExists is false empty attributes (containing only array()) are treated as non-existent returning false. If $emptyExists is true empty attributes are treated as existent returning true. In this case method returns false only if the attribute name is missing in the key-collection.

Parameters
NameTypeDescription
$namestring
$emptyExistsboolean
Returns
TypeDescription
boolean
methodpublicgetAttribute(string $name, integer $index = null) : mixed
inherited

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::getAttribute()

This is an offline method.

Parameters
NameTypeDescription
$namestring
$indexinteger
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublicgetAttributeTypes() : array

Gets the attribute Types

Returns
TypeDescription
array
methodpublicgetAttributes(boolean $includeSystemAttributes = true) : array
inherited

Gets all attributes of node.

Inherited from: \Zend_Ldap_Node_Abstract::getAttributes()

The collection contains all attributes.

This is an offline method.

Parameters
NameTypeDescription
$includeSystemAttributesboolean
Returns
TypeDescription
array
methodpublicgetData(boolean $includeSystemAttributes = true) : array
inherited

Gets node attributes.

Inherited from: \Zend_Ldap_Node_Abstract::getData()

The array contains all attributes in its internal format (no conversion).

This is an offline method.

Parameters
NameTypeDescription
$includeSystemAttributesboolean
Returns
TypeDescription
array
methodpublicgetDateTimeAttribute(string $name, integer $index = null) : array | integer
inherited

Gets a LDAP date/time attribute.

Inherited from: \Zend_Ldap_Node_Abstract::getDateTimeAttribute()

This is an offline method.

Parameters
NameTypeDescription
$namestring
$indexinteger
Returns
TypeDescription
array | integer
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublicgetDn() : \Zend_Ldap_Dn
inherited

Gets the DN of the current node as a Zend_Ldap_Dn.

Inherited from: \Zend_Ldap_Node_Abstract::getDn()

The method returns a clone of the node's DN to prohibit modification.

This is an offline method.

Returns
TypeDescription
\Zend_Ldap_Dn
methodpublicgetDnArray(string $caseFold = null) : array
inherited

Gets the DN of the current node as an array.

Inherited from: \Zend_Ldap_Node_Abstract::getDnArray()

This is an offline method.

Parameters
NameTypeDescription
$caseFoldstring
Returns
TypeDescription
array
methodpublicgetDnString(string $caseFold = null) : string
inherited

Gets the DN of the current node as a string.

Inherited from: \Zend_Ldap_Node_Abstract::getDnString()

This is an offline method.

Parameters
NameTypeDescription
$caseFoldstring
Returns
TypeDescription
string
methodpublicgetObjectClass() : array
inherited

Gets the objectClass of the node

Inherited from: \Zend_Ldap_Node_Abstract::getObjectClass()
Returns
TypeDescription
array
methodpublicgetObjectClasses() : array

Gets the object classes

Returns
TypeDescription
array
methodpublicgetRdnArray(string $caseFold = null) : array
inherited

Gets the RDN of the current node as an array.

Inherited from: \Zend_Ldap_Node_Abstract::getRdnArray()

This is an offline method.

Parameters
NameTypeDescription
$caseFoldstring
Returns
TypeDescription
array
methodpublicgetRdnString(string $caseFold = null) : string
inherited

Gets the RDN of the current node as a string.

Inherited from: \Zend_Ldap_Node_Abstract::getRdnString()

This is an offline method.

Parameters
NameTypeDescription
$caseFoldstring
Returns
TypeDescription
string
methodpublicoffsetExists(string $name) : boolean
inherited

Checks whether a given attribute exists.

Inherited from: \Zend_Ldap_Node_Abstract::offsetExists()

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
boolean
methodpublicoffsetGet(string $name) : array
inherited

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetGet()

Implements ArrayAccess.

This is an offline method.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublicoffsetSet(string $name, mixed $value) : null
inherited

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetSet()

Implements ArrayAccess.

This is an offline method.

Parameters
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
null
Throws
ExceptionDescription
\BadMethodCallException
methodpublicoffsetUnset(string $name) : null
inherited

Deletes a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetUnset()

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
null
Throws
ExceptionDescription
\BadMethodCallException
methodpublicreload(\Zend_Ldap $ldap = null) : \Zend_Ldap_Node_Abstract
inherited

Reload node attributes from LDAP.

Inherited from: \Zend_Ldap_Node_Abstract::reload()

This is an online method.

Parameters
NameTypeDescription
$ldap\Zend_Ldap
Returns
TypeDescription
\Zend_Ldap_Node_AbstractProvides a fluid interface
Throws
ExceptionDescription
\Zend_Ldap_Exception
methodpublictoArray(boolean $includeSystemAttributes = true) : array
inherited

Returns an array representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toArray()
Parameters
NameTypeDescription
$includeSystemAttributesboolean
Returns
TypeDescription
array
methodpublictoJson(boolean $includeSystemAttributes = true) : string
inherited

Returns a JSON representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toJson()
Parameters
NameTypeDescription
$includeSystemAttributesboolean
Returns
TypeDescription
string
methodpublictoString() : string
inherited

Returns the DN of the current node.

Inherited from: \Zend_Ldap_Node_Abstract::toString()

{@see getDnString()}

Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.0.0a12.