Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Page_Decision_Tree Class Reference
Inheritance diagram for Page_Decision_Tree:
Page Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 _getAllowedLinks ()
 
 isDeletableLink ($linkid)
 
 printFrontendAsset (Asset $asset, $design=NULL)
 
 printBody ()
 
 printNextStep ($question_id, $answer, $total_points)
 
 generateJS ($question)
 
getFolder ($type='type_formats')
 
getBodycopy ($name='', $type='')
 
 getResultBodycopies ()
 
 createResultBodycopy ($name, $link_value)
 
 getTypeFormatKeywordReplacement ($keyword, $question_asset)
 
 getPageContentsKeywordReplacement ($keyword)
 
 onRequestKeywords (&$broadcaster, $vars=Array())
 
- 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 ()
 

Protected Member Functions

 _createAdditional (Array &$link)
 
- Protected Member Functions inherited from Page
 _preCreateCheck (Array &$link)
 
 _createAdditional (Array &$link)
 
 _getName ($short_name=FALSE)
 
- 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)
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 30 of file page_decision_tree.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
string$assetidthe assetid of the asset to load into this object
Returns
void public

Definition at line 42 of file page_decision_tree.inc.

Member Function Documentation

_createAdditional ( Array &  $link)
protected

Perform any additional processing required during the creation of this asset

Pages add a default web path when they are created

Parameters
array&$linkinformation used to create the initial link
Returns
boolean private

Definition at line 60 of file page_decision_tree.inc.

_getAllowedLinks ( )

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

Returns
array private
See Also
Asset::_getAllowLinks()

Definition at line 105 of file page_decision_tree.inc.

createResultBodycopy (   $name,
  $link_value 
)

Creates bodycopies for this asset under the Result Bodycopies folder.

Parameters
string$namethe name of the bodycopy
string$link_valuethe required link value
Returns
boolean protected

Definition at line 616 of file page_decision_tree.inc.

generateJS (   $question)

Generated all the javascript code required to dynamically go through the decision path. Makes use of AJAX requests. The JS reset_questions() function depends on some data from the first question

Parameters
Decision_Tree_Question$questionthe first question
Returns
void public

Definition at line 327 of file page_decision_tree.inc.

& getBodycopy (   $name = '',
  $type = '' 
)

returns a reference to a bodycopy based of the name of the bodycopy and the type (i.e the folder is type_formats or result_bodycopies)

Parameters
string$namethe name of the bodycopy
string$typethe type of the bodycopy
Returns
object public

Definition at line 569 of file page_decision_tree.inc.

& getFolder (   $type = 'type_formats')

Return a reference to a folder linked to this asset determined by the passed in value on the link

Parameters
string$typethe value on the link for this folder
Returns
object public

Definition at line 522 of file page_decision_tree.inc.

getPageContentsKeywordReplacement (   $keyword)

Get a replacement for a keyword used in the Page Contents of this asset

If no suitable replacement exists, the function will return NULL instead.

Parameters
string$keywordThe keyword to replace
Returns
mixed string|NULL

Definition at line 695 of file page_decision_tree.inc.

getTypeFormatKeywordReplacement (   $keyword,
  $question_asset 
)

Get a replacement for a keyword used in the type format bodycopies

If no suitable replacement exists, the function will return NULL instead.

Parameters
string$keywordThe keyword to replace
Returns
mixed string|NULL

Definition at line 651 of file page_decision_tree.inc.

isDeletableLink (   $linkid)

Returns TRUE if we can delete the passed link, or a string with the error msg

Parameters
int$linkidthe link id of the link to remove
Returns
mixed boolean|string public

Definition at line 125 of file page_decision_tree.inc.

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

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

Parameters
object&$broadcasterthe asset that triggered the event
array$varsthe vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array
Returns
boolean private

Definition at line 782 of file page_decision_tree.inc.

printBody ( )

Called by the design to print the body of this asset

It's up to the kids to override

Returns
void public

Definition at line 175 of file page_decision_tree.inc.

printFrontendAsset ( Asset  $asset,
  $design = NULL 
)

Paint the passed asset on the frontend Override printFrontend() if you wish to pass a different asset to print

Parameters
Asset&$assetthe asset to print in frontend
mixed$designthe design to print the asset with
Returns
void public

Definition at line 149 of file page_decision_tree.inc.

printNextStep (   $question_id,
  $answer,
  $total_points 
)

Called by printBody() everytime there is an AJAX request to get the next question

Parameters
int$question_idthe question asset id we are answering
string$answerthe answer value of $question_id
int$total_pointsthe total points accumulated upto this point
Returns
void public

Definition at line 225 of file page_decision_tree.inc.


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