API Documentation

Ldap/Node/Schema/OpenLdap.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
Schema  
version
$Id: OpenLdap.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Ldap_Node_Schema_OpenLdap

Zend_Ldap_Node_Schema_OpenLdap provides a simple data-container for the Schema node of an OpenLDAP server.

Extends from
\Zend_Ldap_Node_Schema
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Ldap  
subpackage
Schema  

Properties

Propertyprotectedarray  $_attributeTypes= 'null'

The attribute Types

Default valuenullDetails
Type
array
Propertyprotectedarray  $_ldapSyntaxes= 'null'

The LDAP syntaxes

Default valuenullDetails
Type
array
Propertyprotectedarray  $_matchingRuleUse= 'null'

The matching rule use

Default valuenullDetails
Type
array
Propertyprotectedarray  $_matchingRules= 'null'

The matching rules

Default valuenullDetails
Type
array
Propertyprotectedarray  $_objectClasses= 'null'

The object classes

Default valuenullDetails
Type
array

Methods

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

Constructor.

Inherited from: \Zend_Ldap_Node_Schema::__construct()

Constructor is protected to enforce the use of factory methods.

Parameters
Name Type Description
$dn \Zend_Ldap_Dn
$data array
$ldap \Zend_Ldap
methodpublic__get( string $name ) : array

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__get()

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
array
Throws
Exception Description
\Zend_Ldap_Exception
methodpublic__isset( string $name ) : boolean

Checks whether a given attribute exists.

Inherited from: \Zend_Ldap_Node_Abstract::__isset()

Empty attributes will be treated as non-existent.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublic__set( string $name, mixed $value ) : null

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__set()

This is an offline method.

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublic__toString( ) : string

Cast to string representation {@see toString()}

Inherited from: \Zend_Ldap_Node_Abstract::__toString()
Returns
Type Description
string
methodpublic__unset( string $name ) : null

Deletes a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::__unset()

This method deletes the attribute.

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodprotected_ensureNameAttribute( array $data ) : void

Ensures that a name element is present and that it is single-values.

Parameters
Name Type Description
$data array
methodprotected_getDn( ) : \Zend_Ldap_Dn

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
Type Description
\Zend_Ldap_Dn
methodprotected_loadAttributeTypes( ) : void

Loads the attribute Types

methodprotected_loadData( array $data, boolean $fromDataSource ) : void
Parameters
Name Type Description
$data array
$fromDataSource boolean
Throws
Exception Description
\Zend_Ldap_Exception
methodprotected_loadLdapSyntaxes( ) : void

Loads the LDAP syntaxes

methodprotected_loadMatchingRuleUse( ) : void

Loads the matching rule use

methodprotected_loadMatchingRules( ) : void

Loads the matching rules

methodprotected_loadObjectClasses( ) : void

Loads the object classes

methodprotected_parseAttributeType( string $value ) : array

Parses an attributeType value

Parameters
Name Type Description
$value string
Returns
Type Description
array
methodprotected_parseLdapSchemaSyntax( array $data, array $tokens ) : void

Parse the given tokens into a data structure

Parameters
Name Type Description
$data array
$tokens array
methodprotected_parseLdapSyntax( string $value ) : array

Parses an ldapSyntaxes value

Parameters
Name Type Description
$value string
Returns
Type Description
array
methodprotected_parseMatchingRule( string $value ) : array

Parses an matchingRules value

Parameters
Name Type Description
$value string
Returns
Type Description
array
methodprotected_parseMatchingRuleUse( string $value ) : array

Parses an matchingRuleUse value

Parameters
Name Type Description
$value string
Returns
Type Description
array
methodprotected_parseObjectClass( string $value ) : array

Parses an objectClasses value

Parameters
Name Type Description
$value string
Returns
Type Description
array
methodprotected_parseSchema( \Zend_Ldap_Dn $dn, \Zend_Ldap $ldap ) : \Zend_Ldap_Node_Schema

Parses the schema

Parameters
Name Type Description
$dn \Zend_Ldap_Dn
$ldap \Zend_Ldap
Returns
Type Description
\Zend_Ldap_Node_Schema Provides a fluid interface
methodprotected_resolveInheritance( \Zend_Ldap_Node_Schema_Item $node, array $repository ) : void

Resolves inheritance in objectClasses and attributes

Parameters
Name Type Description
$node \Zend_Ldap_Node_Schema_Item
$repository array
methodprotected_tokenizeString( string $value ) : array

Tokenizes the given value into an array

Parameters
Name Type Description
$value string
Returns
Type Description
array tokens
methodpublicattributeHasValue( string $attribName, mixed|array $value ) : boolean

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

Inherited from: \Zend_Ldap_Node_Abstract::attributeHasValue()
Parameters
Name Type Description
$attribName string
$value mixed|array
Returns
Type Description
boolean
methodpubliccount( ) : int

Returns the number of attributes in node.

