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

Public Member Functions

 __construct ($assetid=0)
 
 _updated ()
 
 paintAsset (Asset $asset)
 
 setAssociatedAssetType ($asset_type='')
 
 getAssociatedAssetType ()
 
 getKeywordsDescription (Array &$keywords, $asset_type_code='')
 
 linksUpdated ()
 
- Public Member Functions inherited from Bodycopy
 __construct ($assetid=0)
 
 lockTypes ()
 
 create (Array &$link, $bc_data=Array())
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 _getAllowedLinks ()
 
 processStatusChange ($new_status, $update_parents=TRUE)
 
 paintBackend (Backend_Outputter $o)
 
 printFrontend ()
 
 printBody ()
 
 _getName ($short_name=FALSE, $contextid=NULL)
 
getContainers ()
 
 isEmpty ()
 
 getKeywords ()
 
 getContent ()
 
 getRawBodycopyContent ()
 
 setKeywordReplacements ($replacements=Array())
 
 _compareLink ($current_link, $before_links)
 
 _cleanupSafeEdit ()
 
- 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

 $asset_to_paint = NULL
 
 $conditions_list = NULL
 
 $keyword_replacements = Array()
 
- Data Fields inherited from Bodycopy
 $keyword_replacements = Array()
 
- 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

 _generateContentFile ()
 
 _addRequiredKeywordsFromEvaluatedKeyword ($evaluated_keyword, Array &$required_keywords)
 
 _evaluateKeyword ($keyword_name)
 
 _getKeywordValue ($keyword)
 
_getAssetKeywordReplacements (Asset &$asset, Array $required_keywords)
 
- Protected Member Functions inherited from Bodycopy
 _preCreateCheck (Array $link)
 
 _createAdditional (Array &$link)
 
- 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)
 

Detailed Description

Definition at line 49 of file paint_layout_bodycopy.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 65 of file paint_layout_bodycopy.inc.

Member Function Documentation

_addRequiredKeywordsFromEvaluatedKeyword (   $evaluated_keyword,
Array &  $required_keywords 
)
protected

Add to an array all the keywords which value is needed to evaluate a particular keyword

Parameters
string$evaluated_keywordthe keyword that will be evaluated
array&$required_keywordsthe Array to which the needed keywords will be added
Returns
void private

Definition at line 312 of file paint_layout_bodycopy.inc.

_evaluateKeyword (   $keyword_name)
protected

Returns TRUE if the value of the keyword is not blank. 0 will be evaluated as TRUE.

Parameters
mixed$keyword_namea keyword name
Returns
boolean public

Definition at line 335 of file paint_layout_bodycopy.inc.

_generateContentFile ( )
protected

Generate the content file for this paint layout bodycopy

Returns
void private

Definition at line 98 of file paint_layout_bodycopy.inc.

& _getAssetKeywordReplacements ( Asset $asset,
Array  $required_keywords 
)
protected

Returns the values of a list of keywords. The returned array may contain more keywords than needed.

Parameters
Asset$assetthe asset which will provide the values for the keywords
array$required_keywordskeyword names that must be replaced
Returns
array private

Definition at line 378 of file paint_layout_bodycopy.inc.

_getKeywordValue (   $keyword)
protected

Returns the value of a single keyword

Parameters
string$keywordkeyword name that must be replaced
Returns
string private

Definition at line 356 of file paint_layout_bodycopy.inc.

_updated ( )

Saves the paint layout bodycopy's reusable data to its data directory

Returns
boolean public

Definition at line 79 of file paint_layout_bodycopy.inc.

getAssociatedAssetType ( )

Gets the associated type code

Returns
string public

Definition at line 511 of file paint_layout_bodycopy.inc.

getKeywordsDescription ( Array &  $keywords,
  $asset_type_code = '' 
)

Fill an array with the list of all available keywords

Parameters
array&$keywordsan array to fill
string$asset_type_codethe type of asset which should be represented by this bodycopy.
Returns
void public

Definition at line 527 of file paint_layout_bodycopy.inc.

linksUpdated ( )

This function mainly exists to update the paint layout bodycopy

Returns
boolean public

Definition at line 581 of file paint_layout_bodycopy.inc.

paintAsset ( Asset  $asset)

Returns the body of the painted asset

Parameters
Assetasset the asset to paint
Returns
string public

Definition at line 221 of file paint_layout_bodycopy.inc.

setAssociatedAssetType (   $asset_type = '')

Sets the associated type code

Parameters
string$asset_typeasset type
Returns
void public

Definition at line 498 of file paint_layout_bodycopy.inc.


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