Class RssHelper
RSS Helper class for easy output RSS structures.
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Link: http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html
Located at Cake/View/Helper/RssHelper.php
Method Detail
channelsource public
channel( array $attrib array() , array $elements array() , string $content null )
Returns an RSS <channel />
element
Parameters
- array
$attrib
optional array() -
<channel />
tag attributes - array
$elements
optional array() - Named array elements which are converted to tags
- string
$content
optional null - Content (
<item />
's belonging to this channel
Returns
string
An RSS
<channel />
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::channeldocumentsource public
document( array $attrib array() , string $content null )
Returns an RSS document wrapped in <rss />
tags
Parameters
- array
$attrib
optional array() -
<rss />
tag attributes - string
$content
optional null - Tag content.
Returns
string
An RSS document
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::documentelemsource public
elem( string $name , array $attrib array() , string|array $content null , boolean $endTag true )
Generates an XML element
Parameters
- string
$name
- The name of the XML element
- array
$attrib
optional array() - The attributes of the XML element
- string|array
$content
optional null - XML element content
- boolean
$endTag
optional true - Whether the end tag of the element should be printed
Returns
string
XML
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::elemitemsource public
item( array $att array() , array $elements array() )
Converts an array into an <item />
element and its contents
Parameters
- array
$att
optional array() - The attributes of the
<item />
element - array
$elements
optional array() - The list of elements contained in this
<item />
Returns
string
An RSS
<item />
elementLink
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::itemitemssource public
items( array $items , string|array $callback null )
Transforms an array of data using an optional callback, and maps it to a set of <item />
tags
Parameters
- array
$items
- The list of items to be mapped
- string|array
$callback
optional null - A string function name, or array containing an object and a string method name
Returns
string
A set of RSS
<item />
elementsLink
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::itemstimesource public
time( integer|string|DateTime $time )
Converts a time in any format to an RSS time
Parameters
- integer|string|DateTime
$time
- UNIX timestamp or valid time string or DateTime object.
Returns
string
An RSS-formatted timestamp
See
TimeHelper::toRSS()
Link
http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html#RssHelper::timeMethods inherited from Helper
__callsource public
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
Parameters
- string
$method
- Method to invoke
- array
$params
- Array of params for the method.
__constructsource public
__construct( View $View , array $settings array() )
Default Constructor
Parameters
-
View
$View
- The View this helper is being attached to.
- array
$settings
optional array() - Configuration settings for the helper.
Overrides
Object::__construct()
__getsource public
__get( string $name )
Lazy loads helpers. Provides access to deprecated request properties as well.
Deprecated
3.0.0 Accessing request properties through this method is deprecated and will be removed in 3.0.Parameters
- string
$name
- Name of the property being accessed.
Returns
mixed
Helper or property found at $name
__setsource public
__set( string $name , mixed $value )
Provides backwards compatibility access for setting values to the request object.
Deprecated
3.0.0 This method will be removed in 3.0Parameters
- string
$name
- Name of the property being accessed.
- mixed
$value
- Value to set.
_confirmsource protected
_confirm( string $message , string $okCode , string $cancelCode '' , array $options array() )
Returns a string to be used as onclick handler for confirm dialogs.
Parameters
- string
$message
- Message to be displayed
- string
$okCode
- Code to be executed after user chose 'OK'
- string
$cancelCode
optional '' - Code to be executed after user chose 'Cancel'
- array
$options
optional array() - Array of options
Returns
string
onclick JS code
_encodeUrlsource protected
_encodeUrl( string $url )
Encodes a URL for use in HTML attributes.
Parameters
- string
$url
- The URL to encode.
Returns
string
The URL encoded for both URL & HTML contexts.
_formatAttributesource protected
_formatAttribute( string $key , string $value , boolean $escape true )
Formats an individual attribute, and returns the string value of the composed attribute. Works with minimized attributes that have the same value as their name such as 'disabled' and 'checked'
Deprecated
3.0.0 This method will be moved to HtmlHelper in 3.0Parameters
- string
$key
- The name of the attribute to create
- string
$value
- The value of the attribute to create.
- boolean
$escape
optional true - Define if the value must be escaped
Returns
string
The composed attribute.
_initInputFieldsource protected
_initInputField( string $field , array $options array() )
Sets the defaults for an input tag. Will set the name, value, and id attributes for an array of html attributes.
Parameters
- string
$field
- The field name to initialize.
- array
$options
optional array() - Array of options to use while initializing an input field.
Returns
array
Array options for the form input.
_namesource protected
_name( array|string $options array() , string $field null , string $key 'name' )
Gets the input field name for the current tag. Creates input name attributes using CakePHP's data[Model][field] formatting.
Parameters
- array|string
$options
optional array() - If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.
- string
$field
optional null - Field name.
- string
$key
optional 'name' - The name of the attribute to be set, defaults to 'name'
Returns
mixed
If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.
_parseAttributessource protected
_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )
Returns a space-delimited string with items of the $options array. If a key of $options array happens to be one of those listed in Helper::$_minimizedAttributes
And its value is one of:
- '1' (string)
- 1 (integer)
- true (boolean)
- 'true' (string)
Then the value will be reset to be identical with key's name. If the value is not one of these 3, the parameter is not output.
'escape' is a special option in that it controls the conversion of attributes to their html-entity encoded equivalents. Set to false to disable html-encoding.
If value for any option key is set to null
or false
, that option will be excluded from output.
Deprecated
3.0.0 This method will be moved to HtmlHelper in 3.0Parameters
- array
$options
- Array of options.
- array
$exclude
optional null - Array of options to be excluded, the options here will not be part of the return.
- string
$insertBefore
optional ' ' - String to be inserted before options.
- string
$insertAfter
optional null - String to be inserted after options.
Returns
string
Composed attributes.
_selectedArraysource protected
_selectedArray( string|array $data , string $key 'id' )
Transforms a recordset from a hasAndBelongsToMany association to a list of selected options for a multiple select element
Parameters
- string|array
$data
- Data array or model name.
- string
$key
optional 'id' - Field name.
Returns
array
array
addClasssource public
addClass( array $options array() , string $class null , string $key 'class' )
Adds the given class to the element options
Parameters
- array
$options
optional array() - Array options/attributes to add a class to
- string
$class
optional null - The class name being added.
- string
$key
optional 'class' - the key to use for class.
Returns
array
Array of options with $key set.
afterLayoutsource public
afterLayout( string $layoutFile )
After layout callback. afterLayout is called after the layout has rendered.
Overridden in subclasses.
Parameters
- string
$layoutFile
- The layout file that was rendered.
afterRendersource public
afterRender( string $viewFile )
After render callback. afterRender is called after the view file is rendered but before the layout has been rendered.
Overridden in subclasses.
Parameters
- string
$viewFile
- The view file that was rendered.
afterRenderFilesource public
afterRenderFile( string $viewFile , string $content )
After render file callback. Called after any view fragment is rendered.
Overridden in subclasses.
Parameters
- string
$viewFile
- The file just be rendered.
- string
$content
- The content that was rendered.
assetTimestampsource public
assetTimestamp( string $path )
Adds a timestamp to a file based resource based on the value of Asset.timestamp
in Configure. If Asset.timestamp is true and debug > 0, or Asset.timestamp === 'force' a timestamp will be added.
Parameters
- string
$path
- The file path to timestamp, the path must be inside WWW_ROOT
Returns
string
Path with a timestamp added, or not.
assetUrlsource public
assetUrl( string|array $path , array $options array() )
Generate URL for given asset file. Depending on options passed provides full URL with domain name. Also calls Helper::assetTimestamp() to add timestamp to local files
Parameters
- string|array
$path
- Path string or URL array
- array
$options
optional array() - Options array. Possible keys:
fullBase
Return full URL with domain namepathPrefix
Path prefix for relative URLsext
Asset extension to appendplugin
False value will prevent parsing path as a plugin
Returns
string
Generated URL
beforeLayoutsource public
beforeLayout( string $layoutFile )
Before layout callback. beforeLayout is called before the layout is rendered.
Overridden in subclasses.
Parameters
- string
$layoutFile
- The layout about to be rendered.
beforeRendersource public
beforeRender( string $viewFile )
Before render callback. beforeRender is called before the view file is rendered.
Overridden in subclasses.
Parameters
- string
$viewFile
- The view file that is going to be rendered
beforeRenderFilesource public
beforeRenderFile( string $viewFile )
Before render file callback. Called before any view fragment is rendered.
Overridden in subclasses.
Parameters
- string
$viewFile
- The file about to be rendered.
cleansource public
clean( string|array $output )
Used to remove harmful tags from content. Removes a number of well known XSS attacks from content. However, is not guaranteed to remove all possibilities. Escaping content is the best way to prevent all possible attacks.
Deprecated
3.0.0 This method will be removed in 3.0Parameters
- string|array
$output
- Either an array of strings to clean or a single string to clean.
Returns
string|array|null
Cleaned content for output
domIdsource public
domId( array|string $options null , string $id 'id' )
Generates a DOM ID for the selected element, if one is not set. Uses the current View::entity() settings to generate a CamelCased id attribute.
Parameters
- array|string
$options
optional null - Either an array of html attributes to add $id into, or a string with a view entity path to get a domId for.
- string
$id
optional 'id' - The name of the 'id' attribute.
Returns
mixed
If $options was an array, an array will be returned with $id set. If a string was supplied, a string will be returned.
entitysource public
entity( )
Returns the entity reference of the current context as an array of identity parts
Returns
array
An array containing the identity elements of an entity
fieldsource public
field( )
Gets the currently-used model field of the rendering context. Strips off field suffixes such as year, month, day, hour, min, meridian when the current entity is longer than 2 elements.
Returns
string
string
modelsource public
model( )
Gets the currently-used model of the rendering context.
Returns
string
string
outputsource public
output( string $str )
Returns a string generated by a helper method
This method can be overridden in subclasses to do generalized output post-processing
Deprecated
3.0.0 This method will be removed in future versions.Parameters
- string
$str
- String to be output.
Returns
string
string
setEntitysource public
setEntity( string $entity , boolean $setScope false )
Sets this helper's model and field properties to the dot-separated value-pair in $entity.
Parameters
- string
$entity
- A field name, like "ModelName.fieldName" or "ModelName.ID.fieldName"
- boolean
$setScope
optional false - Sets the view scope to the model specified in $tagValue
urlsource public
url( string|array $url null , boolean $full false )
Finds URL for specified action.
Returns a URL pointing at the provided parameters.
Parameters
- string|array
$url
optional null - Either a relative string url like
/products/view/23
or an array of URL parameters. Using an array for URLs will allow you to leverage the reverse routing features of CakePHP. - boolean
$full
optional false - If true, the full base URL will be prepended to the result
Returns
string
Full translated URL with base path.
Link
http://book.cakephp.org/2.0/en/views/helpers.htmlvaluesource public
value( array|string $options array() , string $field null , string $key 'value' )
Gets the data for the current tag
Parameters
- array|string
$options
optional array() - If an array, should be an array of attributes that $key needs to be added to. If a string or null, will be used as the View entity.
- string
$field
optional null - Field name.
- string
$key
optional 'value' - The name of the attribute to be set, defaults to 'value'
Returns
mixed
If an array was given for $options, an array with $key set will be returned. If a string was supplied a string will be returned.
webrootsource public
webroot( string $file )
Checks if a file exists when theme is used, if no file is found default location is returned
Parameters
- string
$file
- The file to create a webroot path to.
Returns
string
Web accessible path to file.
Methods inherited from Object
_mergeVarssource protected
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
Parameters
- array
$properties
- The name of the properties to merge.
- string
$class
- The class to merge the property with.
- boolean
$normalize
optional true - Set to true to run the properties through Hash::normalize() before merging.
_setsource protected
_set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
Parameters
- array
$properties
optional array() - An associative array containing properties and corresponding values.
_stopsource protected
_stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- integer|string
$status
optional 0 - see http://php.net/exit for values
dispatchMethodsource public
dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
Parameters
- string
$method
- Name of the method to call
- array
$params
optional array() - Parameter list to use when calling $method
Returns
mixed
Returns the result of the method call
logsource public
log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string
$msg
- Log message
- integer
$type
optional LOG_ERR - Error type constant. Defined in app/Config/core.php.
- null|string|array
$scope
optional null - The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.
Returns
boolean
Success of log write
requestActionsource public
requestAction( string|array $url , array $extra array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
Passing POST and GET data
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
Parameters
- string|array
$url
- String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.
- array
$extra
optional array() - if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.
Returns
mixed
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toStringsource public
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
string
The name of this class
Properties summary
Properties inherited from Helper
$_associationsource
protected string
The name of the current model association entities are in scope of.
See
Helper::setEntity()
$_entityPathsource
protected string
The dot separated list of elements the current field entity is for.
See
Helper::setEntity()
$_fieldSuffixessource
protected array
A list of strings that should be treated as suffixes, or sub inputs for a parent input. This is used for date/time inputs primarily.
array( 'year', 'month', 'day', 'hour', 'min', 'second', 'meridian' )
$_minimizedAttributessource
protected array
Minimized attributes
array( 'allowfullscreen', 'async', 'autofocus', 'autoplay', 'checked', 'compact', 'controls', 'declare', 'default', 'defaultchecked', 'defaultmuted', 'defaultselected', 'defer', 'disabled', 'enabled', 'formnovalidate', 'hidden', 'indeterminate', 'inert', 'ismap', 'itemscope', 'loop', 'multiple', 'muted', 'nohref', 'noresize', 'noshade', 'novalidate', 'nowrap', 'open', 'pauseonexit', 'readonly', 'required', 'reversed', 'scoped', 'seamless', 'selected', 'sortable', 'spellcheck', 'truespeed', 'typemustmatch', 'visible' )
$_modelScopesource
protected string
The name of the current model entities are in scope of.
See
Helper::setEntity()
$fieldsetsource
public array
Holds the fields array('field_name' => array('type' => 'string', 'length' => 100), primaryKey and validates array('field_name')
array()
Magic properties summary
$Timesource
public TimeHelper
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-RssHelper.html