DateAttribute Class Reference

This class allow to handle easily an Date LDAP attribute. More...

Inheritance diagram for DateAttribute:

Public Member Functions
	__construct (string $label, string $description, string $ldapName, bool $required, string $format, $defaultValue='today', $min=NULL, $max=NULL, string $acl='')
	The constructor of DateAttribute. 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 an Date LDAP attribute.

We are using UTC timezone because we don't care about time, we just want date.

Definition at line 26 of file class_DateAttribute.inc.

Constructor & Destructor Documentation

__construct()

__construct	(	string	$label,
		string	$description,
		string	$ldapName,
		bool	$required,
		string	$format,
			$defaultValue = 'today',
			$min = NULL,
			$max = NULL,
		string	$acl = ''
	)

The constructor of DateAttribute.

Parameters

string	$label	The label to show for this attribute
string	$description	A more detailed description for the attribute
string	$ldapName	The name of the attribute in the LDAP (If it's not in the ldap, still provide a unique name)
boolean	$required	Is this attribute mandatory or not
string	$format	The date format. It can be any format recognized by DateTime::format. see http://www.php.net/manual/fr/function.date.php
mixed	$defaultValue	The default value for this attribute
mixed	$min	Minimum valid value
mixed	$max	Maximum valid value
string	$acl	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 44 of file class_DateAttribute.inc.

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

---

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

• include/simpleplugin/attributes/class_DateAttribute.inc