Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Data_Source_Ldap Class Reference
Inheritance diagram for Data_Source_Ldap:
Data_Source Asset Bridge MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 getResultSet ()
 
 _loadLdapVars ()
 
 connectToLdap ()
 
 _executeQuery ($search_filter)
 
 parseStringValues ($str, $delimiter= ',')
 
 getConnectionOptions ()
 
 getSearchFilterString ()
 
 _getAllowedLinks ()
 
 getBinaryDataAttributes ()
 
- Public Member Functions inherited from Data_Source
 __construct ($assetid=0)
 
 _getAllowedLinks ()
 
 getFieldNamesFromRecordSet ()
 
 getResultSet ($result_id='')
 
 getCachedResultSet ($cache_key='')
 
 setResultSet (Array $result, $result_id='')
 
 cacheResultSet (Array $result, $cache_key='')
 
 getPermission ($assetid, $permission, $granted=NULL, $and_greater=TRUE, $expand_groups=FALSE, $all_info=FALSE)
 
 setPermission ($assetid, $data_source_record_setid, $permission, $granted)
 
 deletePermission ($assetid, $data_source_record_setid, $permission)
 
 getAssetInfo (Array $assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
 
 assetExists ($assetids)
 
 getLink ($assetid, $link_type=NULL, $type_code='', $strict_type_code=TRUE, $value=NULL, $side_of_link='major', $exclusive=NULL)
 
 getLinkById ($linkid, $assetid=0, $side_of_link='major')
 
 countLinks ($assetid, $side_of_link='major', $link_types=0, $type_code='', $strict_type_code=TRUE, $ignore_linkid=0)
 
 getLinkByAsset ($assetid, $other_assetid, $link_types=NULL, $value=NULL, $side_of_link='major', $force_array=FALSE, $dependant=NULL, $exclusive=NULL)
 
 getAllChildLinks ($assetid, $link_type=0)
 
 getBinaryDataAttributes ()
 
 updateLink ($linkid, $link_type=NULL, $value=NULL, $sort_order=NULL)
 
 deleteAssetLink ($linkid, $moving=FALSE)
 
 createAssetLink (Asset $major, Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE)
 
 getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL)
 
 getChildren ($assetid, $type_code='', $strict_type_code=TRUE, $dependant=NULL, $sort_by=NULL)
 
 getAsset ($assetid, $type_code='', $mute_errors=FALSE, $return_null=FALSE)
 
 getParents ($assetid, $type_code='', $strict_type_code=TRUE, $sort_by=NULL, $access=NULL)
 
 getAssetMapAssetInfo ($assetid)
 
 getLineageFromURL ($assetid, $protocol, $url)
 
 filterResultSet ($result)
 
 getDatasourceFilters ()
 
 getDynamicVariableValue ($variable_name)
 
 delete ($release_lock)
 
 _deleteStoredContents ()
 
- Public Member Functions inherited from Asset
 Asset ($assetid=0)
 
 create (Array &$link)
 
 load ($assetid)
 
 _loadDataPaths ()
 
 reload ()
 
 canDelete ()
 
 delete ($release_lock=TRUE, $check_locked=TRUE)
 
 useSystemVersion ()
 
 loadSystemVersion ()
 
 saveSystemVersion ()
 
 clearSystemVersion ()
 
 revertToSystemVersion ()
 
 revertNoticeLinksToSystemVersion ()
 
 _updated ($update_parents=TRUE)
 
 type ()
 
 getTypeAncestors ($include_asset=TRUE)
 
 incrementVersion ($number='micro', $update_parents=TRUE)
 
 getLanguages ()
 
 setLanguages (Array $languages)
 
 setCharset ($charset)
 
 setForceSecure ($force_secure)
 
 remapAssetids (Array $map)
 
 morph ($new_type_code)
 
 _morphCleanup ($new_type_code)
 
 onRequestKeywords (Asset $broadcaster, Array $vars=Array())
 
 canClone ()
 
 cloneComponents (Asset $clone, Array $components, $override=FALSE)
 
 cloneComponentsAdditional (Asset $clone, Array $components)
 
 cloneLinks (Asset $clone)
 
 getStatus ()
 
 getAvailableStatii ()
 
 getStatusDescription ()
 
 processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
 
 setDate ($date_type, $time=NULL, $userid=NULL)
 
 lockTypes ()
 
 canForceablyAcquireLock ($lock_type)
 
 getEditingLocks ($keywords)
 
 _getAllowedLinks ()
 
 createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 canCreateLink (Asset $minor, $link_type, $exclusive)
 
 canMoveLink (Asset $minor, Asset $old_major, $link_type)
 
 describeLink ($linkid)
 
 isDeletableLink ($linkid)
 
 canDeleteLink ($linkid)
 
 deleteLink ($linkid, $check_locked=TRUE)
 
 linksUpdated ()
 
 canCloneLink ()
 
 saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
 
 setAttrValue ($name, $value)
 
 attr ($name)
 
