templates/3rdParty/pla/lib/Attribute.php

Properties

Description

Classes and functions for the template engine.

Classes

Attribute

Properties

 
 
No 
No 

Description

Represents an attribute of a template.

Methods

__construct, addValue, autoValue, clearValue, delValue, getAddedValues, getAliases, getAutoValue, getDescription, getFriendlyName, getHelper, getHelperValue, getHint, getIcon, getLDAPtype, getMaxLength, getMaxValueCount, getMinValueCount, getName, getOldValue, getOldValues, getOnChange, getPage, getPostValue, getRemovedValues, getSize, getSource, getSpacer, getType, getValue, getValueCount, getValues, getVerify, hasBeenModified, haveFriendlyName, haveMoreValues, hide, initValue, isForceDelete, isInternal, isMay, isMultiple, isRDN, isReadOnly, isRequired, isVisible, justModified, needJS, real_attr_name, setDescription, setForceDelete, setHint, setIcon, setInternal, setLDAPdetails, setLDAPtype, setMaxLength, setMaxValueCount, setMinValueCount, setOldValue, setOptional, setPage, setPostValue, setProperties, setRDN, setReadOnly, setRequired, setSize, setType, setValue, setXML, show,

__construct(   $name,   $values,   $server_id,   $source = null, ) : n/a

Arguments

Name Type Description Default
$name n/a
$values n/a
$server_id n/a
$source n/a null

Return value

Type Description
n/a n/a

addValue(   $new_val,   $i = -1, ) : n/a

Arguments

Name Type Description Default
$new_val n/a
$i n/a -1

Return value

Type Description
n/a n/a

autoValue(   $new_val, ) : n/a

Description

Autovalue is called after the attribute is initialised, and thus the values from the ldap server will be set.

Arguments

Name Type Description Default
$new_val n/a

Return value

Type Description
n/a n/a

clearValue( ) : n/a

Return value

Type Description
n/a n/a

delValue(   $i = -1, ) : n/a

Arguments

Name Type Description Default
$i n/a -1

Return value

Type Description
n/a n/a

getAddedValues( ) : n/a

Description

Display the values removed in an attribute.

Return value

Type Description
n/a n/a

getAliases( ) : n/a

Description

Return a list of aliases for this Attribute (as defined by the schema) This list will be lowercase.

Return value

Type Description
n/a n/a

getAutoValue( ) : n/a

Return value

Type Description
n/a n/a

getDescription( ) : n/a

Return value

Type Description
n/a n/a

getFriendlyName( ) : n/a

Return value

Type Description
n/a n/a

getHelper( ) : n/a

Return value

Type Description
n/a n/a

getHelperValue( ) : n/a

Return value

Type Description
n/a n/a

getHint( ) : n/a

Return value

Type Description
n/a n/a

getIcon( ) : n/a

Return value

Type Description
n/a n/a

getLDAPtype( ) : n/a

Return value

Type Description
n/a n/a

getMaxLength( ) : n/a

Return value

Type Description
n/a n/a

getMaxValueCount( ) : n/a

Return value

Type Description
n/a n/a

getMinValueCount( ) : n/a

Return value

Type Description
n/a n/a

getName( boolean   $lower = true, boolean   $real = false, ) : string

Description

Return the name of the attribute.

Arguments

Name Type Description Default
$lower boolean
  • Return the attribute in normal or lower case (default lower)
true
$real boolean
  • Return the real attribute name (with ;binary, or just the name)
false

Return value

Type Description
string Attribute name

getOldValue(   $i, ) : n/a

Arguments

Name Type Description Default
$i n/a

Return value

Type Description
n/a n/a

getOldValues( ) : n/a

Return value

Type Description
n/a n/a

getOnChange( ) : n/a

Return value

Type Description
n/a n/a

getPage( ) : n/a

Return value

Type Description
n/a n/a

getPostValue( ) : n/a

Return value

Type Description
n/a n/a

getRemovedValues( ) : n/a

Description

Display the values removed in an attribute.

Return value

Type Description
n/a n/a

getSize( ) : n/a

Return value

Type Description
n/a n/a

getSource( ) : n/a

Return value

Type Description
n/a n/a

getSpacer( ) : n/a

Return value

Type Description
n/a n/a

getType( ) : n/a

Return value

Type Description
n/a n/a

getValue(   $i, ) : n/a

Arguments

Name Type Description Default
$i n/a

Return value

Type Description
n/a n/a

getValueCount( ) : n/a

Return value

Type Description
n/a n/a

getValues( ) : n/a

Return value

Type Description
n/a n/a

getVerify( ) : n/a

Return value

Type Description
n/a n/a

hasBeenModified( ) : n/a

Return value

Type Description
n/a n/a

haveFriendlyName( ) : n/a

Return value

Type Description
n/a n/a

haveMoreValues( ) : n/a

Return value

Type Description
n/a n/a

hide( ) : n/a

Return value

Type Description
n/a n/a

initValue(   $new_val, ) : n/a

Arguments

Name Type Description Default
$new_val n/a

Return value

Type Description
n/a n/a

isForceDelete( ) : n/a

Return value

Type Description
n/a n/a

isInternal( ) : n/a

Return value

Type Description
n/a n/a

