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

Public Member Functions

 __construct ($assetid=0)
 
 setAttrValue ($name, $value)
 
 printBody ()
 
 onRequestKeywords (Asset $broadcaster, Array $vars=Array())
 
 paintAssetFromId ($assetid=0)
 
 paint (Asset $asset)
 
 getFolder ($type='type_formats')
 
 getFormats ($type='type_formats')
 
 createTypeFormatBodycopy ($type)
 
- Public Member Functions inherited from Page_Standard
 __construct ($assetid=0)
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 isDeletableLink ($linkid)
 
 _getAllowedLinks ()
 
 paintBackend (Backend_Outputter $o)
 
 printBody ()
 
 initLimbo ()
 
 getContent ()
 
 lockTypes ()
 
 getEditingLocks (Array $keywords)
 
 getBodycopy ()
 
 getCustomKeywordReplacements ($keywords, $invoke_backend=FALSE)
 
 processCustomKeywords (Array $keywords)
 
- 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)
 
 _getAssetToPaint ()
 
_getKeywordReplacements ($keywords, &$asset)
 
 _getBodycopyFromAssetTypeCode ($asset_type_code)
 
- Protected Member Functions inherited from Page_Standard
 _createAdditional (Array &$link, $args=Array())
 
- 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 40 of file paint_layout_page.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 50 of file paint_layout_page.inc.

Member Function Documentation

_createAdditional ( Array &  $link)
protected

Perform any additional processing required during the creation of this asset

Asset listings create bopycopy and folder asset when they are created

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

Definition at line 68 of file paint_layout_page.inc.

_getAssetToPaint ( )
protected

Returns the id of the asset to paint.

Returns
int private

Definition at line 219 of file paint_layout_page.inc.

_getBodycopyFromAssetTypeCode (   $asset_type_code)
protected

Returns a reference to the format bodycopy corresponding to $asset_type_code

Parameters
string$asset_type_codetype of the asset to represent
Returns
Bodycopy private

Definition at line 310 of file paint_layout_page.inc.

& _getKeywordReplacements (   $keywords,
$asset 
)
protected

Returns replacements for the page bodycopy keywords (array of keyword => value)

Parameters
array$keywordsthe keywords to replace
object&$assetthe asset to represent
Returns
array private

Definition at line 285 of file paint_layout_page.inc.

createTypeFormatBodycopy (   $type)

Create a new type format/bodycopy in the Type Format Folder.

Return TRUE if successful

Parameters
string$typean asset type code that the new type format must implement
Returns
boolean public

Definition at line 403 of file paint_layout_page.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
Folder public

Definition at line 351 of file paint_layout_page.inc.

getFormats (   $type = 'type_formats')

Get a list of all formats of a certain type

The results of this function are cached for the length of the script execution

Parameters
string$typethe value on the link for the formats folder
Returns
array public

Definition at line 375 of file paint_layout_page.inc.

onRequestKeywords ( Asset  $broadcaster,
Array  $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 174 of file paint_layout_page.inc.

paint ( Asset  $asset)

Paints out our layout

Parameters
Asset$assetthe asset that we are going to print the body for
Returns
void public

Definition at line 259 of file paint_layout_page.inc.

paintAssetFromId (   $assetid = 0)

Paint an asset

Parameters
int$assetidthe id of the asset to paint
Returns
void public

Definition at line 240 of file paint_layout_page.inc.

printBody ( )

Called by the design to print the body of this asset

Returns
void public

Definition at line 156 of file paint_layout_page.inc.

setAttrValue (   $name,
  $value 
)

Queue the setting of the value of an attribute

This function sets the value of the attribute locally, but does not database updating. The change is queued awaiting the call of saveAttributes()

Parameters
string$namethe name of the attribute
string$valuethe new value of the attribute
Returns
boolean public
See Also
saveAttributes()

Definition at line 128 of file paint_layout_page.inc.


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