attrByRef ($name)
 
 getAttribute ($name, $mute_errors=FALSE)
 
 getAssetKeywords ($descriptions=FALSE)
 
 getAvailableKeywords ()
 
 getKeywordReplacement ($keyword)
 
 getAssetWebPathKeywordReplacement ()
 
 getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
 
 processCustomKeywords ($keywords=Array())
 
 getContent ()
 
 setContent ()
 
 getEffectiveLastUpdatedTime ($assetids)
 
 readAccess (Array $assetids=Array())
 
 writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
 
 adminAccess ($lock_type='', Array $assetids=Array())
 
 backendAccess ()
 
 liveEditAccess ($lock_type)
 
 canliveEdit ($lock_type)
 
 effectiveUnrestricted ()
 
 checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
 
 accessEffective ()
 
 permissionsUpdated ()
 
 printFrontend ()
 
 printFrontendAsset (Asset $asset, $design=NULL)
 
 getValidProtocols ()
 
 printHead ()
 
 printBody ()
 
 getCurrentPaintLayoutName ()
 
 getCurrentDesignName ()
 
 printBodyWithPaintLayout ($layout_id='')
 
 initLimbo ()
 
 printLimbo ()
 
 paintBackend (Backend_Outputter $o)
 
 getPrefix ()
 
 processBackend (Backend_Outputter $o, Array &$link)
 
 getEI ()
 
 getEditFns ()
 
 getBackendHref ($screen='', $backend_page=TRUE)
 
 getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
 
 getURLs ()
 
 getHref ($base_url=NULL, $ignore_rollback=FALSE)
 
 getWebDataPath ()
 
 getWebPaths ()
 
 saveWebPaths ($paths, $auto_add_remaps=TRUE)
 
 getLookups ($field='')
 
 getDesignLookups ()
 
 getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
 
 deleteLookupValue ($layout_name, $layout_value)
 
 setPaintLayouts ($layouts)
 
 updateLookups ($auto_add_remaps=TRUE)
 
 setLookupValues (Array $values)
 
 getAssetStatusDescriptionKeywordReplacement ()
 
 getAssetStatusColourKeywordReplacement ()
 
 replaceKeywordsInString ($string)
 
 fastTrack ($tasks)
 
 unFastTrack ($tasks)
 
 shouldFastTrack ($task, $assetid=NULL)
 
 getFaskTrackedTaskAssetids ($task)
 
 getDependantParentsURL ()
 
- Public Member Functions inherited from MySource_Object
 MySource_Object ()
 
 __sleep ()
 
 __wakeup ()
 
- Public Member Functions inherited from Bridge
 getAsset ($shadowid, $type_code='', $mute_errors=FALSE)
 
 getParents ($assetid, $type_code='', $strict_type_code=TRUE)
 

Data Fields

 $_ldap_dir
 

Additional Inherited Members

- Protected Member Functions inherited from Data_Source
 _createAdditional (Array &$link)
 
 _getName ($short_name=FALSE, $contextid=NULL)
 
 _getDummyAsset ($shadowid)
 

Detailed Description

Definition at line 35 of file data_source_ldap.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 62 of file data_source_ldap.inc.

Member Function Documentation

_executeQuery (   $search_filter)

Function that executes the LDAP query using the given search filter

Parameters
string$search_filterLDAP search filter string
Returns
array public

Definition at line 190 of file data_source_ldap.inc.

_getAllowedLinks ( )

Returns an array of all the permitted links type, the type asset and the cardinality In the form

Array('[link_type]' => Array('[type_code]' => Array('card' => [cardinality], 'exclusive' => [exclusive]))); Where: link_type = SQ_LINK_TYPE_1|SQ_LINK_TYPE_2|SQ_LINK_TYPE_3|SQ_LINK_NOTICE cardinality = [max number of links]|'M' exclusive = TRUE|FALSE

Returns
array private

Definition at line 341 of file data_source_ldap.inc.

_loadLdapVars ( )

Load LDAP connection details from external LDAP Bridge or from its own LDAP settings

Returns
void private

Definition at line 111 of file data_source_ldap.inc.

connectToLdap ( )

Connect and bind to the LDAP directory that this asset bridges to

Returns
object public

Definition at line 150 of file data_source_ldap.inc.

getBinaryDataAttributes ( )

Returns name of LDAP attributes defined as binary data

Returns
array public

Definition at line 363 of file data_source_ldap.inc.

getConnectionOptions ( )

Returns an array of defined user-customisable LDAP connection options.

The options below are customisable by the user. If the user chooses to customise one of the below options, it's value will be set according to the array below. If an option is not customised, the default is assumed.

Returns
array public

Definition at line 278 of file data_source_ldap.inc.

getResultSet ( )

Returns an array of the result of LDAP search query execution

Returns
array public

Definition at line 77 of file data_source_ldap.inc.

getSearchFilterString ( )

Processes and returns the search filter string

Returns
string public

Definition at line 298 of file data_source_ldap.inc.

parseStringValues (   $str,
  $delimiter = ',' 
)

Parse a delimiter-separated string and return the array containing the unique values.

Parameters
string$strThe delimiter-separated string to parse
string$delimiterThe delimiter that splits the values in the string
Returns
array Return the array containing the unique values from the parsed string public

Definition at line 252 of file data_source_ldap.inc.


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