SAML_Account_Manager Class Reference

Inheritance diagram for SAML_Account_Manager:

Public Member Functions
	__construct ($assetid=0)
	__wakeup ()
	isSimplesamlphpInstalled ()
	create (Array &$link)
	_createAdditional (&$link)
	_getAllowedLinks ()
	printFrontend ()
	printBody ()
	_processGlobalActions ()
&	getRedirectAsset ()
	setRedirectAsset (&$asset)
	_getRedirectURL ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getBodycopies ()
Public Member Functions inherited from Page_Asset_Builder
	__construct ($assetid=0)
	_createAdditional (&$link)
	saveAttributes ($dont_run_updated=FALSE)
	prepareLink (&$asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	isDeletableLink ($linkid)
	_getAllowedLinks ()
	printBody ()
	_printBody ()
	getFormCaptchaKeywordReplacement ()
	getFormCaptchaImageKeywordReplacement ()
	getFormCaptchaFieldKeywordReplacement ()
	getFormCaptchaLinkKeywordReplacement ()
	_processGlobalActions ()
	_abortAssetCreate ($linkid=0)
	getSelectedCreateLocations ()
	getAllSelectableCreateLocations ()
	_getMetadataSchemasToApply ()
	getFixedCreateLocations ()
	getRuleMatchCreateLocations ($create_type, $attributes=Array())
	getCreateLocations ($create_type)
	getAdditionalCreateLocations ()
	getDynamicCreateLocations ()
	_sanitiseLocationSetName ($set_name)
	_modifyCreateLink (&$link)
	_setCreateStatus (&$new_asset)
	_loadAssetReplacements ()
	_loadCreateReplacements ()
	_printContents ()
	_errorHandler ($err_no, $err_msg, $err_file, $err_line)
	_getBodycopies ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getNotLoggedInKeywords ()
	_getLoggedInKeywords ()
	_getCreatedKeywords ()
	_getSelectableLocationKeywords ()
	_getDynamicLocationKeywords ()
	getLoginInviteKeywordReplacement ()
	getLoginErrorKeywordReplacement ()
	getLoginFormKeywordReplacement ()
	getCreatedAssetidKeywordReplacement ()
	getCreatedAssetNameKeywordReplacement ()
	getCreatedAssetShortNameKeywordReplacement ()
	getCreatedAssetUrlKeywordReplacement ()
	getCreatedAssetEditKeywordReplacement ()
	getCreatedAssetBackendKeywordReplacement ()
	getCreateErrorKeywordReplacement ()
	getCreateInviteKeywordReplacement ()
	getCreateFormKeywordReplacement ()
&	_getCreateFormLayout ($type_code)
Public Member Functions inherited from Page
	__construct ($assetid=0)
	_getAllowedLinks ()
	printBody ()
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 ()

Data Fields
	$saml_auth_manager
	$idp_entityid
Data Fields inherited from Page_Asset_Builder
	$_current_state = ''
	$_errors = Array()
	$_replacements = Array()
	$_default_state = 'create'

Protected Member Functions
	_getAuthManager ()
	_getEntityid ()
	_getAuthenticatedSamlUserid ()
	_searchLinkedMatrixUser ($samlUserid)
	_linkMatrixUserWithSAML ($matrixUserid, $samlUserid)
	_unlinkMatrixUserWithSAML ($matrixUserid, $samlUserid)
	_loginUser ($userid)
	_logoutUser ($clear_saml_session=TRUE)
	_createUser ($create_type)

Detailed Description

Definition at line 31 of file saml_account_manager.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

string	$assetid	the asset id to be loaded
Array	$data	the shadow asset data that will construct this variety

Definition at line 45 of file saml_account_manager.inc.

Member Function Documentation

__wakeup

(

)

Wakeup.

It's important to load components when restored from a serialised state by Deja Vu.

public

Definition at line 64 of file saml_account_manager.inc.

_createAdditional

(

&

$link

)

Perform any additional processing required during the creation of this asset

Asset builders create bodycopy assets when they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 164 of file saml_account_manager.inc.

_createUser (   $create_type )

protected

Automatically create the local Matrix user

Parameters

string

$create_type

matrix user type

Returns

null protected

Definition at line 973 of file saml_account_manager.inc.

_getAllowedLinks

(

)

Returns an array of all the permitted link types, the asset type and the cardinality

Returns

array private

See Also

Asset::_getAllowLinks()

Definition at line 201 of file saml_account_manager.inc.

_getAuthenticatedSamlUserid ( )

protected

Get unique saml id from authenticated saml user data

Returns

string protected

Definition at line 108 of file saml_account_manager.inc.

_getAuthManager ( )

protected

Get SAML Auth Manager class

Returns

object protected

Definition at line 78 of file saml_account_manager.inc.

_getBodycopies

(

)

Return an array of bodycopies that need to be created

Returns

array private

Definition at line 878 of file saml_account_manager.inc.

_getEntityid ( )

protected

Get entityid of the IDP

Returns

string protected

Definition at line 92 of file saml_account_manager.inc.

_getRedirectURL

(

)

get the URL that we will be redirecting to

Returns

string private

Definition at line 785 of file saml_account_manager.inc.

_linkMatrixUserWithSAML (   $matrixUserid,   $samlUserid  )

protected

Link Matrix user with specified SAML account

Parameters

varchar	$matrixUserid	Matrix userid string
varchar	$samlUserid	SAML userid string

Returns

int | null protected

Definition at line 635 of file saml_account_manager.inc.

_loginUser (   $userid )

protected

Log in the Matrix user (and do redirects if required)

Parameters

string

$userid

matrix user id

Returns

null protected

Definition at line 909 of file saml_account_manager.inc.

_logoutUser (   $clear_saml_session = TRUE )

protected

Log out of the Matrix user

Parameters

bool

$clear_saml_session

clears saml session

Returns

null protected

Definition at line 936 of file saml_account_manager.inc.

_processGlobalActions

(

)

Process any global Account Manager actions

This function builds on the Asset Builder one by auto filling the username field of the login form that may be printed once the user account has been created.

Returns

boolean private

See Also

Page_Asset_Builder::_processGlobalActions()

Definition at line 570 of file saml_account_manager.inc.

_searchLinkedMatrixUser (   $samlUserid )

protected

Search linked Matrix user by SAML user id

Parameters

varchar

$samlUserid

SAML userid string

Returns

int | null protected

Definition at line 609 of file saml_account_manager.inc.

_unlinkMatrixUserWithSAML (   $matrixUserid,   $samlUserid  )

protected

Unlink Matrix user with specified SAML account

Parameters

varchar	$matrixUserid	Matrix userid string
varchar	$samlUserid	SAML userid string

Returns

int | null protected

Definition at line 677 of file saml_account_manager.inc.

create

(

Array &

$link

)

Create this asset - Force the value of the "type" attribute to thesaurus term

See Also

asset::create()

Returns

mixed int|boolean public

Definition at line 148 of file saml_account_manager.inc.

& getRedirectAsset

(

)

Returns the asset (if any) that we are redirecting to

Returns

mixed object|NULL public

Definition at line 701 of file saml_account_manager.inc.

isSimplesamlphpInstalled

(

)

Is simplesamlphp librart installed?

Returns

boolean protected

Definition at line 136 of file saml_account_manager.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = Array()
	)

Add valid keywords for this asset to an array of keywords when asked

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array

Returns

boolean private

Definition at line 837 of file saml_account_manager.inc.

printBody

(

)

Called by the design to print the body of this asset

Returns

void public

Definition at line 344 of file saml_account_manager.inc.

printFrontend

(

)

Prints out the Frontend for this asset

Returns

void public

Definition at line 217 of file saml_account_manager.inc.

setRedirectAsset

(

&

$asset

)

Set's the asset (if any) that we are going to be redirecting to

Parameters

object

&$asset

the asset that we want to redirect to (NULL clears the redirect asset)

Returns

boolean public

Definition at line 734 of file saml_account_manager.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/saml/page_templates/saml_account_manager/saml_account_manager.inc