isMay( ) : n/a

Return value

Type Description
n/a n/a

isMultiple( ) : n/a

Return value

Type Description
n/a n/a

isRDN( ) : boolean

Description

Return if this attribute is an RDN attribute

Return value

Type Description
boolean

isReadOnly( ) : n/a

Return value

Type Description
n/a n/a

isRequired( ) : n/a

Return value

Type Description
n/a n/a

isVisible( ) : n/a

Return value

Type Description
n/a n/a

justModified( ) : n/a

Return value

Type Description
n/a n/a

needJS(   $type = null, ) : n/a

Description

Does this attribute need supporting JS

Arguments

Name Type Description Default
$type n/a null

Return value

Type Description
n/a n/a

real_attr_name( ) : string

Description

Prunes off anything after the ";" in an attr name. This is useful for attributes that may have ";binary" appended to their names. With real_attr_name(), you can more easily fetch these attributes' schema with their "real" attribute name.

Return value

Type Description
string

setDescription(   $description, ) : n/a

Arguments

Name Type Description Default
$description n/a

Return value

Type Description
n/a n/a

setForceDelete( ) : n/a

Return value

Type Description
n/a n/a

setHint(   $hint, ) : n/a

Arguments

Name Type Description Default
$hint n/a

Return value

Type Description
n/a n/a

setIcon(   $icon, ) : n/a

Arguments

Name Type Description Default
$icon n/a

Return value

Type Description
n/a n/a

setInternal( ) : n/a

Return value

Type Description
n/a n/a

setLDAPdetails(   $sattr, ) : n/a

Description

Capture all the LDAP details we are interested in

Arguments

Name Type Description Default
$sattr n/a

Return value

Type Description
n/a n/a

setLDAPtype(   $type, ) : n/a

Arguments

Name Type Description Default
$type n/a

Return value

Type Description
n/a n/a

setMaxLength(   $maxlength, ) : n/a

Arguments

Name Type Description Default
$maxlength n/a

Return value

Type Description
n/a n/a

setMaxValueCount(   $max, ) : n/a

Arguments

Name Type Description Default
$max n/a

Return value

Type Description
n/a n/a

setMinValueCount(   $min, ) : n/a

Arguments

Name Type Description Default
$min n/a

Return value

Type Description
n/a n/a

setOldValue(   $val, ) : n/a

Arguments

Name Type Description Default
$val n/a

Return value

Type Description
n/a n/a

setOptional( ) : n/a

Return value

Type Description
n/a n/a

setPage(   $page, ) : n/a

Arguments

Name Type Description Default
$page n/a

Return value

Type Description
n/a n/a

setPostValue(   $postvalue, ) : n/a

Arguments

Name Type Description Default
$postvalue n/a

Return value

Type Description
n/a n/a

setProperties(   $properties, ) : n/a

Arguments

Name Type Description Default
$properties n/a

Return value

Type Description
n/a n/a

setRDN(   $rdn, ) : n/a

Arguments

Name Type Description Default
$rdn n/a

Return value

Type Description
n/a n/a

setReadOnly( ) : n/a

Return value

Type Description
n/a n/a

setRequired( ) : n/a

Return value

Type Description
n/a n/a

setSize(   $size, ) : n/a

Arguments

Name Type Description Default
$size n/a

Return value

Type Description
n/a n/a

setType(   $type, ) : n/a

Arguments

Name Type Description Default
$type n/a

Return value

Type Description
n/a n/a

setValue(   $new_val, ) : n/a

Arguments

Name Type Description Default
$new_val n/a

Return value

Type Description
n/a n/a

setXML(   $values, ) : n/a

Arguments

Name Type Description Default
$values n/a

Return value

Type Description
n/a n/a

show( ) : n/a

Return value

Type Description
n/a n/a

Properties

$aliases, $autovalue, $cols, $display, $forcedelete, $forcehide, $helper, $helpervalue, $hint, $icon, $internal, $ldaptype, $max_value_count, $maxlength, $min_value_count, $modified, $name, $oldvalues, $onchange, $order, $ordersort, $page, $postvalue, $rdn, $readonly, $rows, $size, $source, $spacer, $type, $unique, $values, $verify, $visible,

  protected  $aliases = array()




  protected  $autovalue = array()




  protected  $cols = 0




  protected  $display = ''




  protected  $forcedelete = false




  protected  $forcehide = false




  protected  $helper = array()




  protected  $helpervalue = array()




  protected  $hint = ''




  protected  $icon = ''




  protected  $internal = false




  protected  $ldaptype = null




  protected  $max_value_count = -1




  protected  $maxlength = 0




  protected  $min_value_count = -1




  protected  $modified = false




  public  $name =




  protected  $oldvalues = array()




  protected  $onchange = array()




  public  $order = 255




  public  $ordersort = 255




  public  $page = 1




  protected  $postvalue = array()




  public  $rdn = false




  protected  $readonly = false




  protected  $rows = 0




  protected  $size = 0




  protected  $source =




  protected  $spacer = false




  protected  $type = ''




  protected  $unique = false




  protected  $values = array()




  protected  $verify = false




  protected  $visible = false




Documentation was generated by phpDocumentor 2.0.1 .

Namespaces

  • global

    Packages