Class: I2CE FormStorage LDAP (4.1.7)

From IHRIS Wiki
Revision as of 09:39, 23 August 2013 by Litlfred (talk | contribs) (Created page with "{{otherversions|Class: I2CE_FormStorage_LDAP}} This article describes the class ''I2CE_FormStorage_LDAP'' . *Extends the class: [[Class: I2CE_FormStorage_Mechanism (4.1.7) | I2CE...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


This article describes the class I2CE_FormStorage_LDAP .

@filesource Class I2CE_FormStorage_File_Base

Variables

$ldap

the ldap connect;

Methods

convertToLDAPTimestamp()

convertToUnixTimestamp()

createFilter()

getConnection()

Get the ldap connection @aparm string $form. The form we want to connect on

getEntryAttributes()

getIdsAsChild()

Gets the id's for the given child for this form.

getList()

Return array which is a list of the specified typ

  • Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageLDAP/lib/I2CE_FormStorage_LDAP.php on line 246
  • Signature: protected function getList($form,$type,$get_all_values,$filter_options,$attribute_refs,$limit)
  • Parameters:
    • string $form
    • string $type
    • bool $get_all_values
      Defaults to false in which we only get the most recent value of each attribute . If true we return the array of all values/
      • Default Value: false
    • array $filter_options
      Defaults to empty array. Keys are attribute references (same keys as under the attributes MDN) and values are the values of the attribute to limit to
      • Default Value: array()
    • $attribute_refs
      • Default Value: null
    • mixed $limit
      Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
      • Default Value: false
  • Returns: array
    or arrays. Each sub-array is an array with keys attribute references and values dependent on {@get_all_values}. if the attribute is not set the attribute reference will not be present

getRecords()

Return an array of all the record ids for a given form.

isWritable()

Checks to see if this storage mechansim implements the writing methods. You need to override this in a subclass that implements writable

ldap_escape()

LDAP escaping function to prevent against injection.

listFields()

  • Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageLDAP/lib/I2CE_FormStorage_LDAP.php on line 642
  • Signature: public function listFields($form,$fields,$parent,$where_data,$ordering,$limit,$mod_time)
  • Parameters:
    • string $form
      THe form name
    • array $fields
      of string. The fields we want returned. Can include the special field 'last_modified' to get the last modification time for any of the fields of that form which is returned in the format "Y-m-d H:i:s"
    • boolean $parent
      Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id. If true, we return the parent as one of the fields.
      • Default Value: false
    • array $where_data
      contains the where clause information about this form or a nested
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
      • Default Value: false
    • integer $mod_time
      Defaults to -1. If non-negative, we only list the requested fields for an id if at least one of them has a modification time greater than or equal to $mod_time. If the form storage has no way of tracking modifucation time, all entries are listed.
      • Default Value: -1
  • Returns: mixed
    an array with key id's and value and array of values. the array of values has as keys the fields with their corresponding value.

populate()

Populate the member variables of the object from the database. @param I2CE_Form $form

save()

Save a form object into entry tables. If this functio is over-written, it should include the fuzzy method call foreach ($form as $field) { $field->save(true/false, $user) } See compatibility issue: http://www.php.net/manual/en/function.ldap-rename.php#57521 @param I2CE_Form $form

search()

  • Defined in i2ce/modules/Forms/modules/FormStorage/modules/FormStorageLDAP/lib/I2CE_FormStorage_LDAP.php on line 603
  • Signature: public function search($form,$parent,$where_data,$ordering,$limit)
  • Parameters:
    • string $form
      The form name.
    • boolean $parent
      Defaults to false. If it is scalar and non-boolean, it is consider to be the ID of the parent, and then we get all forms with parent the given id.
      • Default Value: false
    • mixed $where_data
      array or class implementing ArrayAccess, Iterator, and Countable (e.g. MagicDataNode) . the where data.
      • Default Value: array()
    • array $ordering
      An array of fields to order by. Defaults to the empty array. Prepend a - to order by in descending order.
      • Default Value: array()
    • mixed $limit
      Defaults to false. It true, returns only one result. If an integer it is the numeber of records to limit to. If it is as an array of two integers, it is the offset and then number of results to limit to.
      • Default Value: false
  • Returns: mixed
    an array of matching form ids. However, ff $limit_one is true or 1 or array ($offset,1) then then we return either the id or false, if none found or there was an error.

Inherited Methods

FF_IG_setSequence()

This public method is inherited from I2CE_FormStorage_Mechanism->FF_IG_setSequence()

FF_populateHistory()

This public method is inherited from I2CE_FormStorage_Mechanism->FF_populateHistory()

FF_save()

This public method is inherited from I2CE_FormStorage_Mechanism->FF_save()

__construct()

This public method is inherited from I2CE_FormStorage_Mechanism->__construct()

changeID()

This public method is inherited from I2CE_FormStorage_Mechanism->changeID()

delete()

This public method is inherited from I2CE_FormStorage_Mechanism->delete()

getFormsById()

This public method is inherited from I2CE_FormStorage_Mechanism->getFormsById()

globalFieldUpdateByFunction()

This public method is inherited from I2CE_FormStorage_Mechanism->globalFieldUpdateByFunction()

hasRecord()

This public method is inherited from I2CE_FormStorage_Mechanism->hasRecord()

listDisplayFields()

This public method is inherited from I2CE_FormStorage_Mechanism->listDisplayFields()

lookupDisplayField()

This public method is inherited from I2CE_FormStorage_Mechanism->lookupDisplayField()

lookupField()

This public method is inherited from I2CE_FormStorage_Mechanism->lookupField()

populateHistory()

This public method is inherited from I2CE_FormStorage_Mechanism->populateHistory()

setStorageOptions()

This public method is inherited from I2CE_FormStorage_Mechanism->setStorageOptions()

compareFormsByFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->compareFormsByFields()

getLimitedFields()

This protected method is inherited from I2CE_FormStorage_Mechanism->getLimitedFields()

getStorageOptions()

This protected method is inherited from I2CE_FormStorage_Mechanism->getStorageOptions()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$name

Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$name

$global_options

Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$global_options

$storage_options_cache

Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$storage_options_cache

$ordering

Theis protected variable is inherited from I2CE_FormStorage_Mechanism->$ordering

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()