FusionDirectory
 All Data Structures Files Functions Variables
Public Member Functions | Protected Member Functions
Attribute Class Reference

This class allow to handle easily any kind of LDAP attribute. More...

Inheritance diagram for Attribute:
Inheritance graph
[legend]

Public Member Functions

 __construct ($label, $description, $ldapName, $required=FALSE, $defaultValue="", $acl="")
 The constructor of Attribute. More...
 
 setParent (&$plugin)
 Set the parent plugin for this attribute. More...
 
 setPostValue ($value)
 Set the postValue.
 
 fixPostValue ($value)
 In case a treatment is needed on POST content.
 
 resetToDefault ()
 Reset this attribute to its default value.
 
 loadValue ($attrs)
 If in LDAP, loads this attribute value from the attrs array.
 
 inputValue ($ldapValue)
 Return the ldap value in the correct intern format value. More...
 
 setManagedAttributes ($mAttributes)
 Set a list of attributes that are managed by this attributes. See FusionDirectory wiki for detailed documentation.
 
 loadPostValue ()
 Update this attributes postValue depending of the $_POST values.
 
 applyPostValue ()
 Apply this attribute postValue in value if this attribute is enabled.
 
 computeLdapValue ()
 Computes LDAP value.
 
 fillLdapValue (&$attrs)
 Fill LDAP value in the attrs array.
 
 fillLdapValueHook (&$attrs)
 Post-modify the attrs array if needed (used for erasing managed attributes)
 
 check ()
 Check the correctness of this attribute.
 
 renderAttribute (&$attributes, $readOnly)
 Render this attribute form input(s) More...
 
 serializeAttribute (&$attributes, $form=TRUE)
 Serialize this attribute for RPC requests. More...
 
 deserializeValue ($values)
 Apply value from RPC requests. More...
 
 renderAcl ($display)
 Add ACL information around display. More...
 
 getAclInfo ()
 Get ACL information about the ACL we need to create.
 

Protected Member Functions

 loadAttrValue ($attrs)
 Loads this attribute value from the attrs array.
 

Detailed Description

This class allow to handle easily any kind of LDAP attribute.

Definition at line 29 of file class_Attribute.inc.

Constructor & Destructor Documentation

__construct (   $label,
  $description,
  $ldapName,
  $required = FALSE,
  $defaultValue = "",
  $acl = "" 
)

The constructor of Attribute.

Parameters
string$labelThe label to show for this attribute
string$descriptionA more detailed description for the attribute
string$ldapNameThe name of the attribute in the LDAP (If it's not in the ldap, still provide a unique name)
boolean$requiredIs this attribute mandatory or not
mixeddefaultValue The default value for this attribute
stringacl The name of the acl for this attribute if he does not use its own. (Leave empty if he should use its own like most attributes do)

Definition at line 94 of file class_Attribute.inc.

Referenced by DialogAttribute\__construct().

Member Function Documentation

deserializeValue (   $values)

Apply value from RPC requests.

Parameters
arrayvalues the values array

Definition at line 621 of file class_Attribute.inc.

inputValue (   $ldapValue)

Return the ldap value in the correct intern format value.

Parameters
$ldapValueThe value as found in the LDAP

Definition at line 331 of file class_Attribute.inc.

Referenced by loadAttrValue().

renderAcl (   $display)

Add ACL information around display.

Parameters
string$displaythe display information to pass through ACL

Definition at line 632 of file class_Attribute.inc.

renderAttribute ( $attributes,
  $readOnly 
)

Render this attribute form input(s)

Parameters
array&attributes the attributes array
boolreadOnly should we show text or input

Definition at line 565 of file class_Attribute.inc.

serializeAttribute ( $attributes,
  $form = TRUE 
)

Serialize this attribute for RPC requests.

Parameters
array&attributes the attributes array

Definition at line 588 of file class_Attribute.inc.

setParent ( $plugin)

Set the parent plugin for this attribute.

Parameters
simplePlugin&$pluginThe parent plugin

Definition at line 111 of file class_Attribute.inc.


The documentation for this class was generated from the following file: