Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Design_Customisation Class Reference
Inheritance diagram for Design_Customisation:
Design Design_Area Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 _getAllowedLinks ()
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 deleteLink ($linkid)
 
 deleteExistingLink ($linkid)
 
 linksUpdated ()
 
 getParentDesign ()
 
 getCustomisedAreas ()
 
 getUnCustomisedAreas ()
 
 updateFromParent (Design $parent, $update_children=TRUE)
 
 paint (Asset $ASSET, Array $FILE_URLS=Array(), Array $CSS_URLS=Array())
 
- Public Member Functions inherited from Design
 __construct ($assetid=0)
 
 cloneComponentsAdditional (Asset $clone, Array $components)
 
 cloneDependantAdditional (Asset $clone)
 
 _getAllowedLinks ()
 
 printFrontend ()
 
 moveLinkPos ($linkid, $sort_order=-1)
 
 linksUpdated ()
 
 prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
 
 createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0')
 
 deleteLink ($linkid)
 
 getAssociatedFile ($filename)
 
 getStylesheets ()
 
 getDesignAreaLink ($id_name='')
 
 getDesignArea ($id_name)
 
 getParentDesign ()
 
 processBackend (Backend_Outputter $o, Array &$link)
 
 updateCustomisations ()
 
 printVar ($var, $args)
 
 paint (Asset $ASSET, Array $FILE_URLS=Array(), Array $CSS_URLS=Array())
 
 generateDesignFile ($do_customisations=TRUE)
 
- Public Member Functions inherited from Design_Area
 __construct ($assetid=0)
 
 _updated ($update_parents=TRUE)
 
 lockTypes ()
 
 processBackend (Backend_Outputter $o, Array &$link)
 
getDesigns ()
 
 getVarReferences ()
 
 setVarReferenceValues (Array $var_ref_values)
 
 attr ($name)
 
 getProtectedAttrs ()
 
 printVar ($var, Array $args)
 
 printInitCode ()
 
 printPaintingCode ()
 
 printAreaCode ()
 
- 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 ()
 

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
 
- Protected Member Functions inherited from Design
 _createAdditional (Array &$link)
 
 _getDesignFileHeader ()
 
 _writeDesignFile ($str)
 
 _setupVarReferences ()
 

Detailed Description

Definition at line 31 of file design_customisation.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file design_customisation.inc.

Member Function Documentation

_getAllowedLinks ( )

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

Returns
array private
See Also
Asset::_getAllowLinks()

Definition at line 55 of file design_customisation.inc.

deleteExistingLink (   $linkid)

Does the actual removing of the link for the customisation

The default deleteLink() replaces the (Type-2) links of any customised design files with a Type-3 to the uncustomised version. This screws things around when creating the customised versions in the first place.

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

Definition at line 216 of file design_customisation.inc.

deleteLink (   $linkid)

Removes a link where this asset is the major player

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

Definition at line 106 of file design_customisation.inc.

getCustomisedAreas ( )

Returns an array of links for design areas that have been customised by this design

Returns
array public

Definition at line 291 of file design_customisation.inc.

getParentDesign ( )

Returns the parent design/design_customisation that this customisation is customising

Returns
Design public

Definition at line 269 of file design_customisation.inc.

getUnCustomisedAreas ( )

Returns an array of links for design areas that have NOT been customised by this design

Returns
array public

Definition at line 338 of file design_customisation.inc.

linksUpdated ( )

Called whenever any type of link is changed, allows caching of objects, links and other stuff to occur but not cause integrity issues during script execution returns true it it's successfull

Returns
void private

Definition at line 253 of file design_customisation.inc.

paint ( Asset  $ASSET,
Array  $FILE_URLS = Array(),
Array  $CSS_URLS = Array() 
)

Paints out our design

Parameters
Asset&$ASSETthe asset that we are going to print the body for
array$FILE_URLSan array of filename => URL to use to print files in the design doesnt need to be passed in unless some URLs are overridden by a customisation of the design
array$CSS_URLSan array of filename => URL to use to print css files in the design
Returns
void public

Definition at line 446 of file design_customisation.inc.

prepareLink ( Asset  $asset,
  $side_of_link,
$link_type,
$value,
$sort_order,
$dependant,
$exclusive 
)

Prepares for linking by checking that the link values are valid for this link

This function will be called if this asset is the major or minor party in the link, so the side_of_link flag should be checked to work out what side of the link this asset is on. The return value should indicate if any of the link fields were changed.

Parameters
Asset$assetthe major or minor asset that we are linking to
string$side_of_linkthe side of the link we are on (major or minor)
string&$link_typethe type of link we are creating
string&$valuethe value that is to be associated with the link
string&$sort_orderthe position in the links list that this link should take,
string&$dependant'0' / '1' on whether the this asset is dependant on the asset that will be linked by the new link
string&$exclusive'0' / '1' on whether the this asset is linked exclusivly to the asset that will be linked by the new link
Returns
boolean public

Definition at line 86 of file design_customisation.inc.

updateFromParent ( Design  $parent,
  $update_children = TRUE 
)

Updates this customisation from our parent, ie. Updates our contents array and the contents arrays for any customised design areas No need to do the uncustomised design areas because they would be done by our parent

Parameters
Design$parentthe parent design for this customisation
bool$update_childrenpass on update to children customisation
Returns
boolean protected

Definition at line 360 of file design_customisation.inc.


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