Zend\Ldap\Dn
Zend\Ldap\Dn provides an API for DN manipulation
Synopsis
class Dn
implements
ArrayAccess
{
- // constants
- const ATTR_CASEFOLD_NONE = 'none';
- const ATTR_CASEFOLD_UPPER = 'upper';
- const ATTR_CASEFOLD_LOWER = 'lower';
- // members
- protected string $defaultCaseFold;
- protected string $caseFold;
- protected array $dn;
- // methods
- public static Dn factory()
- public static Dn fromString()
- public static Dn fromArray()
- protected void __construct()
- public array getRdn()
- public string getRdnString()
- public Dn getParentDn()
- public array get()
- public Dn set()
- public Dn remove()
- public Dn append()
- public Dn prepend()
- public Dn insert()
- protected bool assertIndex()
- protected static bool assertRdn()
- public void setCaseFold()
- public string toString()
- public array toArray()
- protected static array caseFoldRdn()
- protected static array caseFoldDn()
- public string __toString()
- public bool offsetExists()
- public array offsetGet()
- public void offsetSet()
- public void offsetUnset()
- public static void setDefaultCaseFold()
- protected static string sanitizeCaseFold()
- public static array escapeValue()
- public static array unescapeValue()
- public static array explodeDn()
- public static bool checkDn()
- public static string implodeRdn()
- public static string implodeDn()
- public static bool isChildOf()
Hierarchy
Implements
Constants
Name | Value |
---|---|
ATTR_CASEFOLD_NONE | 'none' |
ATTR_CASEFOLD_UPPER | 'upper' |
ATTR_CASEFOLD_LOWER | 'lower' |
Members
protected
- $caseFold
—
string
The case fold used for this instance - $defaultCaseFold
—
string
The default case fold to use - $dn
—
array
The DN data
Methods
protected
- __construct() — Constructor
- assertIndex() — Assert index is correct and usable
- assertRdn() — Assert if value is in a correct RDN format
- caseFoldDn() — Do a case folding on a DN ort part of it
- caseFoldRdn() — Do a case folding on a RDN
- sanitizeCaseFold() — Sanitizes the case fold
public
- __toString() — Cast to string representation {@see toString()}
- append() — Append a DN part
- checkDn()
- escapeValue() — Escapes a DN value according to RFC 2253
- explodeDn() — Creates an array containing all parts of the given DN.
- factory() — Creates a DN from an array or a string
- fromArray() — Creates a DN from an array
- fromString() — Creates a DN from a string
- get() — Get a DN part
- getParentDn() — Get the parent DN $levelUp levels up the tree
- getRdn() — Gets the RDN of the current DN
- getRdnString() — Gets the RDN of the current DN as a string
- implodeDn() — Implodes an array in the form delivered by {@link explodeDn()} to a DN string.
- implodeRdn() — Returns a DN part in the form $attribute = $value
- insert() — Insert a DN part
- isChildOf() — Checks if given $childDn is beneath $parentDn subtree.
- offsetExists() — Required by the ArrayAccess implementation
- offsetGet() — Proxy to {@see get()} Required by the ArrayAccess implementation
- offsetSet() — Proxy to {@see set()} Required by the ArrayAccess implementation
- offsetUnset() — Proxy to {@see remove()} Required by the ArrayAccess implementation
- prepend() — Prepend a DN part
- remove() — Remove a DN part
- set() — Set a DN part
- setCaseFold() — Sets the case fold
- setDefaultCaseFold() — Sets the default case fold
- toArray() — Return DN as an array
- toString() — Return DN as a string
- unescapeValue() — Undoes the conversion done by {@link escapeValue()}.