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

Public Member Functions

 __construct ($assetid=0)
 
 _getAllowedLinks ()
 
 _createAdditional (&$link)
 
 _getAvailableKeywordsOfType ($type='')
 
 describeLink ($linkid)
 
 printFrontend ()
 
 _traverseChannel ($channel, $rss_type)
 
 _traverseImage ($image)
 
 validateItems ($items=Array())
 
 validateChannel ($channel=Array())
 
 validateImage ($image=Array())
 
 readAccess ($assetids=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

 _getName ($short_name=FALSE, $contextid=NULL)
 
- 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 31 of file page_rss_feed.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidassetid for the asset

Definition at line 41 of file page_rss_feed.inc.

Member Function Documentation

_createAdditional ( $link)

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 103 of file page_rss_feed.inc.

_getAllowedLinks ( )

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

See Also
Asset::_getAllowLinks()
Returns
array private

Definition at line 84 of file page_rss_feed.inc.

_getAvailableKeywordsOfType (   $type = '')

Function that takes asset type as the argument and returns an array of the avaialble keywords for that asset type

Parameters
string$typethe asset type
Returns
array private

Definition at line 123 of file page_rss_feed.inc.

_getName (   $short_name = FALSE,
  $contextid = NULL 
)
protected

Returns name of the asset

Parameters
boolean$short_namewhether or not we are after the shortname or the full name
int$contextidwhat context to return the name from
Returns
string private
See Also
Asset::_getName()

Definition at line 59 of file page_rss_feed.inc.

_traverseChannel (   $channel,
  $rss_type 
)

Traverses the entered channel array and returns it in the RSS Writer class acceptable format

Parameters
array$channelthe channel information for this feed
string$rss_typethe rss type and version e.g. rss_1.0, atom_1.0
Returns
array private

Definition at line 373 of file page_rss_feed.inc.

_traverseImage (   $image)

Traverses the entered image array and returns it in the RSS Writer class acceptable format

Parameters
array$imagethe image information for this feed
Returns
array private

Definition at line 481 of file page_rss_feed.inc.

describeLink (   $linkid)

Return a human readable description of the passed link

Parameters
int$linkidthe link ID of the link to describe
Returns
string public

Definition at line 144 of file page_rss_feed.inc.

printFrontend ( )

This function looks on converting the channel, image and items arrays into the RSS Feed Writer class acceptable forms adds them to the writer and prints the feed. The Writer class acceptable form of the channel and items arrays is as follows: Array( tag1 => value, tag2 => Array ( 'SUBTAGS' => Array( subtag1 => value, subtag2 => value, ), ), tag3 => Array ( 'ATTRIBUTES' => Array( attr1 => value, attr2 => value, ), ), ) This is explained more clearly with an example in the _traverseChannel function

Returns
void public

Definition at line 182 of file page_rss_feed.inc.

readAccess (   $assetids = Array())

Returns TRUE if at least one of the passed assetids has read access to this asset

Parameters
array$assetidsAn array of user_group and/or user ids to check for read access If the array is empty, the current user will be checked
Returns
boolean public

Definition at line 639 of file page_rss_feed.inc.

validateChannel (   $channel = Array())

Checks if the passed channel information has all of the required tags or not and returns TRUE if yes

Parameters
array$channelchannel info that the user has created for this feed
Returns
boolean public

Definition at line 567 of file page_rss_feed.inc.

validateImage (   $image = Array())

Checks if the passed image information has all of the required tags or not and returns TRUE if yes

Parameters
array$imageimage info that the user has created for this feed
Returns
boolean public

Definition at line 604 of file page_rss_feed.inc.

validateItems (   $items = Array())

Checks if the passed items have all of the required tags or not and returns TRUE if yes

Parameters
array$itemsitems that the user has created for this feed
Returns
boolean public

Definition at line 510 of file page_rss_feed.inc.


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