HumHub Documentation (unofficial)

AbstractNode
in package
implements ArrayAccess, Countable

AbstractYes

This class provides a base implementation for LDAP nodes

Tags
template-implements

ArrayAccess<string, mixed>

Table of Contents

Interfaces

ArrayAccess
Countable

Properties

$currentData  : array<string|int, mixed>
Holds the node's current data.
$dn  : Dn
Holds the node's DN.
$systemAttributes  : array<int, non-empty-string>

Methods

__get()  : mixed
Gets a LDAP attribute.
__isset()  : bool
Checks whether a given attribute exists.
__set()  : mixed
Sets a LDAP attribute.
__toString()  : string
Cast to string representation {@see toString()}
__unset()  : mixed
Deletes a LDAP attribute.
attributeHasValue()  : bool
Checks if the given value(s) exist in the attribute
count()  : mixed
existsAttribute()  : bool
Checks whether a given attribute exists.
getAttribute()  : mixed
Gets a LDAP attribute.
getAttributes()  : array<string|int, mixed>
Gets all attributes of node.
getData()  : array<string|int, mixed>
Gets node attributes.
getDateTimeAttribute()  : array<string|int, mixed>|int
Gets a LDAP date/time attribute.
getDn()  : Dn
Gets the DN of the current node as a Laminas\Ldap\Dn.
getDnArray()  : array<string|int, mixed>
Gets the DN of the current node as an array.
getDnString()  : string
Gets the DN of the current node as a string.
getObjectClass()  : array<string|int, mixed>
Gets the objectClass of the node
getRdnArray()  : array<string|int, mixed>
Gets the RDN of the current node as an array.
getRdnString()  : string
Gets the RDN of the current node as a string.
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
reload()  : AbstractNode
Reload node attributes from LDAP.
toArray()  : array<string|int, mixed>
Returns an array representation of the current node
toJson()  : string
Returns a JSON representation of the current node
toString()  : string
Returns the DN of the current node. {@see getDnString()}
__construct()  : mixed
Constructor is protected to enforce the use of factory methods.
_getDn()  : Dn
Gets the DN of the current node as a Laminas\Ldap\Dn.
loadData()  : mixed

Properties

$currentData

Holds the node's current data.

protected array<string|int, mixed> $currentData

$systemAttributes

protected static array<int, non-empty-string> $systemAttributes = ['createtimestamp', 'creatorsname', 'entrycsn', 'entrydn', 'entryuuid', 'hassubordinates', 'modifiersname', 'modifytimestamp', 'structuralobjectclass', 'subschemasubentry', 'distinguishedname', 'instancetype', 'name', 'objectcategory', 'objectguid', 'usnchanged', 'usncreated', 'whenchanged', 'whencreated']

Methods

__get()

Gets a LDAP attribute.

public __get(string $name) : mixed

This is an offline method.

Parameters
$name : string
Tags
throws
LdapException

__isset()

Checks whether a given attribute exists.

public __isset(string $name) : bool

Empty attributes will be treated as non-existent.

Parameters
$name : string
Return values
bool

__set()

Sets a LDAP attribute.

public __set(string $name, mixed $value) : mixed

This is an offline method.

Parameters
$name : string
$value : mixed
Tags
throws
BadMethodCallException

__toString()

Cast to string representation {@see toString()}

public __toString() : string
Return values
string

__unset()

Deletes a LDAP attribute.

public __unset(string $name) : mixed

This method deletes the attribute.

This is an offline method.

Parameters
$name : string
Tags
throws
BadMethodCallException

attributeHasValue()

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

public attributeHasValue(string $attribName, mixed|array<string|int, mixed> $value) : bool
Parameters
$attribName : string
$value : mixed|array<string|int, mixed>
Return values
bool

existsAttribute()

Checks whether a given attribute exists.

public existsAttribute(string $name[, bool $emptyExists = false ]) : bool

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 : string
$emptyExists : bool = false
Return values
bool

getAttribute()

Gets a LDAP attribute.

public getAttribute(string $name[, int $index = null ]) : mixed

This is an offline method.

Parameters
$name : string
$index : int = null
Tags
throws
LdapException

getAttributes()

Gets all attributes of node.

public getAttributes([bool $includeSystemAttributes = true ]) : array<string|int, mixed>

The collection contains all attributes.

This is an offline method.

Parameters
$includeSystemAttributes : bool = true
Return values
array<string|int, mixed>

getData()

Gets node attributes.

public getData([bool $includeSystemAttributes = true ]) : array<string|int, mixed>

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

This is an offline method.

Parameters
$includeSystemAttributes : bool = true
Return values
array<string|int, mixed>

getDateTimeAttribute()

Gets a LDAP date/time attribute.

public getDateTimeAttribute(string $name[, int $index = null ]) : array<string|int, mixed>|int

This is an offline method.

Parameters
$name : string
$index : int = null
Tags
throws
LdapException
Return values
array<string|int, mixed>|int

getDn()

Gets the DN of the current node as a Laminas\Ldap\Dn.

public getDn() : Dn

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

This is an offline method.

Return values
Dn

getDnArray()

Gets the DN of the current node as an array.

public getDnArray([string $caseFold = null ]) : array<string|int, mixed>

This is an offline method.

Parameters
$caseFold : string = null
Return values
array<string|int, mixed>

getDnString()

Gets the DN of the current node as a string.

public getDnString([string $caseFold = null ]) : string

This is an offline method.

Parameters
$caseFold : string = null
Return values
string

getObjectClass()

Gets the objectClass of the node

public getObjectClass() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRdnArray()

Gets the RDN of the current node as an array.

public getRdnArray([string $caseFold = null ]) : array<string|int, mixed>

This is an offline method.

Parameters
$caseFold : string = null
Return values
array<string|int, mixed>

getRdnString()

Gets the RDN of the current node as a string.

public getRdnString([string $caseFold = null ]) : string

This is an offline method.

Parameters
$caseFold : string = null
Return values
string

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Tags
inheritDoc

Checks whether a given attribute exists.

Empty attributes will be treated as non-existent.

Attributes
#[ReturnTypeWillChange]

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Tags
inheritDoc

Deletes a LDAP attribute.

This method deletes the attribute.

This is an offline method.

psalm-return

never

throws
BadMethodCallException
Attributes
#[ReturnTypeWillChange]

reload()

Reload node attributes from LDAP.

public reload([Ldap|null $ldap = null ]) : AbstractNode

This is an online method.

Parameters
$ldap : Ldap|null = null
Return values
AbstractNode —

Provides a fluid interface

toArray()

Returns an array representation of the current node

public toArray([bool $includeSystemAttributes = true ]) : array<string|int, mixed>
Parameters
$includeSystemAttributes : bool = true
Return values
array<string|int, mixed>

toJson()

Returns a JSON representation of the current node

public toJson([bool $includeSystemAttributes = true ]) : string
Parameters
$includeSystemAttributes : bool = true
Return values
string

toString()

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

public toString() : string
Return values
string

__construct()

Constructor is protected to enforce the use of factory methods.

protected __construct(Dn $dn, array<string|int, mixed> $data, bool $fromDataSource) : mixed
Parameters
$dn : Dn
$data : array<string|int, mixed>
$fromDataSource : bool

_getDn()

Gets the DN of the current node as a Laminas\Ldap\Dn.

protected _getDn() : Dn

This is an offline method.

Return values
Dn

loadData()

protected loadData(array<string|int, mixed> $data, bool $fromDataSource) : mixed
Parameters
$data : array<string|int, mixed>
$fromDataSource : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results