FusionDirectory
 All Data Structures Files Functions Variables
Public Member Functions
SelectAttribute Class Reference

This class allow to handle easily a Select LDAP attribute with a set of choices. More...

Inheritance diagram for SelectAttribute:
Inheritance graph
[legend]

Public Member Functions

 __construct ($label, $description, $ldapName, $required=FALSE, $choices=array(), $defaultValue="", $outputs=NULL, $acl="")
 The constructor of SelectAttribute. More...
 
 setChoices ($choices, $outputs=NULL)
 Set the options of the select attribute. More...
 
 setDisplayChoices ($values)
 Set the display options of the select attribute. More...
 
 getChoices ()
 Get the choices.
 
 getDisplayChoices ()
 Get the displayed choices (keys are choices)
 
 setSize ($size)
 Set the size of the HTML input tag, useful to display several options on the screen instead of just one.
 
- Public Member Functions inherited from Attribute
 __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.
 

Additional Inherited Members

- Protected Member Functions inherited from Attribute
 loadAttrValue ($attrs)
 Loads this attribute value from the attrs array.
 

Detailed Description

This class allow to handle easily a Select LDAP attribute with a set of choices.

Definition at line 29 of file class_SelectAttribute.inc.

Constructor & Destructor Documentation

__construct (   $label,
  $description,
  $ldapName,
  $required = FALSE,
  $choices = array(),
  $defaultValue = "",
  $outputs = NULL,
  $acl = "" 
)

The constructor of SelectAttribute.

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
array$choicesThe choices this select should offer. Pass array("") if you're gonna fill it later with setChoices
mixed$defaultValueThe default value for this attribute
array$outputsThe labels corresponding to the choices, leave to NULL if you want to display the choices themselves
string$aclThe 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 46 of file class_SelectAttribute.inc.

References setChoices().

Member Function Documentation

setChoices (   $choices,
  $outputs = NULL 
)

Set the options of the select attribute.

Parameters
array$choicesThe choices this select should offer
array$outputsThe labels corresponding to the choices, leave to NULL if you want to display the choices themselves

Definition at line 60 of file class_SelectAttribute.inc.

References Attribute\resetToDefault(), and setDisplayChoices().

Referenced by __construct().

setDisplayChoices (   $values)

Set the display options of the select attribute.

Parameters
array$outputsThe labels corresponding to the choices, in the same order as the choices

Definition at line 85 of file class_SelectAttribute.inc.

Referenced by setChoices().


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