Inherited from: \Zend_Ldap_Node_Abstract::count()

Implements Countable

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

Factory method to create the Schema node.

Inherited from: \Zend_Ldap_Node_Schema::create()
Parameters
Name Type Description
$ldap \Zend_Ldap
Returns
Type Description
\Zend_Ldap_Node_Schema
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicexistsAttribute( string $name, boolean $emptyExists = false ) : boolean

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
Name Type Description
$name string
$emptyExists boolean
Returns
Type Description
boolean
methodpublicgetAttribute( string $name, integer $index = null ) : mixed

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::getAttribute()

This is an offline method.

Parameters
Name Type Description
$name string
$index integer
Returns
Type Description
mixed
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetAttributeTypes( ) : array

Gets the attribute Types

Returns
Type Description
array
methodpublicgetAttributes( boolean $includeSystemAttributes = true ) : array

Gets all attributes of node.

Inherited from: \Zend_Ldap_Node_Abstract::getAttributes()

The collection contains all attributes.

This is an offline method.

Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublicgetData( boolean $includeSystemAttributes = true ) : array

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
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublicgetDateTimeAttribute( string $name, integer $index = null ) : array|integer

Gets a LDAP date/time attribute.

Inherited from: \Zend_Ldap_Node_Abstract::getDateTimeAttribute()

This is an offline method.

Parameters
Name Type Description
$name string
$index integer
Returns
Type Description
arrayinteger
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicgetDn( ) : \Zend_Ldap_Dn

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
Type Description
\Zend_Ldap_Dn
methodpublicgetDnArray( string $caseFold = null ) : array

Gets the DN of the current node as an array.

Inherited from: \Zend_Ldap_Node_Abstract::getDnArray()

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
array
methodpublicgetDnString( string $caseFold = null ) : string

Gets the DN of the current node as a string.

Inherited from: \Zend_Ldap_Node_Abstract::getDnString()

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicgetLdapSyntaxes( ) : array

Gets the LDAP syntaxes

Returns
Type Description
array
methodpublicgetMatchingRuleUse( ) : array

Gets the matching rule use

Returns
Type Description
array
methodpublicgetMatchingRules( ) : array

Gets the matching rules

Returns
Type Description
array
methodpublicgetObjectClass( ) : array

Gets the objectClass of the node

Inherited from: \Zend_Ldap_Node_Abstract::getObjectClass()
Returns
Type Description
array
methodpublicgetObjectClasses( ) : array

Gets the object classes

Returns
Type Description
array
methodpublicgetRdnArray( string $caseFold = null ) : array

Gets the RDN of the current node as an array.

Inherited from: \Zend_Ldap_Node_Abstract::getRdnArray()

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
array
methodpublicgetRdnString( string $caseFold = null ) : string

Gets the RDN of the current node as a string.

Inherited from: \Zend_Ldap_Node_Abstract::getRdnString()

This is an offline method.

Parameters
Name Type Description
$caseFold string
Returns
Type Description
string
methodpublicoffsetExists( string $name ) : boolean

Checks whether a given attribute exists.

Inherited from: \Zend_Ldap_Node_Abstract::offsetExists()

Implements ArrayAccess.

Empty attributes will be treated as non-existent.

Parameters
Name Type Description
$name string
Returns
Type Description
boolean
methodpublicoffsetGet( string $name ) : array

Gets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetGet()

Implements ArrayAccess.

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
array
Throws
Exception Description
\Zend_Ldap_Exception
methodpublicoffsetSet( string $name, mixed $value ) : null

Sets a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetSet()

Implements ArrayAccess.

This is an offline method.

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublicoffsetUnset( string $name ) : null

Deletes a LDAP attribute.

Inherited from: \Zend_Ldap_Node_Abstract::offsetUnset()

Implements ArrayAccess.

This method deletes the attribute.

This is an offline method.

Parameters
Name Type Description
$name string
Returns
Type Description
null
Throws
Exception Description
\BadMethodCallException
methodpublicreload( \Zend_Ldap $ldap = null ) : \Zend_Ldap_Node_Abstract

Reload node attributes from LDAP.

Inherited from: \Zend_Ldap_Node_Abstract::reload()

This is an online method.

Parameters
Name Type Description
$ldap \Zend_Ldap
Returns
Type Description
\Zend_Ldap_Node_Abstract Provides a fluid interface
Throws
Exception Description
\Zend_Ldap_Exception
methodpublictoArray( boolean $includeSystemAttributes = true ) : array

Returns an array representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toArray()
Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
array
methodpublictoJson( boolean $includeSystemAttributes = true ) : string

Returns a JSON representation of the current node

Inherited from: \Zend_Ldap_Node_Abstract::toJson()
Parameters
Name Type Description
$includeSystemAttributes boolean
Returns
Type Description
string
methodpublictoString( ) : string

Returns the DN of the current node. {@see getDnString()}

Inherited from: \Zend_Ldap_Node_Abstract::toString()
Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.