Squiz Matrix
4.12.2
|
Public Member Functions | |
LDAP_Bridge ($assetid=0) | |
connectToLdap () | |
getConnectionOptions () | |
getAsset ($assetid, $type_code='', $mute_errors=FALSE, $return_null=FALSE, $get_all_attr=FALSE) | |
getAssetTypeInfo ($assetids, $type_code=Array(), $strict_type_code=TRUE) | |
getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL, $dependant=NULL, $exclusive=NULL) | |
getParents ($assetid, $type_code='', $strict_type_code=TRUE) | |
getChildren ($assetid, $type_code='', $strict_type_code=TRUE, $dependant=NULL, $sort_by=NULL) | |
getLineageFromURL ($assetid, $protocol, $url) | |
getPermission ($assetid, $permission, $granted=NULL, $and_greater=TRUE, $expand_groups=FALSE, $all_info=FALSE) | |
setPermission ($assetid, $userid, $permission, $granted) | |
deletePermission ($assetid, $userid, $permission) | |
getAssetInfo ($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) | |
updateLink ($linkid, $link_type=NULL, $value=NULL, $sort_order=NULL) | |
deleteAssetLink ($linkid, $moving=FALSE) | |
canCreateLink (&$major, &$minor, $link_type, $exclusive) | |
createAssetLink (&$major, &$minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE) | |
delete ($release_lock) | |
_deleteStoredContents () | |
paintUserDetails ($info, &$o) | |
initUser (&$user, $data) | |
encodeString ($string) | |
decodeString ($string) | |
getAssetMapAssetInfo ($assetid) | |
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) | |
getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL) | |
Data Fields | |
$_group_types | |
$_user_types | |
$ldap_shdw_link_type = SQ_LINK_TYPE_1 | |
Data Fields inherited from Asset | |
$id = 0 | |
$version = '' | |
$name = '' | |
$short_name = '' | |
$status | |
$languages = '' | |
$charset = '' | |
$force_secure = '0' | |
$created | |
$created_userid | |
$updated | |
$updated_userid | |
$published | |
$published_userid | |
$status_changed | |
$status_changed_userid | |
$_is_cacheable = FALSE | |
$vars = Array() | |
$_available_keywords = Array() | |
$data_path_suffix = '' | |
$data_path = '' | |
$data_path_public = '' | |
$_ser_attrs = FALSE | |
Data Fields inherited from MySource_Object | |
$_tmp | |
Protected Member Functions | |
_getName ($short_name=FALSE, $contextid=NULL) | |
_getDummyAsset ($shadowid) | |
Protected Member Functions inherited from Asset | |
_preCreateCheck (Array &$link) | |
_createAdditional (Array &$link) | |
_abortCreate ($trigger_level_changed=FALSE, $linkid=0) | |
_loadVars () | |
_getName ($short_name=FALSE, $contextid=NULL) | |
_getKeywordReplacement ($keyword) | |
_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE) | |
makeAndSaveInitialWebPath ($path, $parent_link=NULL) | |
Definition at line 33 of file ldap_bridge.inc.
_deleteStoredContents | ( | ) |
Deletes the contents of the database for this LDAP
Definition at line 1453 of file ldap_bridge.inc.
|
protected |
Used by LDAP_Bridge::getAsset() to return a dummy asset when it fails to load the LDAP user.
string | $shadowid |
Definition at line 294 of file ldap_bridge.inc.
|
protected |
Returns name of the asset
boolean | $short_name | whether or not we are after the shortname or the full name |
int | $contextid | what context to return the name from |
Definition at line 98 of file ldap_bridge.inc.
assetExists | ( | $assetids | ) |
Determine if the passed assetid or assetids refer(s) to a valid asset in the system
Note that this will always return FALSE if you pass it a shadow asset
mixed | $assetids | the ID of the asset we are going to the check for existence or an array of assetids we want to check |
Definition at line 1192 of file ldap_bridge.inc.
canCreateLink | ( | & | $major, |
& | $minor, | ||
$link_type, | |||
$exclusive | |||
) |
Returns TRUE if the supplied assets can be linked in the specified way
object | &$major | the major asset in the proposed link |
object | &$minor | the minor asset in the proposed link |
string | $link_type | the type of link that is proposed |
int | $exclusive | (0|1) whether this will be the only significant link with $minor as the minor asset |
Definition at line 1397 of file ldap_bridge.inc.
connectToLdap | ( | ) |
Connect and bind to the LDAP directory that this asset bridges to
Definition at line 122 of file ldap_bridge.inc.
countLinks | ( | $assetid, | |
$side_of_link = 'major' , |
|||
$link_types = 0 , |
|||
$type_code = '' , |
|||
$strict_type_code = TRUE , |
|||
$ignore_linkid = 0 |
|||
) |
Return the number of links in the system that involve the specified asset
Can be restricted by either link type afnd/or asset type code
int | $assetid | id of the the $side_of_link asset |
string | $side_of_link | Which side of the link this (the current) asset is on ('major' or 'minor') |
int | $link_types | integer that can be the product of bitwise operations on the SQ_LINK_* constants |
mixed | $type_code | the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values |
boolean | $strict_type_code | whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes |
int | $ignore_linkid | ignore the link represented by this link id when returning the count |
Implements Bridge.
Definition at line 1297 of file ldap_bridge.inc.
createAssetLink | ( | & | $major, |
& | $minor, | ||
$link_type, | |||
$value = '' , |
|||
$sort_order = NULL , |
|||
$dependant = '0' , |
|||
$exclusive = '0' , |
|||
$moving = FALSE |
|||
) |
Create a link between the two supplied assets
object | &$major | the major asset that we are linking from |
object | &$minor | the minor asset that we are linking to |
string | $link_type | the type of link this is |
string | $value | the value that is to be associated with this link |
string | $sort_order | the position in the links list that this link should take, if NULL or less than zero places at end of list |
string | $dependant | '0' / '1' - whether the minor asset is dependant on the major |
string | $exclusive | '0' / '1' - whether the major asset is to be the minor's only parent |
boolean | $moving | whether or not this asset is being moved |
Definition at line 1420 of file ldap_bridge.inc.
decodeString | ( | $string | ) |
Decode a string Purpose - For Bug Fix (#3072) LDAP and Matrix cannot handle ampersand(&) in the name
string | $string | The string to encode |
Definition at line 1674 of file ldap_bridge.inc.
delete | ( | $release_lock | ) |
Delete Asset
boolean | $release_lock | TRUE, to release lock |
Definition at line 1435 of file ldap_bridge.inc.
deleteAssetLink | ( | $linkid, | |
$moving = FALSE |
|||
) |
Remove a link by id
int | $linkid | the link id of the link to remove |
boolean | $moving | TRUE if this delete is part of a move operation |
Implements Bridge.
Definition at line 1377 of file ldap_bridge.inc.
deletePermission | ( | $assetid, | |
$userid, | |||
$permission | |||
) |
Deletes a permission with the passed user or user_group
int | $assetid | the assetid for asset whose permissions to delete |
int | $userid | the id of the user or user_group to remove the permission from |
string | $permission | the permission code you are deleting |
Definition at line 1103 of file ldap_bridge.inc.
encodeString | ( | $string | ) |
Encode a string Purpose - For Bug Fix (#3072) LDAP and Matrix cannot handle ampersand(&) in the name
string | $string | The string to encode |
Definition at line 1648 of file ldap_bridge.inc.
getAllChildLinks | ( | $assetid, | |
$link_type = 0 |
|||
) |
Get details of the links from the specified asset to all its children
string | $assetid | the assetid of the asset to find the child links for |
int | $link_type | the type of links to get |
Definition at line 1340 of file ldap_bridge.inc.
getAsset | ( | $assetid, | |
$type_code = '' , |
|||
$mute_errors = FALSE , |
|||
$return_null = FALSE , |
|||
$get_all_attr = FALSE |
|||
) |
Returns a reference to the asset represented by the passed assetid
int | $assetid | the entire asset id of the asset to be loaded |
string | $type_code | if this exists then this object is used to load the asset, if not then the DB is queried to find out the asset type |
boolean | $mute_errors | stops the outputting of errors in this fn, needed because you can't use the '@' operator when returning by reference |
boolean | $return_null | returns NULL if no user/user data found |
boolean | $get_all_attr | if we being called from paintUserSetup() make sure we get all the attributes for the ldap users so that we can paint option for sys admin to show/hide them |
Definition at line 205 of file ldap_bridge.inc.
getAssetInfo | ( | $assetids, | |
$type_code = Array() , |
|||
$strict_type_code = TRUE , |
|||
$field = '' |
|||
) |
Returns an array of information about assets of the passed codes
If one value in $field then the return value is Array(assetid => '[field]'), otherwise Array(assetid => Array())
array | $assetids | an array of assets to limit |
mixed | $type_code | an asset type code, or array of typecodes, to limit results to |
boolean | $strict_type_code | ensure returned assets are of the passed type codes |
string | $field | single field from the asset table to return (along with the assetid) Default is all fields |
Definition at line 1124 of file ldap_bridge.inc.
getAssetMapAssetInfo | ( | $assetid | ) |
Get asset info for use by asset map
string | $assetid | Full Asset id to get information for |
Implements Bridge.
Definition at line 1698 of file ldap_bridge.inc.
getAssetTypeInfo | ( | $assetids, | |
$type_code = Array() , |
|||
$strict_type_code = TRUE |
|||
) |
Returns an array of assetid => inherited_types for assets of the passed codes
array | $assetids | an array of assets to limit |
array | $type_code | an array of types codes to limit the results to |
boolean | $strict_type_code | ensure returned assets are of the passed type codes |
Definition at line 317 of file ldap_bridge.inc.
getChildren | ( | $assetid, | |
$type_code = '' , |
|||
$strict_type_code = TRUE , |
|||
$dependant = NULL , |
|||
$sort_by = NULL |
|||
) |
Get all asset ids that are below the passed assetid in the various trees in which it exists
int | $assetid | the id of the asset to get its children for |
mixed | $type_code | the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values |
boolean | $strict_type_code | whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes |
boolean | $dependant | if TRUE, results will be filtered to assets that are dependants. If FALSE, results will all not be dependants. If NULL, results will not be filtered |
string | $sort_by | a field in the asset table you would like the results sorted by (eg. name, short_name etc) |
Implements Bridge.
Definition at line 871 of file ldap_bridge.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.
Definition at line 174 of file ldap_bridge.inc.
getLineageFromURL | ( | $assetid, | |
$protocol, | |||
$url | |||
) |
Returns an array of assetid's + info in the order that they propogate out from THIS BRIDGE'S url
string | $assetid | the id of the last asset in the lineage |
string | $protocol | the protocol to match -> NULL means it is ignored |
string | $url | the url to check for -> NULL defaults it to current url |
Implements Bridge.
Definition at line 1018 of file ldap_bridge.inc.
getLink | ( | $assetid, | |
$link_type = NULL , |
|||
$type_code = '' , |
|||
$strict_type_code = TRUE , |
|||
$value = NULL , |
|||
$side_of_link = 'major' , |
|||
$exclusive = NULL |
|||
) |
Get details of a link with the specified characteristics
int | $assetid | id of the the $side_of_link asset |
int | $link_type | integer that should be a single integer of the SQ_LINK_* constants |
mixed | $type_code | the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values |
boolean | $strict_type_code | whether we are finding an asset that is just a $type_code or potentially an inherited type or $type_code and any of it's sub-classes |
string | $value | the value that is associated with this link |
string | $side_of_link | Which side of the link this (the current) asset is on ('major' or 'minor') |
boolean | $exclusive | The exclusive status for the link must be this (if not NULL) |
Definition at line 1220 of file ldap_bridge.inc.
getLinkByAsset | ( | $assetid, | |
$other_assetid, | |||
$link_types = NULL , |
|||
$value = NULL , |
|||
$side_of_link = 'major' , |
|||
$force_array = FALSE , |
|||
$dependant = NULL , |
|||
$exclusive = NULL |
|||
) |
Get details of the link(s) between the two specified assets
int | $assetid | id of the the $side_of_link asset |
int | $other_assetid | the asset on the other side of the link |
int | $link_types | integer that can be the product of bitwise operations on the SQ_LINK_* constants |
string | $value | the value that is associated with this link |
string | $side_of_link | Which side of the link the first assetid is on ('major' or 'minor') |
boolean | $force_array | force the results to return an array of links even if there is only one link |
boolean | $dependant | The dependant status for all the links must be this (if not null) |
boolean | $exclusive | The exclusive status for all the links must be this (if not null) |
Definition at line 1324 of file ldap_bridge.inc.
getLinkById | ( | $linkid, | |
$assetid = 0 , |
|||
$side_of_link = 'major' |
|||
) |
Get details of the link with specified linkid
int | $linkid | id of the link were returning |
int | $assetid | id of the the $side_of_link asset if zero no check is made and both major and minor information is returned |
string | $side_of_link | Which side of the link the asset represented by $assetid is on ('major' or 'minor') |
Definition at line 1269 of file ldap_bridge.inc.
getLinks | ( | $assetid, | |
$link_types, | |||
$type_code = '' , |
|||
$strict_type_code = TRUE , |
|||
$side_of_link = 'major' , |
|||
$sort_by = NULL , |
|||
$dependant = NULL , |
|||
$exclusive = NULL |
|||
) |
Return all links that this asset has to other assets
int | $assetid | id of the the $side_of_link asset |
int | $link_types | integer that can be the product of bitwise operations on the SQ_LINK_* constants |
mixed | $type_code | the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values |
boolean | $strict_type_code | whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes |
string | $side_of_link | Which side of the link this (the current) asset is on ('major' or 'minor') |
string | $sort_by | a field in the asset table you would like the results sorted by (eg. name, short_name etc) |
boolean | $dependant | Whether we want dependant links, non-dependent or (NULL) don't care |
boolean | $exclusive | Whether we want exclusive links, non-exclusive or (NULL) don't care |
Definition at line 373 of file ldap_bridge.inc.
getParents | ( | $assetid, | |
$type_code = '' , |
|||
$strict_type_code = TRUE |
|||
) |
Get all asset ids that are above the passed assetid in the various trees in which it exists
Can only find parents of type user_group
int | $assetid | the id of the asset to get its parents for |
mixed | $type_code | the type of asset that is linked (eg 'User', 'User_Group', etc) if an array returns link if matches any of the array values |
boolean | $strict_type_code | whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes |
Implements Bridge.
Definition at line 690 of file ldap_bridge.inc.
getPermission | ( | $assetid, | |
$permission, | |||
$granted = NULL , |
|||
$and_greater = TRUE , |
|||
$expand_groups = FALSE , |
|||
$all_info = FALSE |
|||
) |
Returns an array of all user or user_group assets that have the passed permission for the passed asset
int | $assetid | the assetid for asset whose permissions to get |
string | $permission | the permission code you are getting |
boolean | $granted | type of Access : NULL = all, TRUE = granted, FALSE = denied |
boolean | $and_greater | get effective permission (eg read access = read or write or admin) |
boolean | $expand_groups | expand user groups so only user ids get returned (NOTE: only valid if $all_info is FALSE) |
boolean | $all_info | when FALSE fn just returns an array of userids for those that have permission When TRUE fn returns all info about the permission in the form of Array(userid => granted) (NOTE: TRUE is only valid if $and_greater and $expand_groups are FALSE) |
Definition at line 1067 of file ldap_bridge.inc.
initUser | ( | & | $user, |
$data | |||
) |
Paints the user info based on the setting in the bridge
object | &$user | the LDAP user asset that we are going to initialise |
array | $data | the LDAP entry for this user (contains all user data) |
Definition at line 1548 of file ldap_bridge.inc.
LDAP_Bridge | ( | $assetid = 0 | ) |
Constructor
int | $assetid | the asset id to be loaded |
Definition at line 80 of file ldap_bridge.inc.
paintUserDetails | ( | $info, | |
& | $o | ||
) |
Paints the user info based on the setting in the bridge
array | $info | the attributes of the ldap_user or ldap_backend_user asset |
object | &$o | the outputter class for the ldap_user or ldap_backend_user pass in a null obj to print details for frontend |
Definition at line 1483 of file ldap_bridge.inc.
setPermission | ( | $assetid, | |
$userid, | |||
$permission, | |||
$granted | |||
) |
Sets a permission for the passed user or user_group
int | $assetid | the assetid for asset whose permissions to set |
int | $userid | the id of the user or user_group to add the permission for |
string | $permission | the permission code you are adding |
boolean | $granted | whether this permission grants access or not |
Definition at line 1086 of file ldap_bridge.inc.
updateLink | ( | $linkid, | |
$link_type = NULL , |
|||
$value = NULL , |
|||
$sort_order = NULL |
|||
) |
Update the details of an existing link
If any of the detail vars are NULL they are not updated.
int | $linkid | the link id of the link to update |
int | $link_type | the type of the link (one of the SQ_LINK_* constants) |
string | $value | the value to place on the link |
int | $sort_order | the position in the links list that this link should take, if less than zero places at end of list |
Definition at line 1361 of file ldap_bridge.inc.
$_group_types |
Definition at line 42 of file ldap_bridge.inc.
$_user_types |
Definition at line 60 of file ldap_bridge.inc.