FusionDirectory
Public Member Functions
SetAttribute Class Reference

This class allow to handle easily a multi-valuated attribute. More...

Inheritance diagram for SetAttribute:
Inheritance graph
[legend]

Public Member Functions

 __construct (\FusionDirectory\Core\SimplePlugin\Attribute $attribute, array $values=[], bool $valueUnicity=TRUE)
 The constructor of SetAttribute. More...
 
 setParent (&$plugin)
 Set the parent plugin for this attribute. More...
 
- Public Member Functions inherited from Attribute
 __construct (string $label, string $description, string $ldapName, bool $required=FALSE, $defaultValue='', string $acl='')
 The constructor of Attribute. More...
 
 setParent (&$plugin)
 Set the parent plugin for this attribute. More...
 
 getParent ()
 Get parent plugin instance, if any. More...
 
 getExample ()
 Get an example value. 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 (array $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 (array $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 (array &$attrs)
 Fill LDAP value in the attrs array.
 
 fillLdapValueHook (array &$attrs)
 Post-modify the attrs array if needed (used for erasing managed attributes)
 
 check ()
 Check the correctness of this attribute.
 
 renderAttribute (array &$attributes, bool $readOnly, bool $readable, bool $writable)
 Render this attribute form input(s) More...
 
 serializeAttribute (array &$attributes, bool $form=TRUE)
 Serialize this attribute for RPC requests. More...
 
 deserializeValue ($value)
 Apply value from RPC requests. More...
 
 serializeValue ($value=NULL)
 Serialize value for RPC requests. More...
 
 renderAcl (string $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 (array $attrs)
 Loads this attribute value from the attrs array if present. More...
 

Detailed Description

This class allow to handle easily a multi-valuated attribute.

Definition at line 24 of file class_SetAttribute.inc.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \FusionDirectory\Core\SimplePlugin\Attribute  $attribute,
array  $values = [],
bool  $valueUnicity = TRUE 
)

The constructor of SetAttribute.

Parameters
Attribute$attributeThe attribute you want to see multi-valuated
array$valuesThe default values
boolean$valueUnicityShould the value unicity be checked

Definition at line 38 of file class_SetAttribute.inc.

References SimplePluginCheckError\invalidValue(), and Attribute\renderAcl().

Referenced by MailsAttribute\__construct().

Member Function Documentation

◆ setParent()

setParent ( $plugin)

Set the parent plugin for this attribute.

Parameters
simplePlugin&$pluginThe parent plugin

Definition at line 352 of file class_SetAttribute.inc.


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