Merge branch 'burzum-docs' into 2.0

This commit is contained in:
Jose Lorenzo Rodriguez 2011-10-15 12:46:33 -04:30
commit 3ed712e745
11 changed files with 86 additions and 86 deletions

View file

@ -217,7 +217,7 @@ class Helper extends Object {
* the reverse routing features of CakePHP.
* @param boolean $full If true, the full base URL will be prepended to the result
* @return string Full translated URL with base path.
* @link http://book.cakephp.org/view/1448/url
* @link http://book.cakephp.org/2.0/en/views/helpers.html
*/
public function url($url = null, $full = false) {
return h(Router::url($url, $full));

View file

@ -26,7 +26,7 @@ App::uses('AppHelper', 'View/Helper');
* called by View, and use the $cacheAction settings set in the controller.
*
* @package Cake.View.Helper
* @link http://book.cakephp.org/view/1376/Cache
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/cache.html
*/
class CacheHelper extends AppHelper {

View file

@ -28,7 +28,7 @@ App::uses('AppHelper', 'View/Helper');
*
* @package Cake.View.Helper
* @property HtmlHelper $Html
* @link http://book.cakephp.org/view/1383/Form
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html
*/
class FormHelper extends AppHelper {
@ -312,7 +312,7 @@ class FormHelper extends AppHelper {
* @param string $model The model object which the form is being defined for
* @param array $options An array of html attributes and options.
* @return string An formatted opening FORM tag.
* @link http://book.cakephp.org/view/1384/Creating-Forms
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-create
*/
public function create($model = null, $options = array()) {
$created = $id = false;
@ -487,7 +487,7 @@ class FormHelper extends AppHelper {
*
* @param mixed $options as a string will use $options as the value of button,
* @return string a closing FORM tag optional submit button.
* @link http://book.cakephp.org/view/1389/Closing-the-Form
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#closing-the-form
*/
public function end($options = null) {
$out = null;
@ -628,7 +628,7 @@ class FormHelper extends AppHelper {
*
* @param string $field This should be "Modelname.fieldname"
* @return boolean If there are errors this method returns true, else false.
* @link http://book.cakephp.org/view/1426/isFieldError
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::isFieldError
*/
public function isFieldError($field) {
$this->setEntity($field);
@ -650,7 +650,7 @@ class FormHelper extends AppHelper {
* If array contains `attributes` key it will be used as options for error container
* @param array $options Rendering options for <div /> wrapper tag
* @return string If there are errors this method returns an error message, otherwise null.
* @link http://book.cakephp.org/view/1423/error
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::error
*/
public function error($field, $text = null, $options = array()) {
$defaults = array('wrap' => true, 'class' => 'error-message', 'escape' => true);
@ -735,7 +735,7 @@ class FormHelper extends AppHelper {
* @param string $text Text that will appear in the label field.
* @param mixed $options An array of HTML attributes, or a string, to be used as a class name.
* @return string The formatted LABEL element
* @link http://book.cakephp.org/view/1427/label
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::label
*/
public function label($fieldName = null, $text = null, $options = array()) {
if (empty($fieldName)) {
@ -894,7 +894,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName This should be "Modelname.fieldname"
* @param array $options Each type of input takes different options.
* @return string Completed form widget.
* @link http://book.cakephp.org/view/1390/Automagic-Form-Elements
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#creating-form-elements
*/
public function input($fieldName, $options = array()) {
$this->setEntity($fieldName);
@ -1197,7 +1197,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Name of a field, like this "Modelname.fieldname"
* @param array $options Array of HTML attributes.
* @return string An HTML text input element.
* @link http://book.cakephp.org/view/1414/checkbox
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
*/
public function checkbox($fieldName, $options = array()) {
$valueOptions = array();
@ -1251,7 +1251,7 @@ class FormHelper extends AppHelper {
* @param array $options Radio button options array.
* @param array $attributes Array of HTML attributes, and special attributes above.
* @return string Completed radio widget set.
* @link http://book.cakephp.org/view/1429/radio
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
*/
public function radio($fieldName, $options = array(), $attributes = array()) {
$attributes = $this->_initInputField($fieldName, $attributes);
@ -1377,7 +1377,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Name of a field, in the form "Modelname.fieldname"
* @param array $options Array of HTML attributes, and special options above.
* @return string A generated HTML text input element
* @link http://book.cakephp.org/view/1433/textarea
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::textarea
*/
public function textarea($fieldName, $options = array()) {
$options = $this->_initInputField($fieldName, $options);
@ -1399,7 +1399,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Name of a field, in the form of "Modelname.fieldname"
* @param array $options Array of HTML attributes.
* @return string A generated hidden input
* @link http://book.cakephp.org/view/1425/hidden
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hidden
*/
public function hidden($fieldName, $options = array()) {
$secure = true;
@ -1425,7 +1425,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Name of a field, in the form "Modelname.fieldname"
* @param array $options Array of HTML attributes.
* @return string A generated file input.
* @link http://book.cakephp.org/view/1424/file
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::file
*/
public function file($fieldName, $options = array()) {
$options += array('secure' => true);
@ -1453,7 +1453,7 @@ class FormHelper extends AppHelper {
* @param string $title The button's caption. Not automatically HTML encoded
* @param array $options Array of options and HTML attributes.
* @return string A HTML button tag.
* @link http://book.cakephp.org/view/1415/button
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::button
*/
public function button($title, $options = array()) {
$options += array('type' => 'submit', 'escape' => false, 'secure' => false);
@ -1578,7 +1578,7 @@ class FormHelper extends AppHelper {
* OR if the first character is not /, image is relative to webroot/img.
* @param array $options Array of options. See above.
* @return string A HTML submit button
* @link http://book.cakephp.org/view/1431/submit
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::submit
*/
public function submit($caption = null, $options = array()) {
if (!is_string($caption) && empty($caption)) {
@ -1698,7 +1698,7 @@ class FormHelper extends AppHelper {
* SELECT element
* @param array $attributes The HTML attributes of the select element.
* @return string Formatted SELECT element
* @link http://book.cakephp.org/view/1430/select
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#options-for-select-checkbox-and-radio-inputs
*/
public function select($fieldName, $options = array(), $attributes = array()) {
$select = array();
@ -1810,7 +1810,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Prefix name for the SELECT element
* @param array $attributes HTML attributes for the select element
* @return string A generated day select box.
* @link http://book.cakephp.org/view/1419/day
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::day
*/
public function day($fieldName = null, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -1840,7 +1840,7 @@ class FormHelper extends AppHelper {
* @param integer $maxYear Last year in sequence
* @param array $attributes Attribute array for the select elements.
* @return string Completed year select input
* @link http://book.cakephp.org/view/1416/year
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::year
*/
public function year($fieldName, $minYear = null, $maxYear = null, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -1892,7 +1892,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Prefix name for the SELECT element
* @param array $attributes Attributes for the select element
* @return string A generated month select dropdown.
* @link http://book.cakephp.org/view/1417/month
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::month
*/
public function month($fieldName, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -1928,7 +1928,7 @@ class FormHelper extends AppHelper {
* @param boolean $format24Hours True for 24 hours format
* @param array $attributes List of HTML attributes
* @return string Completed hour select input
* @link http://book.cakephp.org/view/1420/hour
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::hour
*/
public function hour($fieldName, $format24Hours = false, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -1962,7 +1962,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Prefix name for the SELECT element
* @param string $attributes Array of Attributes
* @return string Completed minute select input.
* @link http://book.cakephp.org/view/1421/minute
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::minute
*/
public function minute($fieldName, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -2022,7 +2022,7 @@ class FormHelper extends AppHelper {
* @param string $fieldName Prefix name for the SELECT element
* @param string $attributes Array of Attributes
* @return string Completed meridian select input
* @link http://book.cakephp.org/view/1422/meridian
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::meridian
*/
public function meridian($fieldName, $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);
@ -2071,7 +2071,7 @@ class FormHelper extends AppHelper {
* @param string $timeFormat 12, 24.
* @param string $attributes array of Attributes
* @return string Generated set of select boxes for the date and time formats chosen.
* @link http://book.cakephp.org/view/1418/dateTime
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/form.html#FormHelper::dateTime
*/
public function dateTime($fieldName, $dateFormat = 'DMY', $timeFormat = '12', $attributes = array()) {
$attributes += array('empty' => true, 'value' => null);

View file

@ -25,7 +25,7 @@ App::uses('AppHelper', 'View/Helper');
* HtmlHelper encloses all methods needed while working with HTML pages.
*
* @package Cake.View.Helper
* @link http://book.cakephp.org/view/1434/HTML
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html
*/
class HtmlHelper extends AppHelper {
/**
@ -202,7 +202,7 @@ class HtmlHelper extends AppHelper {
*
* @param string $type Doctype to use.
* @return string Doctype string
* @link http://book.cakephp.org/view/1439/docType
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::docType
*/
public function docType($type = 'xhtml-strict') {
if (isset($this->_docTypes[$type])) {
@ -223,7 +223,7 @@ class HtmlHelper extends AppHelper {
* @param array $options Other attributes for the generated tag. If the type attribute is html,
* rss, atom, or icon, the mime-type is returned.
* @return string A completed `<link />` element.
* @link http://book.cakephp.org/view/1438/meta
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::meta
*/
public function meta($type, $url = null, $options = array()) {
$inline = isset($options['inline']) ? $options['inline'] : true;
@ -287,7 +287,7 @@ class HtmlHelper extends AppHelper {
* @param string $charset The character set to be used in the meta tag. If empty,
* The App.encoding value will be used. Example: "utf-8".
* @return string A meta tag containing the specified character set.
* @link http://book.cakephp.org/view/1436/charset
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::charset
*/
public function charset($charset = null) {
if (empty($charset)) {
@ -315,7 +315,7 @@ class HtmlHelper extends AppHelper {
* @param array $options Array of HTML attributes.
* @param string $confirmMessage JavaScript confirmation message.
* @return string An `<a />` element.
* @link http://book.cakephp.org/view/1442/link
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::link
*/
public function link($title, $url = null, $options = array(), $confirmMessage = false) {
$escapeTitle = true;
@ -383,7 +383,7 @@ class HtmlHelper extends AppHelper {
* @param string $rel Rel attribute. Defaults to "stylesheet". If equal to 'import' the stylesheet will be imported.
* @param array $options Array of HTML attributes.
* @return string CSS <link /> or <style /> tag, depending on the type of link.
* @link http://book.cakephp.org/view/1437/css
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::css
*/
public function css($path, $rel = null, $options = array()) {
$options += array('inline' => true);
@ -467,7 +467,7 @@ class HtmlHelper extends AppHelper {
* @param mixed $options Array of options, and html attributes see above. If boolean sets $options['inline'] = value
* @return mixed String of `<script />` tags or null if $inline is false or if $once is true and the file has been
* included before.
* @link http://book.cakephp.org/view/1589/script
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::script
*/
public function script($url, $options = array()) {
if (is_bool($options)) {
@ -524,7 +524,7 @@ class HtmlHelper extends AppHelper {
* @param string $script The script to wrap
* @param array $options The options to use.
* @return mixed string or null depending on the value of `$options['inline']`
* @link http://book.cakephp.org/view/1604/scriptBlock
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::scriptBlock
*/
public function scriptBlock($script, $options = array()) {
$options += array('safe' => true, 'inline' => true);
@ -554,7 +554,7 @@ class HtmlHelper extends AppHelper {
*
* @param array $options Options for the code block.
* @return void
* @link http://book.cakephp.org/view/1605/scriptStart
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::scriptStart
*/
public function scriptStart($options = array()) {
$options += array('safe' => true, 'inline' => true);
@ -569,7 +569,7 @@ class HtmlHelper extends AppHelper {
* used when the scriptBlock was started
*
* @return mixed depending on the settings of scriptStart() either a script tag or null
* @link http://book.cakephp.org/view/1606/scriptEnd
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::scriptEnd
*/
public function scriptEnd() {
$buffer = ob_get_clean();
@ -593,7 +593,7 @@ class HtmlHelper extends AppHelper {
* @param array $data Style data array, keys will be used as property names, values as property values.
* @param boolean $oneline Whether or not the style block should be displayed on one line.
* @return string CSS styling data
* @link http://book.cakephp.org/view/1440/style
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::style
*/
public function style($data, $oneline = true) {
if (!is_array($data)) {
@ -689,7 +689,7 @@ class HtmlHelper extends AppHelper {
* @param string $path Path to the image file, relative to the app/webroot/img/ directory.
* @param array $options Array of HTML attributes.
* @return string completed img tag
* @link http://book.cakephp.org/view/1441/image
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::image
*/
public function image($path, $options = array()) {
if (is_array($path)) {
@ -726,7 +726,7 @@ class HtmlHelper extends AppHelper {
* @param array $trOptions HTML options for TR elements.
* @param array $thOptions HTML options for TH elements.
* @return string Completed table headers
* @link http://book.cakephp.org/view/1446/tableHeaders
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::tableHeaders
*/
public function tableHeaders($names, $trOptions = null, $thOptions = null) {
$out = array();
@ -746,7 +746,7 @@ class HtmlHelper extends AppHelper {
* @param boolean $continueOddEven If false, will use a non-static $count variable,
* so that the odd/even count is reset to zero just for that call.
* @return string Formatted HTML
* @link http://book.cakephp.org/view/1447/tableCells
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::tableCells
*/
public function tableCells($data, $oddTrOptions = null, $evenTrOptions = null, $useCount = false, $continueOddEven = true) {
if (empty($data[0]) || !is_array($data[0])) {
@ -802,7 +802,7 @@ class HtmlHelper extends AppHelper {
* If null, only a start tag will be printed
* @param array $options Additional HTML attributes of the DIV tag, see above.
* @return string The formatted tag element
* @link http://book.cakephp.org/view/1443/tag
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::tag
*/
public function tag($name, $text = null, $options = array()) {
if (is_array($options) && isset($options['escape']) && $options['escape']) {
@ -852,7 +852,7 @@ class HtmlHelper extends AppHelper {
* If null, only a start tag will be printed
* @param array $options Additional HTML attributes of the DIV tag
* @return string The formatted DIV element
* @link http://book.cakephp.org/view/1444/div
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::div
*/
public function div($class = null, $text = null, $options = array()) {
if (!empty($class)) {
@ -872,7 +872,7 @@ class HtmlHelper extends AppHelper {
* @param string $text String content that will appear inside the p element.
* @param array $options Additional HTML attributes of the P tag
* @return string The formatted P element
* @link http://book.cakephp.org/view/1445/para
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/html.html#HtmlHelper::para
*/
public function para($class, $text, $options = array()) {
if (isset($options['escape'])) {

View file

@ -27,7 +27,7 @@ App::uses('AppHelper', 'View/Helper');
* Methods to make numbers more readable.
*
* @package Cake.View.Helper
* @link http://book.cakephp.org/view/1452/Number
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html
*/
class NumberHelper extends AppHelper {
@ -68,7 +68,7 @@ class NumberHelper extends AppHelper {
* @param float $number A floating point number.
* @param integer $precision The precision of the returned number.
* @return float Formatted float.
* @link http://book.cakephp.org/view/1454/precision
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::precision
*/
public function precision($number, $precision = 3) {
return sprintf("%01.{$precision}f", $number);
@ -79,7 +79,7 @@ class NumberHelper extends AppHelper {
*
* @param integer $size Size in bytes
* @return string Human readable size
* @link http://book.cakephp.org/view/1456/toReadableSize
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::toReadableSize
*/
public function toReadableSize($size) {
switch (true) {
@ -102,7 +102,7 @@ class NumberHelper extends AppHelper {
* @param float $number A floating point number
* @param integer $precision The precision of the returned number
* @return string Percentage string
* @link http://book.cakephp.org/view/1455/toPercentage
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::toPercentage
*/
public function toPercentage($number, $precision = 2) {
return $this->precision($number, $precision) . '%';
@ -115,7 +115,7 @@ class NumberHelper extends AppHelper {
* @param integer $options if int then places, if string then before, if (,.-) then use it
* or array with places and before keys
* @return string formatted number
* @link http://book.cakephp.org/view/1457/format
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::format
*/
public function format($number, $options = false) {
$places = 0;
@ -172,7 +172,7 @@ class NumberHelper extends AppHelper {
* set at least 'before' and 'after' options.
* @param array $options
* @return string Number formatted as a currency.
* @link http://book.cakephp.org/view/1453/currency
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/number.html#NumberHelper::currency
*/
public function currency($number, $currency = 'USD', $options = array()) {
$default = $this->_currencyDefaults;

View file

@ -26,7 +26,7 @@ App::uses('AppHelper', 'View/Helper');
*
* @package Cake.View.Helper
* @property HtmlHelper $Html
* @link http://book.cakephp.org/view/1458/Paginator
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/paginator.html
*/
class PaginatorHelper extends AppHelper {

View file

@ -25,7 +25,7 @@ App::uses('Xml', 'Utility');
*
* @package Cake.View.Helper
* @property TimeHelper $Time
* @link http://book.cakephp.org/view/1460/RSS
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/rss.html
*/
class RssHelper extends AppHelper {

View file

@ -26,7 +26,7 @@ App::uses('CakeSession', 'Model/Datasource');
* Session reading from the view.
*
* @package Cake.View.Helper
* @link http://book.cakephp.org/view/1465/Session
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html
*/
class SessionHelper extends AppHelper {
@ -38,7 +38,7 @@ class SessionHelper extends AppHelper {
*
* @param string $name the name of the session key you want to read
* @return mixed values from the session vars
* @link http://book.cakephp.org/view/1466/Methods
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#displaying-notifcations-or-flash-messages
*/
public function read($name = null) {
return CakeSession::read($name);
@ -51,7 +51,7 @@ class SessionHelper extends AppHelper {
*
* @param string $name
* @return boolean
* @link http://book.cakephp.org/view/1466/Methods
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#displaying-notifcations-or-flash-messages
*/
public function check($name) {
return CakeSession::check($name);
@ -63,7 +63,7 @@ class SessionHelper extends AppHelper {
* In your view: `$this->Session->error();`
*
* @return string last error
* @link http://book.cakephp.org/view/1466/Methods
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#displaying-notifcations-or-flash-messages
*/
public function error() {
return CakeSession::error();
@ -104,8 +104,8 @@ class SessionHelper extends AppHelper {
* @param array $attrs Additional attributes to use for the creation of this flash message.
* Supports the 'params', and 'element' keys that are used in the helper.
* @return string
* @link http://book.cakephp.org/view/1466/Methods
* @link http://book.cakephp.org/view/1467/flash
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#displaying-notifcations-or-flash-messages
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#SessionHelper::flash
*/
public function flash($key = 'flash', $attrs = array()) {
$out = false;

View file

@ -34,7 +34,7 @@ App::uses('Multibyte', 'I18n');
*
* @package Cake.View.Helper
* @property HtmlHelper $Html
* @link http://book.cakephp.org/view/1469/Text
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html
*/
class TextHelper extends AppHelper {
@ -58,7 +58,7 @@ class TextHelper extends AppHelper {
* @param string $phrase The phrase that will be searched
* @param array $options An array of html attributes and options.
* @return string The highlighted text
* @link http://book.cakephp.org/view/1469/Text#highlight-1622
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::highlight
*/
public function highlight($text, $phrase, $options = array()) {
if (empty($phrase)) {
@ -102,7 +102,7 @@ class TextHelper extends AppHelper {
*
* @param string $text Text
* @return string The text without links
* @link http://book.cakephp.org/view/1469/Text#stripLinks-1623
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::stripLinks
*/
public function stripLinks($text) {
return preg_replace('|<a\s+[^>]+>|im', '', preg_replace('|<\/a>|im', '', $text));
@ -115,7 +115,7 @@ class TextHelper extends AppHelper {
* @param string $text Text to add links to
* @param array $htmlOptions Array of HTML options.
* @return string The text with links
* @link http://book.cakephp.org/view/1469/Text#autoLinkUrls-1619
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkUrls
*/
public function autoLinkUrls($text, $htmlOptions = array()) {
$this->_linkOptions = $htmlOptions;
@ -170,7 +170,7 @@ class TextHelper extends AppHelper {
* @param string $text Text
* @param array $options Array of HTML options.
* @return string The text with links
* @link http://book.cakephp.org/view/1469/Text#autoLinkEmails-1618
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLinkEmails
*/
public function autoLinkEmails($text, $options = array()) {
$this->_linkOptions = $options;
@ -188,7 +188,7 @@ class TextHelper extends AppHelper {
* @param string $text Text
* @param array $options Array of HTML options.
* @return string The text with links
* @link http://book.cakephp.org/view/1469/Text#autoLink-1620
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::autoLink
*/
public function autoLink($text, $options = array()) {
return $this->autoLinkEmails($this->autoLinkUrls($text, $options), $options);
@ -210,7 +210,7 @@ class TextHelper extends AppHelper {
* @param integer $length Length of returned string, including ellipsis.
* @param array $options An array of html attributes and options.
* @return string Trimmed string.
* @link http://book.cakephp.org/view/1469/Text#truncate-1625
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::truncate
*/
public function truncate($text, $length = 100, $options = array()) {
$default = array(
@ -314,7 +314,7 @@ class TextHelper extends AppHelper {
* @param integer $radius The amount of characters that will be returned on each side of the founded phrase
* @param string $ending Ending that will be appended
* @return string Modified string
* @link http://book.cakephp.org/view/1469/Text#excerpt-1621
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::excerpt
*/
public function excerpt($text, $phrase, $radius = 100, $ending = '...') {
if (empty($text) or empty($phrase)) {
@ -359,7 +359,7 @@ class TextHelper extends AppHelper {
* @param string $and The word used to join the last and second last items together with. Defaults to 'and'
* @param string $separator The separator used to join all othe other items together. Defaults to ', '
* @return string The glued together string.
* @link http://book.cakephp.org/view/1469/Text#toList-1624
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/text.html#TextHelper::toList
*/
public function toList($list, $and = 'and', $separator = ', ') {
if (count($list) > 1) {

View file

@ -25,7 +25,7 @@ App::uses('AppHelper', 'View/Helper');
* Manipulation of time data.
*
* @package Cake.View.Helper
* @link http://book.cakephp.org/view/1470/Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html
*/
class TimeHelper extends AppHelper {
@ -196,7 +196,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Parsed timestamp
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function fromString($dateString, $userOffset = null) {
if (empty($dateString)) {
@ -226,7 +226,7 @@ class TimeHelper extends AppHelper {
* @param integer $userOffset User's offset from GMT (in hours)
* @param string $format The format to use. If null, `TimeHelper::$niceFormat` is used
* @return string Formatted date string
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function nice($dateString = null, $userOffset = null, $format = null) {
if ($dateString != null) {
@ -252,7 +252,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Described, relative date string
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function niceShort($dateString = null, $userOffset = null) {
$date = $dateString ? $this->fromString($dateString, $userOffset) : time();
@ -279,7 +279,7 @@ class TimeHelper extends AppHelper {
* @param string $fieldName Name of database field to compare with
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Partial SQL string.
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function daysAsSql($begin, $end, $fieldName, $userOffset = null) {
$begin = $this->fromString($begin, $userOffset);
@ -298,7 +298,7 @@ class TimeHelper extends AppHelper {
* @param string $fieldName Name of database field to compare with
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Partial SQL string.
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function dayAsSql($dateString, $fieldName, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -323,7 +323,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean True if datetime string is within current week
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*/
public function isThisWeek($dateString, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -335,7 +335,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean True if datetime string is within current month
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*/
public function isThisMonth($dateString, $userOffset = null) {
$date = $this->fromString($dateString);
@ -348,7 +348,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean True if datetime string is within current year
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*/
public function isThisYear($dateString, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -361,7 +361,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean True if datetime string was yesterday
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*
*/
public function wasYesterday($dateString, $userOffset = null) {
@ -375,7 +375,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean True if datetime string was yesterday
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*/
public function isTomorrow($dateString, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -388,7 +388,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString
* @param boolean $range if true returns a range in Y-m-d format
* @return boolean True if datetime string is within current week
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function toQuarter($dateString, $range = false) {
$time = $this->fromString($dateString);
@ -425,7 +425,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string to be represented as a Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return integer Unix timestamp
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function toUnix($dateString, $userOffset = null) {
return $this->fromString($dateString, $userOffset);
@ -437,7 +437,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Formatted date string
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function toAtom($dateString, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -450,7 +450,7 @@ class TimeHelper extends AppHelper {
* @param string $dateString Datetime string or Unix timestamp
* @param integer $userOffset User's offset from GMT (in hours)
* @return string Formatted date string
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function toRSS($dateString, $userOffset = null) {
$date = $this->fromString($dateString, $userOffset);
@ -491,7 +491,7 @@ class TimeHelper extends AppHelper {
* @param string $dateTime Datetime string or Unix timestamp
* @param array $options Default format if timestamp is used in $dateString
* @return string Relative time string.
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function timeAgoInWords($dateTime, $options = array()) {
$userOffset = null;
@ -657,7 +657,7 @@ class TimeHelper extends AppHelper {
* @param mixed $dateString the datestring or unix timestamp to compare
* @param integer $userOffset User's offset from GMT (in hours)
* @return boolean
* @link http://book.cakephp.org/view/1472/Testing-Time
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#testing-timeview/1472/Testing-Time
*/
public function wasWithinLast($timeInterval, $dateString, $userOffset = null) {
$tmp = str_replace(' ', '', $timeInterval);
@ -680,7 +680,7 @@ class TimeHelper extends AppHelper {
*
* @param string $string Datetime string
* @return string Formatted date string
* @link http://book.cakephp.org/view/1471/Formatting
* @link http://book.cakephp.org/2.0/en/core-libraries/helpers/time.html#formattingview/1471/Formatting
*/
public function gmt($string = null) {
if ($string != null) {

View file

@ -32,8 +32,8 @@ endif;
?>
<p id="url-rewriting-warning" style="background-color:#e32; color:#fff;">
<?php echo __d('cake_dev', 'URL rewriting is not properly configured on your server.'); ?>
1) <a target="_blank" href="http://book.cakephp.org/view/917/Apache-and-mod_rewrite-and-htaccess" style="color:#fff;">Help me configure it</a>
2) <a target="_blank" href="http://book.cakephp.org/view/931/CakePHP-Core-Configuration-Variables" style="color:#fff;">I don't / can't use URL rewriting</a>
1) <a target="_blank" href="http://book.cakephp.org/2.0/en/installation/advanced-installation.html#apache-and-mod-rewrite-and-htaccess" style="color:#fff;">Help me configure it</a>
2) <a target="_blank" href="http://book.cakephp.org/2.0/en/development/configuration.html#cakephp-core-configuration" style="color:#fff;">I don't / can't use URL rewriting</a>
</p>
<p>
<?php
@ -139,7 +139,7 @@ You can also add some CSS styles for your pages at: APP/webroot/css.');
<?php
echo $this->Html->link(
sprintf('<strong>%s</strong> %s', __d('cake_dev', 'New'), __d('cake_dev', 'CakePHP 1.3 Docs')),
'http://book.cakephp.org/view/875/x1-3-Collection',
'http://book.cakephp.org/2.0/en/',
array('target' => '_blank', 'escape' => false)
);
?>
@ -148,7 +148,7 @@ You can also add some CSS styles for your pages at: APP/webroot/css.');
<?php
echo $this->Html->link(
__d('cake_dev', 'The 15 min Blog Tutorial'),
'http://book.cakephp.org/view/1528/Blog',
'http://book.cakephp.org/2.0/en/tutorials-and-examples/blog/blog.html',
array('target' => '_blank', 'escape' => false)
);
?>