mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 03:18:26 +00:00
Changing @return int to @return integer and @param bool to @param boolean
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@5860 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
parent
1f9136eb18
commit
896f62544b
51 changed files with 140 additions and 141 deletions
|
@ -760,9 +760,9 @@
|
||||||
*
|
*
|
||||||
* Only runs if debug level is non-zero.
|
* Only runs if debug level is non-zero.
|
||||||
*
|
*
|
||||||
* @param bool $var Variable to show debug information for.
|
* @param boolean $var Variable to show debug information for.
|
||||||
* @param bool $showHtml If set to true, the method prints the debug data in a screen-friendly way.
|
* @param boolean $showHtml If set to true, the method prints the debug data in a screen-friendly way.
|
||||||
* @param bool $showFrom If set to true, the method prints from where the function was called.
|
* @param boolean $showFrom If set to true, the method prints from where the function was called.
|
||||||
*/
|
*/
|
||||||
function debug($var = false, $showHtml = false, $showFrom = true) {
|
function debug($var = false, $showHtml = false, $showFrom = true) {
|
||||||
if (Configure::read() > 0) {
|
if (Configure::read() > 0) {
|
||||||
|
@ -953,7 +953,7 @@
|
||||||
*
|
*
|
||||||
* @see debug()
|
* @see debug()
|
||||||
* @param array $var Variable to print out
|
* @param array $var Variable to print out
|
||||||
* @param bool $showFrom If set to true, the method prints from where the function was called
|
* @param boolean $showFrom If set to true, the method prints from where the function was called
|
||||||
*/
|
*/
|
||||||
function pr($var) {
|
function pr($var) {
|
||||||
if (Configure::read() > 0) {
|
if (Configure::read() > 0) {
|
||||||
|
@ -1251,7 +1251,7 @@
|
||||||
* Returns a translated string if one is found, or the submitted message if not found.
|
* Returns a translated string if one is found, or the submitted message if not found.
|
||||||
*
|
*
|
||||||
* @param string $singular Text to translate
|
* @param string $singular Text to translate
|
||||||
* @param bool $return Set to true to return translated string, or false to echo
|
* @param boolean $return Set to true to return translated string, or false to echo
|
||||||
* @return mixed translated string if $return is false string will be echoed
|
* @return mixed translated string if $return is false string will be echoed
|
||||||
*/
|
*/
|
||||||
function __($singular, $return = false) {
|
function __($singular, $return = false) {
|
||||||
|
@ -1274,7 +1274,7 @@
|
||||||
* @param string $singular Singular text to translate
|
* @param string $singular Singular text to translate
|
||||||
* @param string $plural Plural text
|
* @param string $plural Plural text
|
||||||
* @param integer $count Count
|
* @param integer $count Count
|
||||||
* @param bool $return true to return, false to echo
|
* @param boolean $return true to return, false to echo
|
||||||
* @return mixed plural form of translated string if $return is false string will be echoed
|
* @return mixed plural form of translated string if $return is false string will be echoed
|
||||||
*/
|
*/
|
||||||
function __n($singular, $plural, $count, $return = false) {
|
function __n($singular, $plural, $count, $return = false) {
|
||||||
|
@ -1318,7 +1318,7 @@
|
||||||
* @param string $singular Singular string to translate
|
* @param string $singular Singular string to translate
|
||||||
* @param string $plural Plural
|
* @param string $plural Plural
|
||||||
* @param integer $count Count
|
* @param integer $count Count
|
||||||
* @param bool $return true to return, false to echo
|
* @param boolean $return true to return, false to echo
|
||||||
* @return plural form of translated string if $return is false string will be echoed
|
* @return plural form of translated string if $return is false string will be echoed
|
||||||
*/
|
*/
|
||||||
function __dn($domain, $singular, $plural, $count, $return = false) {
|
function __dn($domain, $singular, $plural, $count, $return = false) {
|
||||||
|
@ -1351,7 +1351,7 @@
|
||||||
* @param string $domain Domain
|
* @param string $domain Domain
|
||||||
* @param string $msg Message to translate
|
* @param string $msg Message to translate
|
||||||
* @param integer $category Category
|
* @param integer $category Category
|
||||||
* @param bool $return true to return, false to echo
|
* @param boolean $return true to return, false to echo
|
||||||
* @return translated string if $return is false string will be echoed
|
* @return translated string if $return is false string will be echoed
|
||||||
*/
|
*/
|
||||||
function __dc($domain, $msg, $category, $return = false) {
|
function __dc($domain, $msg, $category, $return = false) {
|
||||||
|
@ -1388,7 +1388,7 @@
|
||||||
* @param string $plural Plural
|
* @param string $plural Plural
|
||||||
* @param integer $count Count
|
* @param integer $count Count
|
||||||
* @param integer $category Category
|
* @param integer $category Category
|
||||||
* @param bool $return true to return, false to echo
|
* @param boolean $return true to return, false to echo
|
||||||
* @return plural form of translated string if $return is false string will be echoed
|
* @return plural form of translated string if $return is false string will be echoed
|
||||||
*/
|
*/
|
||||||
function __dcn($domain, $singular, $plural, $count, $category, $return = false) {
|
function __dcn($domain, $singular, $plural, $count, $category, $return = false) {
|
||||||
|
|
|
@ -377,7 +377,7 @@ class ShellDispatcher {
|
||||||
* Outputs to the stdout filehandle.
|
* Outputs to the stdout filehandle.
|
||||||
*
|
*
|
||||||
* @param string $string String to output.
|
* @param string $string String to output.
|
||||||
* @param bool $newline If true, the outputs gets an added newline.
|
* @param boolean $newline If true, the outputs gets an added newline.
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function stdout($string, $newline = true) {
|
function stdout($string, $newline = true) {
|
||||||
|
|
|
@ -234,7 +234,7 @@ class ErrorHandler extends Object {
|
||||||
* Outputs to the stdout filehandle.
|
* Outputs to the stdout filehandle.
|
||||||
*
|
*
|
||||||
* @param string $string String to output.
|
* @param string $string String to output.
|
||||||
* @param bool $newline If true, the outputs gets an added newline.
|
* @param boolean $newline If true, the outputs gets an added newline.
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function stdout($string, $newline = true) {
|
function stdout($string, $newline = true) {
|
||||||
|
|
|
@ -334,7 +334,7 @@ class Shell extends Object {
|
||||||
* Outputs to the stdout filehandle.
|
* Outputs to the stdout filehandle.
|
||||||
*
|
*
|
||||||
* @param string $string String to output.
|
* @param string $string String to output.
|
||||||
* @param bool $newline If true, the outputs gets an added newline.
|
* @param boolean $newline If true, the outputs gets an added newline.
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function out($string, $newline = true) {
|
function out($string, $newline = true) {
|
||||||
|
@ -366,7 +366,7 @@ class Shell extends Object {
|
||||||
/**
|
/**
|
||||||
* Outputs a series of minus characters to the standard output, acts as a visual separator.
|
* Outputs a series of minus characters to the standard output, acts as a visual separator.
|
||||||
*
|
*
|
||||||
* @param bool $newline If true, the outputs gets an added newline.
|
* @param boolean $newline If true, the outputs gets an added newline.
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function hr($newline = false) {
|
function hr($newline = false) {
|
||||||
|
|
|
@ -229,7 +229,7 @@ class ControllerTask extends Shell {
|
||||||
*
|
*
|
||||||
* @param string $controllerName Controller name
|
* @param string $controllerName Controller name
|
||||||
* @param string $admin Admin route to use
|
* @param string $admin Admin route to use
|
||||||
* @param bool $wannaUseSession Set to true to use sessions, false otherwise
|
* @param boolean $wannaUseSession Set to true to use sessions, false otherwise
|
||||||
* @return string Baked actions
|
* @return string Baked actions
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -329,7 +329,7 @@ class ExtractTask extends Shell{
|
||||||
*
|
*
|
||||||
* @param string $functionName Function name that indicates translatable string (e.g: '__')
|
* @param string $functionName Function name that indicates translatable string (e.g: '__')
|
||||||
* @param integer $shift Number of parameters to shift to find translateable string
|
* @param integer $shift Number of parameters to shift to find translateable string
|
||||||
* @param bool $plural Set to true if function supports plural format, false otherwise
|
* @param boolean $plural Set to true if function supports plural format, false otherwise
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function extended($functionName = '__d', $shift = 0, $plural = false) {
|
function extended($functionName = '__d', $shift = 0, $plural = false) {
|
||||||
|
|
|
@ -253,7 +253,7 @@ class Dispatcher extends Object {
|
||||||
*
|
*
|
||||||
* @param object $controller Controller to invoke
|
* @param object $controller Controller to invoke
|
||||||
* @param array $params Parameters with at least the 'action' to invoke
|
* @param array $params Parameters with at least the 'action' to invoke
|
||||||
* @param bool $missingAction Set to true if missing action should be rendered, false otherwise
|
* @param boolean $missingAction Set to true if missing action should be rendered, false otherwise
|
||||||
* @return string Output as sent by controller
|
* @return string Output as sent by controller
|
||||||
* @access protected
|
* @access protected
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -260,7 +260,7 @@ class Cache extends Object {
|
||||||
/**
|
/**
|
||||||
* Delete all keys from the cache
|
* Delete all keys from the cache
|
||||||
*
|
*
|
||||||
* @param bool $check if true will check expiration, otherwise delete all
|
* @param boolean $check if true will check expiration, otherwise delete all
|
||||||
* @param string $config name of the configuration to use
|
* @param string $config name of the configuration to use
|
||||||
* @return boolean True if the cache was succesfully cleared, false otherwise
|
* @return boolean True if the cache was succesfully cleared, false otherwise
|
||||||
* @access public
|
* @access public
|
||||||
|
@ -385,7 +385,7 @@ class CacheEngine extends Object {
|
||||||
/**
|
/**
|
||||||
* Delete all keys from the cache
|
* Delete all keys from the cache
|
||||||
*
|
*
|
||||||
* @param bool $check if true will check expiration, otherwise delete all
|
* @param boolean $check if true will check expiration, otherwise delete all
|
||||||
* @return boolean True if the cache was succesfully cleared, false otherwise
|
* @return boolean True if the cache was succesfully cleared, false otherwise
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
2
cake/libs/cache/file.php
vendored
2
cake/libs/cache/file.php
vendored
|
@ -173,7 +173,7 @@ class FileEngine extends CacheEngine {
|
||||||
/**
|
/**
|
||||||
* Delete all values from the cache
|
* Delete all values from the cache
|
||||||
*
|
*
|
||||||
* @param bool $check Optional - only delete expired cache items
|
* @param boolean $check Optional - only delete expired cache items
|
||||||
* @return boolean True if the cache was succesfully cleared, false otherwise
|
* @return boolean True if the cache was succesfully cleared, false otherwise
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
2
cake/libs/cache/xcache.php
vendored
2
cake/libs/cache/xcache.php
vendored
|
@ -118,7 +118,7 @@ class XcacheEngine extends CacheEngine {
|
||||||
* This has to be done because xcache_clear_cache() needs to pass Basic Http Auth
|
* This has to be done because xcache_clear_cache() needs to pass Basic Http Auth
|
||||||
* (see xcache.admin configuration settings)
|
* (see xcache.admin configuration settings)
|
||||||
*
|
*
|
||||||
* @param bool Revert changes
|
* @param boolean Revert changes
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __auth($reverse = false) {
|
function __auth($reverse = false) {
|
||||||
|
|
|
@ -364,7 +364,7 @@ class Configure extends Object {
|
||||||
*
|
*
|
||||||
* @param string $content Content to write on file
|
* @param string $content Content to write on file
|
||||||
* @param string $name Name to use for cache file
|
* @param string $name Name to use for cache file
|
||||||
* @param bool $write true if content should be written, false otherwise
|
* @param boolean $write true if content should be written, false otherwise
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __writeConfig($content, $name, $write = true) {
|
function __writeConfig($content, $name, $write = true) {
|
||||||
|
@ -518,7 +518,7 @@ class Configure extends Object {
|
||||||
* If the alternative paths are set in this file
|
* If the alternative paths are set in this file
|
||||||
* they will be added to the paths vars
|
* they will be added to the paths vars
|
||||||
*
|
*
|
||||||
* @param bool $boot Load application bootstrap (if true)
|
* @param boolean $boot Load application bootstrap (if true)
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __loadBootstrap($boot) {
|
function __loadBootstrap($boot) {
|
||||||
|
|
|
@ -210,7 +210,7 @@ class CookieComponent extends Object {
|
||||||
*
|
*
|
||||||
* @param mixed $key
|
* @param mixed $key
|
||||||
* @param mixed $value
|
* @param mixed $value
|
||||||
* @param bool $encrypt
|
* @param boolean $encrypt
|
||||||
* @param string $expires
|
* @param string $expires
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -593,7 +593,7 @@ class EmailComponent extends Object{
|
||||||
* Enter description here...
|
* Enter description here...
|
||||||
*
|
*
|
||||||
* @param string $value
|
* @param string $value
|
||||||
* @param bool $message
|
* @param boolean $message
|
||||||
* @return unknown
|
* @return unknown
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
|
@ -692,7 +692,7 @@ class EmailComponent extends Object{
|
||||||
* Private method for sending data to SMTP connection
|
* Private method for sending data to SMTP connection
|
||||||
*
|
*
|
||||||
* @param string $data data to be sent to SMTP server
|
* @param string $data data to be sent to SMTP server
|
||||||
* @param bool $check check for response from server
|
* @param boolean $check check for response from server
|
||||||
* @return bool
|
* @return bool
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -412,7 +412,7 @@ class Controller extends Object {
|
||||||
* @param mixed $url A string or array-based URL pointing to another location
|
* @param mixed $url A string or array-based URL pointing to another location
|
||||||
* within the app, or an absolute URL
|
* within the app, or an absolute URL
|
||||||
* @param integer $status Optional HTTP status code
|
* @param integer $status Optional HTTP status code
|
||||||
* @param bool $exit If true, exit() will be called after the redirect
|
* @param boolean $exit If true, exit() will be called after the redirect
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function redirect($url, $status = null, $exit = false) {
|
function redirect($url, $status = null, $exit = false) {
|
||||||
|
@ -569,7 +569,7 @@ class Controller extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns number of errors in a submitted FORM.
|
* Returns number of errors in a submitted FORM.
|
||||||
*
|
*
|
||||||
* @return int Number of errors
|
* @return integer Number of errors
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function validate() {
|
function validate() {
|
||||||
|
@ -584,7 +584,7 @@ class Controller extends Object {
|
||||||
/**
|
/**
|
||||||
* Validates a FORM according to the rules set up in the Model.
|
* Validates a FORM according to the rules set up in the Model.
|
||||||
*
|
*
|
||||||
* @return int Number of errors
|
* @return integer Number of errors
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function validateErrors() {
|
function validateErrors() {
|
||||||
|
@ -667,7 +667,7 @@ class Controller extends Object {
|
||||||
* Gets the referring URL of this request
|
* Gets the referring URL of this request
|
||||||
*
|
*
|
||||||
* @param string $default Default URL to use if HTTP_REFERER cannot be read from headers
|
* @param string $default Default URL to use if HTTP_REFERER cannot be read from headers
|
||||||
* @param bool $local If true, restrict referring URLs to local server
|
* @param boolean $local If true, restrict referring URLs to local server
|
||||||
* @return string Referring URL
|
* @return string Referring URL
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -905,7 +905,7 @@ class Controller extends Object {
|
||||||
* @param array $data POST'ed data organized by model and field
|
* @param array $data POST'ed data organized by model and field
|
||||||
* @param mixed $op A string containing an SQL comparison operator, or an array matching operators to fields
|
* @param mixed $op A string containing an SQL comparison operator, or an array matching operators to fields
|
||||||
* @param string $bool SQL boolean operator: AND, OR, XOR, etc.
|
* @param string $bool SQL boolean operator: AND, OR, XOR, etc.
|
||||||
* @param bool $exclusive If true, and $op is an array, fields not included in $op will not be included in the returned conditions
|
* @param boolean $exclusive If true, and $op is an array, fields not included in $op will not be included in the returned conditions
|
||||||
* @return array An array of model conditions
|
* @return array An array of model conditions
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -81,7 +81,7 @@ class File extends Object {
|
||||||
* Constructor
|
* Constructor
|
||||||
*
|
*
|
||||||
* @param string $path Path to file
|
* @param string $path Path to file
|
||||||
* @param bool $create Create file if it does not exist (if true)
|
* @param boolean $create Create file if it does not exist (if true)
|
||||||
* @param integer $mode Mode to apply to the folder holding the file
|
* @param integer $mode Mode to apply to the folder holding the file
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
|
@ -128,7 +128,7 @@ class File extends Object {
|
||||||
* Opens the current file with a given $mode
|
* Opens the current file with a given $mode
|
||||||
*
|
*
|
||||||
* @param string $mode A valid 'fopen' mode string (r|w|a ...)
|
* @param string $mode A valid 'fopen' mode string (r|w|a ...)
|
||||||
* @param bool $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
* @param boolean $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
||||||
* @return boolean True on success, false on failure
|
* @return boolean True on success, false on failure
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -152,7 +152,7 @@ class File extends Object {
|
||||||
*
|
*
|
||||||
* @param string $bytes where to start
|
* @param string $bytes where to start
|
||||||
* @param string $mode
|
* @param string $mode
|
||||||
* @param bool $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
* @param boolean $force If true then the file will be re-opened even if its already opened, otherwise it won't
|
||||||
* @return mixed string on success, false on failure
|
* @return mixed string on success, false on failure
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -381,7 +381,7 @@ class File extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns the Filesize, either in bytes or in human-readable format.
|
* Returns the Filesize, either in bytes or in human-readable format.
|
||||||
*
|
*
|
||||||
* @param bool $humanReadeble Data to write to this File.
|
* @param boolean $humanReadeble Data to write to this File.
|
||||||
* @return string|int filesize as int or as a human-readable string
|
* @return string|int filesize as int or as a human-readable string
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -421,7 +421,7 @@ class File extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns the File's owner.
|
* Returns the File's owner.
|
||||||
*
|
*
|
||||||
* @return int the Fileowner
|
* @return integer the Fileowner
|
||||||
*/
|
*/
|
||||||
function owner() {
|
function owner() {
|
||||||
if ($this->exists()) {
|
if ($this->exists()) {
|
||||||
|
@ -432,7 +432,7 @@ class File extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns the File group.
|
* Returns the File group.
|
||||||
*
|
*
|
||||||
* @return int the Filegroup
|
* @return integer the Filegroup
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function group() {
|
function group() {
|
||||||
|
@ -444,7 +444,7 @@ class File extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns last access time.
|
* Returns last access time.
|
||||||
*
|
*
|
||||||
* @return int timestamp Timestamp of last access time
|
* @return integer timestamp Timestamp of last access time
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function lastAccess() {
|
function lastAccess() {
|
||||||
|
@ -456,7 +456,7 @@ class File extends Object {
|
||||||
/**
|
/**
|
||||||
* Returns last modified time.
|
* Returns last modified time.
|
||||||
*
|
*
|
||||||
* @return int timestamp Timestamp of last modification
|
* @return integer timestamp Timestamp of last modification
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function lastChange() {
|
function lastChange() {
|
||||||
|
|
|
@ -69,8 +69,8 @@ class Flay extends Object{
|
||||||
* Returns given text translated to HTML using the Flay syntax.
|
* Returns given text translated to HTML using the Flay syntax.
|
||||||
*
|
*
|
||||||
* @param string $text String to format
|
* @param string $text String to format
|
||||||
* @param bool $bare Set this to only do <p> transforms and > to >, no typography additions.
|
* @param boolean $bare Set this to only do <p> transforms and > to >, no typography additions.
|
||||||
* @param bool $allowHtml Set this to trim whitespace and disable all HTML
|
* @param boolean $allowHtml Set this to trim whitespace and disable all HTML
|
||||||
* @return string Formatted text
|
* @return string Formatted text
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -93,7 +93,7 @@ class Folder extends Object{
|
||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param string $path Path to folder
|
* @param string $path Path to folder
|
||||||
* @param bool $create Create folder if not found
|
* @param boolean $create Create folder if not found
|
||||||
* @param mixed $mode Mode (CHMOD) to apply to created folder, false to ignore
|
* @param mixed $mode Mode (CHMOD) to apply to created folder, false to ignore
|
||||||
*/
|
*/
|
||||||
function __construct($path = false, $create = false, $mode = false) {
|
function __construct($path = false, $create = false, $mode = false) {
|
||||||
|
@ -139,7 +139,7 @@ class Folder extends Object{
|
||||||
* Returns an array of the contents of the current directory, or false on failure.
|
* Returns an array of the contents of the current directory, or false on failure.
|
||||||
* The returned array holds two arrays: one of dirs and one of files.
|
* The returned array holds two arrays: one of dirs and one of files.
|
||||||
*
|
*
|
||||||
* @param bool $sort
|
* @param boolean $sort
|
||||||
* @param mixed $exceptions either an array or boolean true will no grab dot files
|
* @param mixed $exceptions either an array or boolean true will no grab dot files
|
||||||
* @return mixed Contents of current directory as an array, false on failure
|
* @return mixed Contents of current directory as an array, false on failure
|
||||||
* @access public
|
* @access public
|
||||||
|
@ -365,7 +365,7 @@ class Folder extends Object{
|
||||||
*
|
*
|
||||||
* @param string $pathname The directory structure to create
|
* @param string $pathname The directory structure to create
|
||||||
* @param integer $mode octal value 0755
|
* @param integer $mode octal value 0755
|
||||||
* @param bool $recursive chmod recursively
|
* @param boolean $recursive chmod recursively
|
||||||
* @param array $exceptions array of files, directories to skip
|
* @param array $exceptions array of files, directories to skip
|
||||||
* @return boolean Returns TRUE on success, FALSE on failure
|
* @return boolean Returns TRUE on success, FALSE on failure
|
||||||
* @access public
|
* @access public
|
||||||
|
|
|
@ -784,7 +784,7 @@ class HttpSocket extends CakeSocket {
|
||||||
/**
|
/**
|
||||||
* Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
|
* Gets escape chars according to RFC 2616 (HTTP 1.1 specs).
|
||||||
*
|
*
|
||||||
* @param bool $hex true to get them as HEX values, false otherwise
|
* @param boolean $hex true to get them as HEX values, false otherwise
|
||||||
* @return array Escape chars
|
* @return array Escape chars
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
|
@ -808,7 +808,7 @@ class HttpSocket extends CakeSocket {
|
||||||
* Resets the state of this HttpSocket instance to it's initial state (before Object::__construct got executed) or does
|
* Resets the state of this HttpSocket instance to it's initial state (before Object::__construct got executed) or does
|
||||||
* the same thing partially for the request and the response property only.
|
* the same thing partially for the request and the response property only.
|
||||||
*
|
*
|
||||||
* @param bool $full If set to false only HttpSocket::response and HttpSocket::request are reseted
|
* @param boolean $full If set to false only HttpSocket::response and HttpSocket::request are reseted
|
||||||
* @return boolean True on success
|
* @return boolean True on success
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -163,7 +163,7 @@ class I18n extends Object {
|
||||||
*
|
*
|
||||||
* @param string $type Type
|
* @param string $type Type
|
||||||
* @param integrer $n Number
|
* @param integrer $n Number
|
||||||
* @return int plural match
|
* @return integer plural match
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __pluralGuess(&$type, $n) {
|
function __pluralGuess(&$type, $n) {
|
||||||
|
|
|
@ -82,7 +82,7 @@ class AclBehavior extends ModelBehavior {
|
||||||
/**
|
/**
|
||||||
* Creates a new ARO/ACO node bound to this record
|
* Creates a new ARO/ACO node bound to this record
|
||||||
*
|
*
|
||||||
* @param bool $created True if this is a new record
|
* @param boolean $created True if this is a new record
|
||||||
*/
|
*/
|
||||||
function afterSave(&$model, $created) {
|
function afterSave(&$model, $created) {
|
||||||
if ($created) {
|
if ($created) {
|
||||||
|
|
|
@ -320,7 +320,7 @@ class TranslateBehavior extends ModelBehavior {
|
||||||
*
|
*
|
||||||
* @param object instance of model
|
* @param object instance of model
|
||||||
* @param mixed string with field, or array(field1, field2=>AssocName, field3), or null for bind all original translations
|
* @param mixed string with field, or array(field1, field2=>AssocName, field3), or null for bind all original translations
|
||||||
* @param bool $reset
|
* @param boolean $reset
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
function bindTranslation(&$model, $fields = null, $reset = true) {
|
function bindTranslation(&$model, $fields = null, $reset = true) {
|
||||||
|
|
|
@ -61,7 +61,7 @@ class TreeBehavior extends ModelBehavior {
|
||||||
* parameters to be saved.
|
* parameters to be saved.
|
||||||
*
|
*
|
||||||
* @param AppModel $model
|
* @param AppModel $model
|
||||||
* @param bool $created indicates whether the node just saved was created or updated
|
* @param boolean $created indicates whether the node just saved was created or updated
|
||||||
* @return boolean true on success, false on failure
|
* @return boolean true on success, false on failure
|
||||||
*/
|
*/
|
||||||
function afterSave(&$model, $created) {
|
function afterSave(&$model, $created) {
|
||||||
|
@ -182,8 +182,8 @@ class TreeBehavior extends ModelBehavior {
|
||||||
*
|
*
|
||||||
* @param AppModel $model
|
* @param AppModel $model
|
||||||
* @param mixed $id The ID of the record to read or false to read all top level nodes
|
* @param mixed $id The ID of the record to read or false to read all top level nodes
|
||||||
* @param bool $direct whether to count direct, or all, children
|
* @param boolean $direct whether to count direct, or all, children
|
||||||
* @return int number of child nodes
|
* @return integer number of child nodes
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function childcount(&$model, $id = null, $direct = false) {
|
function childcount(&$model, $id = null, $direct = false) {
|
||||||
|
@ -216,7 +216,7 @@ class TreeBehavior extends ModelBehavior {
|
||||||
*
|
*
|
||||||
* @param AppModel $model
|
* @param AppModel $model
|
||||||
* @param mixed $id The ID of the record to read
|
* @param mixed $id The ID of the record to read
|
||||||
* @param bool $direct whether to return only the direct, or all, children
|
* @param boolean $direct whether to return only the direct, or all, children
|
||||||
* @param mixed $fields Either a single string of a field name, or an array of field names
|
* @param mixed $fields Either a single string of a field name, or an array of field names
|
||||||
* @param string $order SQL ORDER BY conditions (e.g. "price DESC" or "name ASC") defaults to the tree order
|
* @param string $order SQL ORDER BY conditions (e.g. "price DESC" or "name ASC") defaults to the tree order
|
||||||
* @param integer $limit SQL LIMIT clause, for calculating items per page.
|
* @param integer $limit SQL LIMIT clause, for calculating items per page.
|
||||||
|
@ -488,7 +488,7 @@ class TreeBehavior extends ModelBehavior {
|
||||||
*
|
*
|
||||||
* @param AppModel $model
|
* @param AppModel $model
|
||||||
* @param mixed $id The ID of the record to remove
|
* @param mixed $id The ID of the record to remove
|
||||||
* @param bool $delete whether to delete the node after reparenting children (if any)
|
* @param boolean $delete whether to delete the node after reparenting children (if any)
|
||||||
* @return boolean true on success, false on failure
|
* @return boolean true on success, false on failure
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -240,7 +240,7 @@ class DboAdodb extends DboSource {
|
||||||
/**
|
/**
|
||||||
* Returns number of affected rows in previous database operation, or false if no previous operation exists.
|
* Returns number of affected rows in previous database operation, or false if no previous operation exists.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
return $this->_adodb->Affected_Rows();
|
return $this->_adodb->Affected_Rows();
|
||||||
|
@ -248,7 +248,7 @@ class DboAdodb extends DboSource {
|
||||||
/**
|
/**
|
||||||
* Returns number of rows in previous resultset, or false if no previous resultset exists.
|
* Returns number of rows in previous resultset, or false if no previous resultset exists.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
return $this->_result ? $this->_result->RecordCount() : false;
|
return $this->_result ? $this->_result->RecordCount() : false;
|
||||||
|
@ -306,7 +306,7 @@ class DboAdodb extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column_type The type of the column into which this data will be inserted
|
* @param string $column_type The type of the column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
|
|
@ -389,7 +389,7 @@ class DboDb2 extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -401,7 +401,7 @@ class DboDb2 extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
|
|
@ -147,7 +147,7 @@ class DboFirebird extends DboSource {
|
||||||
/**
|
/**
|
||||||
* Returns a row from given resultset as an array .
|
* Returns a row from given resultset as an array .
|
||||||
*
|
*
|
||||||
* @param bool $assoc Associative array only, or both?
|
* @param boolean $assoc Associative array only, or both?
|
||||||
* @return array The fetched row as an array
|
* @return array The fetched row as an array
|
||||||
*/
|
*/
|
||||||
function fetchRow($assoc = false) {
|
function fetchRow($assoc = false) {
|
||||||
|
@ -241,7 +241,7 @@ class DboFirebird extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column The column into which this data will be inserted
|
* @param string $column The column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
@ -306,7 +306,7 @@ class DboFirebird extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -318,7 +318,7 @@ class DboFirebird extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
return $this->_result? /*ibase_affected_rows($this->_result)*/ 1: false;
|
return $this->_result? /*ibase_affected_rows($this->_result)*/ 1: false;
|
||||||
|
|
|
@ -221,7 +221,7 @@ class DboMssql extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column The column into which this data will be inserted
|
* @param string $column The column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
@ -369,7 +369,7 @@ class DboMssql extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -381,7 +381,7 @@ class DboMssql extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -551,7 +551,7 @@ class DboMssql extends DboSource {
|
||||||
* Returns false if no rows matched.
|
* Returns false if no rows matched.
|
||||||
*
|
*
|
||||||
* @param string $sql SQL statement
|
* @param string $sql SQL statement
|
||||||
* @param bool $cache Enables returning/storing cached query results
|
* @param boolean $cache Enables returning/storing cached query results
|
||||||
* @return array Array of resultset rows, or false if no rows matched
|
* @return array Array of resultset rows, or false if no rows matched
|
||||||
*/
|
*/
|
||||||
function read(&$model, $queryData = array(), $recursive = null) {
|
function read(&$model, $queryData = array(), $recursive = null) {
|
||||||
|
|
|
@ -198,7 +198,7 @@ class DboMysql extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column The column into which this data will be inserted
|
* @param string $column The column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
@ -293,7 +293,7 @@ class DboMysql extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -305,7 +305,7 @@ class DboMysql extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result and is_resource($this->_result)) {
|
if ($this->_result and is_resource($this->_result)) {
|
||||||
|
@ -379,7 +379,7 @@ class DboMysql extends DboSource {
|
||||||
* Gets the length of a database-native column description, or null if no length
|
* Gets the length of a database-native column description, or null if no length
|
||||||
*
|
*
|
||||||
* @param string $real Real database-layer column type (i.e. "varchar(255)")
|
* @param string $real Real database-layer column type (i.e. "varchar(255)")
|
||||||
* @return int An integer representing the length of the column
|
* @return integer An integer representing the length of the column
|
||||||
*/
|
*/
|
||||||
function length($real) {
|
function length($real) {
|
||||||
$col = r(array(')', 'unsigned'), '', $real);
|
$col = r(array(')', 'unsigned'), '', $real);
|
||||||
|
|
|
@ -184,7 +184,7 @@ class DboMysqli extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column The column into which this data will be inserted
|
* @param string $column The column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
@ -279,7 +279,7 @@ class DboMysqli extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -291,7 +291,7 @@ class DboMysqli extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result and is_object($this->_result)) {
|
if ($this->_result and is_object($this->_result)) {
|
||||||
|
@ -365,7 +365,7 @@ class DboMysqli extends DboSource {
|
||||||
* Gets the length of a database-native column description, or null if no length
|
* Gets the length of a database-native column description, or null if no length
|
||||||
*
|
*
|
||||||
* @param string $real Real database-layer column type (i.e. "varchar(255)")
|
* @param string $real Real database-layer column type (i.e. "varchar(255)")
|
||||||
* @return int An integer representing the length of the column
|
* @return integer An integer representing the length of the column
|
||||||
*/
|
*/
|
||||||
function length($real) {
|
function length($real) {
|
||||||
$col = r(array(')', 'unsigned'), '', $real);
|
$col = r(array(')', 'unsigned'), '', $real);
|
||||||
|
|
|
@ -328,7 +328,7 @@ class DboOdbc extends DboSource{
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -342,7 +342,7 @@ class DboOdbc extends DboSource{
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
|
|
@ -263,7 +263,7 @@ class DboOracle extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
|
@ -577,7 +577,7 @@ class DboOracle extends DboSource {
|
||||||
* Returns the ID generated from the previous INSERT operation.
|
* Returns the ID generated from the previous INSERT operation.
|
||||||
*
|
*
|
||||||
* @param string
|
* @param string
|
||||||
* @return int
|
* @return integer
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function lastInsertId($source) {
|
function lastInsertId($source) {
|
||||||
|
|
|
@ -316,7 +316,7 @@ class DboPostgres extends DboSource {
|
||||||
/**
|
/**
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.
|
* Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -329,7 +329,7 @@ class DboPostgres extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -343,7 +343,7 @@ class DboPostgres extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $source Name of the database table
|
* @param string $source Name of the database table
|
||||||
* @param string $field Name of the ID database field. Defaults to "id"
|
* @param string $field Name of the ID database field. Defaults to "id"
|
||||||
* @return int
|
* @return integer
|
||||||
*/
|
*/
|
||||||
function lastInsertId($source, $field = 'id') {
|
function lastInsertId($source, $field = 'id') {
|
||||||
foreach ($this->__descriptions[$source] as $sourceinfo) {
|
foreach ($this->__descriptions[$source] as $sourceinfo) {
|
||||||
|
@ -542,7 +542,7 @@ class DboPostgres extends DboSource {
|
||||||
* Translates between PHP boolean values and PostgreSQL boolean values
|
* Translates between PHP boolean values and PostgreSQL boolean values
|
||||||
*
|
*
|
||||||
* @param mixed $data Value to be translated
|
* @param mixed $data Value to be translated
|
||||||
* @param bool $quote True to quote value, false otherwise
|
* @param boolean $quote True to quote value, false otherwise
|
||||||
* @return mixed Converted boolean value
|
* @return mixed Converted boolean value
|
||||||
*/
|
*/
|
||||||
function boolean($data, $quote = true) {
|
function boolean($data, $quote = true) {
|
||||||
|
|
|
@ -261,7 +261,7 @@ class DboSqlite extends DboSource {
|
||||||
/**
|
/**
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.
|
* Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -273,7 +273,7 @@ class DboSqlite extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
|
|
@ -184,7 +184,7 @@ class DboSybase extends DboSource {
|
||||||
*
|
*
|
||||||
* @param string $data String to be prepared for use in an SQL statement
|
* @param string $data String to be prepared for use in an SQL statement
|
||||||
* @param string $column The column into which this data will be inserted
|
* @param string $column The column into which this data will be inserted
|
||||||
* @param bool $safe Whether or not numeric data should be handled automagically if no column data is provided
|
* @param boolean $safe Whether or not numeric data should be handled automagically if no column data is provided
|
||||||
* @return string Quoted and escaped data
|
* @return string Quoted and escaped data
|
||||||
*/
|
*/
|
||||||
function value($data, $column = null, $safe = false) {
|
function value($data, $column = null, $safe = false) {
|
||||||
|
@ -271,7 +271,7 @@ class DboSybase extends DboSource {
|
||||||
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
* Returns number of affected rows in previous database operation. If no previous operation exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of affected rows
|
* @return integer Number of affected rows
|
||||||
*/
|
*/
|
||||||
function lastAffected() {
|
function lastAffected() {
|
||||||
if ($this->_result) {
|
if ($this->_result) {
|
||||||
|
@ -283,7 +283,7 @@ class DboSybase extends DboSource {
|
||||||
* Returns number of rows in previous resultset. If no previous resultset exists,
|
* Returns number of rows in previous resultset. If no previous resultset exists,
|
||||||
* this returns false.
|
* this returns false.
|
||||||
*
|
*
|
||||||
* @return int Number of rows in resultset
|
* @return integer Number of rows in resultset
|
||||||
*/
|
*/
|
||||||
function lastNumRows() {
|
function lastNumRows() {
|
||||||
if ($this->_result and is_resource($this->_result)) {
|
if ($this->_result and is_resource($this->_result)) {
|
||||||
|
|
|
@ -284,7 +284,7 @@ class DboSource extends DataSource {
|
||||||
* Returns false if no rows matched.
|
* Returns false if no rows matched.
|
||||||
*
|
*
|
||||||
* @param string $sql SQL statement
|
* @param string $sql SQL statement
|
||||||
* @param bool $cache Enables returning/storing cached query results
|
* @param boolean $cache Enables returning/storing cached query results
|
||||||
* @return array Array of resultset rows, or false if no rows matched
|
* @return array Array of resultset rows, or false if no rows matched
|
||||||
*/
|
*/
|
||||||
function fetchAll($sql, $cache = true, $modelName = null) {
|
function fetchAll($sql, $cache = true, $modelName = null) {
|
||||||
|
@ -371,7 +371,7 @@ class DboSource extends DataSource {
|
||||||
/**
|
/**
|
||||||
* Outputs the contents of the queries log.
|
* Outputs the contents of the queries log.
|
||||||
*
|
*
|
||||||
* @param bool $sorted
|
* @param boolean $sorted
|
||||||
*/
|
*/
|
||||||
function showLog($sorted = false) {
|
function showLog($sorted = false) {
|
||||||
if ($sorted) {
|
if ($sorted) {
|
||||||
|
@ -448,7 +448,7 @@ class DboSource extends DataSource {
|
||||||
* Gets full table name including prefix
|
* Gets full table name including prefix
|
||||||
*
|
*
|
||||||
* @param mixed $model
|
* @param mixed $model
|
||||||
* @param bool $quote
|
* @param boolean $quote
|
||||||
* @return string Full quoted table name
|
* @return string Full quoted table name
|
||||||
*/
|
*/
|
||||||
function fullTableName($model, $quote = true) {
|
function fullTableName($model, $quote = true) {
|
||||||
|
@ -1362,7 +1362,7 @@ class DboSource extends DataSource {
|
||||||
* @param Model $model
|
* @param Model $model
|
||||||
* @param string $alias Alias tablename
|
* @param string $alias Alias tablename
|
||||||
* @param mixed $fields
|
* @param mixed $fields
|
||||||
* @param bool $quote If false, returns fields array unquoted
|
* @param boolean $quote If false, returns fields array unquoted
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
function fields(&$model, $alias = null, $fields = array(), $quote = true) {
|
function fields(&$model, $alias = null, $fields = array(), $quote = true) {
|
||||||
|
|
|
@ -518,7 +518,7 @@ class Model extends Overloadable {
|
||||||
* to the originals defined in the model
|
* to the originals defined in the model
|
||||||
*
|
*
|
||||||
* @param array $params
|
* @param array $params
|
||||||
* @param bool $permanent
|
* @param boolean $permanent
|
||||||
*/
|
*/
|
||||||
function bind($model, $options, $permanent = true) {
|
function bind($model, $options, $permanent = true) {
|
||||||
if (!is_array($model)) {
|
if (!is_array($model)) {
|
||||||
|
@ -555,7 +555,7 @@ class Model extends Overloadable {
|
||||||
* to the originals defined in the model
|
* to the originals defined in the model
|
||||||
*
|
*
|
||||||
* @param array $params
|
* @param array $params
|
||||||
* @param bool $reset
|
* @param boolean $reset
|
||||||
* @return boolean Always true
|
* @return boolean Always true
|
||||||
*/
|
*/
|
||||||
function bindModel($params, $reset = true) {
|
function bindModel($params, $reset = true) {
|
||||||
|
@ -592,7 +592,7 @@ class Model extends Overloadable {
|
||||||
* </code>
|
* </code>
|
||||||
*
|
*
|
||||||
* @param array $params
|
* @param array $params
|
||||||
* @param bool $reset
|
* @param boolean $reset
|
||||||
* @return boolean Always true
|
* @return boolean Always true
|
||||||
*/
|
*/
|
||||||
function unbindModel($params, $reset = true) {
|
function unbindModel($params, $reset = true) {
|
||||||
|
@ -1030,7 +1030,7 @@ class Model extends Overloadable {
|
||||||
*
|
*
|
||||||
* @param string $name Name of the table field
|
* @param string $name Name of the table field
|
||||||
* @param mixed $value Value of the field
|
* @param mixed $value Value of the field
|
||||||
* @param bool $validate Whether or not this model should validate before saving (defaults to false)
|
* @param boolean $validate Whether or not this model should validate before saving (defaults to false)
|
||||||
* @return boolean True on success save
|
* @return boolean True on success save
|
||||||
*/
|
*/
|
||||||
function saveField($name, $value, $validate = false) {
|
function saveField($name, $value, $validate = false) {
|
||||||
|
@ -1041,7 +1041,7 @@ class Model extends Overloadable {
|
||||||
* By default, validation occurs before save.
|
* By default, validation occurs before save.
|
||||||
*
|
*
|
||||||
* @param array $data Data to save.
|
* @param array $data Data to save.
|
||||||
* @param bool $validate If set, validation will be done before the save
|
* @param boolean $validate If set, validation will be done before the save
|
||||||
* @param array $fieldList List of fields to allow to be written
|
* @param array $fieldList List of fields to allow to be written
|
||||||
* @return boolean success
|
* @return boolean success
|
||||||
*/
|
*/
|
||||||
|
@ -1394,7 +1394,7 @@ class Model extends Overloadable {
|
||||||
/**
|
/**
|
||||||
* Returns true if a record with set id exists.
|
* Returns true if a record with set id exists.
|
||||||
*
|
*
|
||||||
* @param bool $reset if true will force database query
|
* @param boolean $reset if true will force database query
|
||||||
* @return boolean True if such a record exists
|
* @return boolean True if such a record exists
|
||||||
*/
|
*/
|
||||||
function exists($reset = false) {
|
function exists($reset = false) {
|
||||||
|
@ -1607,7 +1607,7 @@ class Model extends Overloadable {
|
||||||
*
|
*
|
||||||
* @param array $conditions SQL conditions array for findAll
|
* @param array $conditions SQL conditions array for findAll
|
||||||
* @param integer $recursize The number of levels deep to fetch associated records
|
* @param integer $recursize The number of levels deep to fetch associated records
|
||||||
* @return int Number of matching rows
|
* @return integer Number of matching rows
|
||||||
* @see Model::find
|
* @see Model::find
|
||||||
*/
|
*/
|
||||||
function findCount($conditions = null, $recursive = 0) {
|
function findCount($conditions = null, $recursive = 0) {
|
||||||
|
@ -1617,7 +1617,7 @@ class Model extends Overloadable {
|
||||||
* False if any fields passed match any (by default, all if $or = false) of their matching values.
|
* False if any fields passed match any (by default, all if $or = false) of their matching values.
|
||||||
*
|
*
|
||||||
* @param array $fields Field/value pairs to search (if no values specified, they are pulled from $this->data)
|
* @param array $fields Field/value pairs to search (if no values specified, they are pulled from $this->data)
|
||||||
* @param bool $or If false, all fields specified must match in order for a false return value
|
* @param boolean $or If false, all fields specified must match in order for a false return value
|
||||||
* @return boolean False if any records matching any fields are found
|
* @return boolean False if any records matching any fields are found
|
||||||
*/
|
*/
|
||||||
function isUnique($fields, $or = true) {
|
function isUnique($fields, $or = true) {
|
||||||
|
@ -2100,7 +2100,7 @@ class Model extends Overloadable {
|
||||||
* After find callback. Can be used to modify any results returned by find and findAll.
|
* After find callback. Can be used to modify any results returned by find and findAll.
|
||||||
*
|
*
|
||||||
* @param mixed $results The results of the find operation
|
* @param mixed $results The results of the find operation
|
||||||
* @param bool $primary Whether this model is being queried directly (vs. being queried as an association)
|
* @param boolean $primary Whether this model is being queried directly (vs. being queried as an association)
|
||||||
* @return mixed Result of the find operation
|
* @return mixed Result of the find operation
|
||||||
*/
|
*/
|
||||||
function afterFind($results, $primary = false) {
|
function afterFind($results, $primary = false) {
|
||||||
|
@ -2117,7 +2117,7 @@ class Model extends Overloadable {
|
||||||
/**
|
/**
|
||||||
* After save callback
|
* After save callback
|
||||||
*
|
*
|
||||||
* @param bool $created True if this save created a new record
|
* @param boolean $created True if this save created a new record
|
||||||
*/
|
*/
|
||||||
function afterSave($created) {
|
function afterSave($created) {
|
||||||
}
|
}
|
||||||
|
|
|
@ -531,7 +531,7 @@ class Router extends Object {
|
||||||
/**
|
/**
|
||||||
* Gets parameter information
|
* Gets parameter information
|
||||||
*
|
*
|
||||||
* @param bool $current Get current parameter (true)
|
* @param boolean $current Get current parameter (true)
|
||||||
* @return array Parameter information
|
* @return array Parameter information
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
|
@ -547,7 +547,7 @@ class Router extends Object {
|
||||||
* Gets URL parameter by name
|
* Gets URL parameter by name
|
||||||
*
|
*
|
||||||
* @param string $name Parameter name
|
* @param string $name Parameter name
|
||||||
* @param bool $current Current parameter
|
* @param boolean $current Current parameter
|
||||||
* @return string Parameter value
|
* @return string Parameter value
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
|
@ -563,7 +563,7 @@ class Router extends Object {
|
||||||
/**
|
/**
|
||||||
* Gets path information
|
* Gets path information
|
||||||
*
|
*
|
||||||
* @param bool $current Current parameter
|
* @param boolean $current Current parameter
|
||||||
* @return array
|
* @return array
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
|
@ -622,7 +622,7 @@ class Router extends Object {
|
||||||
* or an array specifying any of the following: 'controller', 'action',
|
* or an array specifying any of the following: 'controller', 'action',
|
||||||
* and/or 'plugin', in addition to named arguments (keyed array elements),
|
* and/or 'plugin', in addition to named arguments (keyed array elements),
|
||||||
* and standard URL arguments (indexed array elements)
|
* and standard URL arguments (indexed array elements)
|
||||||
* @param bool $full If true, the full base URL will be prepended to the result
|
* @param boolean $full If true, the full base URL will be prepended to the result
|
||||||
* @return string Full translated URL with base path.
|
* @return string Full translated URL with base path.
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
|
|
|
@ -83,7 +83,7 @@ class Sanitize{
|
||||||
* Returns given string safe for display as HTML. Renders entities.
|
* Returns given string safe for display as HTML. Renders entities.
|
||||||
*
|
*
|
||||||
* @param string $string String from where to strip tags
|
* @param string $string String from where to strip tags
|
||||||
* @param bool $remove If true, the string is stripped of all HTML tags
|
* @param boolean $remove If true, the string is stripped of all HTML tags
|
||||||
* @return string Sanitized string
|
* @return string Sanitized string
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
|
|
|
@ -60,7 +60,7 @@ class Security extends Object {
|
||||||
/**
|
/**
|
||||||
* Get allowed minutes of inactivity based on security level.
|
* Get allowed minutes of inactivity based on security level.
|
||||||
*
|
*
|
||||||
* @return int Allowed inactivity in minutes
|
* @return integer Allowed inactivity in minutes
|
||||||
* @access public
|
* @access public
|
||||||
* @static
|
* @static
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -111,7 +111,7 @@ class CakeSession extends Object {
|
||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param string $base The base path for the Session
|
* @param string $base The base path for the Session
|
||||||
* @param bool $start Should session be started right now
|
* @param boolean $start Should session be started right now
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function __construct($base = null, $start = true) {
|
function __construct($base = null, $start = true) {
|
||||||
|
|
|
@ -109,7 +109,7 @@ class Set extends Object {
|
||||||
* Filters empty elements out of a route array, excluding '0'.
|
* Filters empty elements out of a route array, excluding '0'.
|
||||||
*
|
*
|
||||||
* @param mixed $var Either an array to filter, or value when in callback
|
* @param mixed $var Either an array to filter, or value when in callback
|
||||||
* @param bool $isArray Force to tell $var is an array when $var is empty
|
* @param boolean $isArray Force to tell $var is an array when $var is empty
|
||||||
* @return mixed Either filtered array, or true/false when in callback
|
* @return mixed Either filtered array, or true/false when in callback
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -601,7 +601,7 @@ class Set extends Object {
|
||||||
* Counts the dimensions of an array.
|
* Counts the dimensions of an array.
|
||||||
*
|
*
|
||||||
* @param array $array Array to count dimensions on
|
* @param array $array Array to count dimensions on
|
||||||
* @return int The number of dimensions in $array
|
* @return integer The number of dimensions in $array
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
function countDim($array = null) {
|
function countDim($array = null) {
|
||||||
|
@ -621,9 +621,9 @@ class Set extends Object {
|
||||||
* Normalizes a string or array list.
|
* Normalizes a string or array list.
|
||||||
*
|
*
|
||||||
* @param mixed $list List to normalize
|
* @param mixed $list List to normalize
|
||||||
* @param bool $assoc If true, $list will be converted to an associative array
|
* @param boolean $assoc If true, $list will be converted to an associative array
|
||||||
* @param string $sep If $list is a string, it will be split into an array with $sep
|
* @param string $sep If $list is a string, it will be split into an array with $sep
|
||||||
* @param bool $trim If true, separated strings will be trimmed
|
* @param boolean $trim If true, separated strings will be trimmed
|
||||||
* @return array
|
* @return array
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -191,7 +191,7 @@ class Validation extends Object {
|
||||||
* @param mixed $type 'all' may be passed as a sting, defaults to fast which checks format of most major credit cards
|
* @param mixed $type 'all' may be passed as a sting, defaults to fast which checks format of most major credit cards
|
||||||
* if an array is used only the values of the array are checked.
|
* if an array is used only the values of the array are checked.
|
||||||
* Example: array('amex', 'bankcard', 'maestro')
|
* Example: array('amex', 'bankcard', 'maestro')
|
||||||
* @param bool $deep set to true this will check the Luhn algorithm of the credit card.
|
* @param boolean $deep set to true this will check the Luhn algorithm of the credit card.
|
||||||
* @param string $regex A custom regex can also be passed, this will be used instead of the defined regex values
|
* @param string $regex A custom regex can also be passed, this will be used instead of the defined regex values
|
||||||
* @return boolean Success
|
* @return boolean Success
|
||||||
* @access public
|
* @access public
|
||||||
|
@ -430,7 +430,7 @@ class Validation extends Object {
|
||||||
* Validates for an email address.
|
* Validates for an email address.
|
||||||
*
|
*
|
||||||
* @param string $check Value to check
|
* @param string $check Value to check
|
||||||
* @param bool $deep Perform a deeper validation (if true), by also checking availability of host
|
* @param boolean $deep Perform a deeper validation (if true), by also checking availability of host
|
||||||
* @param string $regex Regex to use (if none it will use built in regex)
|
* @param string $regex Regex to use (if none it will use built in regex)
|
||||||
* @return boolean Success
|
* @return boolean Success
|
||||||
* @access public
|
* @access public
|
||||||
|
|
|
@ -176,7 +176,7 @@ class Helper extends Overloadable {
|
||||||
* or an array specifying any of the following: 'controller', 'action',
|
* or an array specifying any of the following: 'controller', 'action',
|
||||||
* and/or 'plugin', in addition to named arguments (keyed array elements),
|
* and/or 'plugin', in addition to named arguments (keyed array elements),
|
||||||
* and standard URL arguments (indexed array elements)
|
* and standard URL arguments (indexed array elements)
|
||||||
* @param bool $full If true, the full base URL will be prepended to the result
|
* @param boolean $full If true, the full base URL will be prepended to the result
|
||||||
* @return string Full translated URL with base path.
|
* @return string Full translated URL with base path.
|
||||||
*/
|
*/
|
||||||
function url($url = null, $full = false) {
|
function url($url = null, $full = false) {
|
||||||
|
|
|
@ -161,7 +161,7 @@ class AjaxHelper extends AppHelper {
|
||||||
* @param string $href Href string "/products/view/12"
|
* @param string $href Href string "/products/view/12"
|
||||||
* @param array $options Options for JavaScript function
|
* @param array $options Options for JavaScript function
|
||||||
* @param string $confirm Confirmation message. Calls up a JavaScript confirm() message.
|
* @param string $confirm Confirmation message. Calls up a JavaScript confirm() message.
|
||||||
* @param bool $escapeTitle Escaping the title string to HTML entities
|
* @param boolean $escapeTitle Escaping the title string to HTML entities
|
||||||
*
|
*
|
||||||
* @return string HTML code for link to remote action
|
* @return string HTML code for link to remote action
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -63,7 +63,7 @@ class CacheHelper extends AppHelper {
|
||||||
*
|
*
|
||||||
* @param string $file File to cache
|
* @param string $file File to cache
|
||||||
* @param string $out output to cache
|
* @param string $out output to cache
|
||||||
* @param bool $cache
|
* @param boolean $cache
|
||||||
* @return view ouput
|
* @return view ouput
|
||||||
*/
|
*/
|
||||||
function cache($file, $out, $cache = false) {
|
function cache($file, $out, $cache = false) {
|
||||||
|
@ -127,7 +127,7 @@ class CacheHelper extends AppHelper {
|
||||||
* Parse file searching for no cache tags
|
* Parse file searching for no cache tags
|
||||||
*
|
*
|
||||||
* @param string $file
|
* @param string $file
|
||||||
* @param bool $cache
|
* @param boolean $cache
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __parseFile($file, $cache) {
|
function __parseFile($file, $cache) {
|
||||||
|
|
|
@ -1068,7 +1068,7 @@ class FormHelper extends AppHelper {
|
||||||
* @param integer $maxYear Last year in sequence
|
* @param integer $maxYear Last year in sequence
|
||||||
* @param string $selected Option which is selected.
|
* @param string $selected Option which is selected.
|
||||||
* @param array $attributes Attribute array for the select elements.
|
* @param array $attributes Attribute array for the select elements.
|
||||||
* @param bool $showEmpty Show/hide the empty select option
|
* @param boolean $showEmpty Show/hide the empty select option
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
function year($fieldName, $minYear = null, $maxYear = null, $selected = null, $attributes = array(), $showEmpty = true) {
|
function year($fieldName, $minYear = null, $maxYear = null, $selected = null, $attributes = array(), $showEmpty = true) {
|
||||||
|
@ -1096,7 +1096,7 @@ class FormHelper extends AppHelper {
|
||||||
*
|
*
|
||||||
* @param string $fieldName Prefix name for the SELECT element
|
* @param string $fieldName Prefix name for the SELECT element
|
||||||
* @param string $selected Option which is selected.
|
* @param string $selected Option which is selected.
|
||||||
* @param bool $showEmpty Show/hide the empty select option
|
* @param boolean $showEmpty Show/hide the empty select option
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
function month($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
|
function month($fieldName, $selected = null, $attributes = array(), $showEmpty = true) {
|
||||||
|
@ -1121,7 +1121,7 @@ class FormHelper extends AppHelper {
|
||||||
* Returns a SELECT element for hours.
|
* Returns a SELECT element for hours.
|
||||||
*
|
*
|
||||||
* @param string $fieldName Prefix name for the SELECT element
|
* @param string $fieldName Prefix name for the SELECT element
|
||||||
* @param bool $format24Hours True for 24 hours format
|
* @param boolean $format24Hours True for 24 hours format
|
||||||
* @param string $selected Option which is selected.
|
* @param string $selected Option which is selected.
|
||||||
* @param array $attributes List of HTML attributes
|
* @param array $attributes List of HTML attributes
|
||||||
* @param mixed $showEmpty True to show an empty element, or a string to provide default empty element text
|
* @param mixed $showEmpty True to show an empty element, or a string to provide default empty element text
|
||||||
|
|
|
@ -298,7 +298,7 @@ class HtmlHelper extends AppHelper {
|
||||||
* @param mixed $path The name of a CSS style sheet in /app/webroot/css, or an array containing names of CSS stylesheets in that directory.
|
* @param mixed $path The name of a CSS style sheet in /app/webroot/css, or an array containing names of CSS stylesheets in that directory.
|
||||||
* @param string $rel Rel attribute. Defaults to "stylesheet".
|
* @param string $rel Rel attribute. Defaults to "stylesheet".
|
||||||
* @param array $htmlAttributes Array of HTML attributes.
|
* @param array $htmlAttributes Array of HTML attributes.
|
||||||
* @param bool $inline If set to false, the generated tag appears in the head tag of the layout.
|
* @param boolean $inline If set to false, the generated tag appears in the head tag of the layout.
|
||||||
* @return string CSS <link /> or <style /> tag, depending on the type of link.
|
* @return string CSS <link /> or <style /> tag, depending on the type of link.
|
||||||
*/
|
*/
|
||||||
function css($path, $rel = null, $htmlAttributes = array(), $inline = true) {
|
function css($path, $rel = null, $htmlAttributes = array(), $inline = true) {
|
||||||
|
@ -468,7 +468,7 @@ class HtmlHelper extends AppHelper {
|
||||||
* @param string $text String content that will appear inside the div element.
|
* @param string $text String content that will appear inside the div element.
|
||||||
* If null, only a start tag will be printed
|
* If null, only a start tag will be printed
|
||||||
* @param array $attributes Additional HTML attributes of the DIV tag
|
* @param array $attributes Additional HTML attributes of the DIV tag
|
||||||
* @param bool $escape If true, $text will be HTML-escaped
|
* @param boolean $escape If true, $text will be HTML-escaped
|
||||||
* @return string The formatted DIV element
|
* @return string The formatted DIV element
|
||||||
*/
|
*/
|
||||||
function div($class = null, $text = null, $attributes = array(), $escape = false) {
|
function div($class = null, $text = null, $attributes = array(), $escape = false) {
|
||||||
|
@ -491,7 +491,7 @@ class HtmlHelper extends AppHelper {
|
||||||
* @param string $class CSS class name of the p element.
|
* @param string $class CSS class name of the p element.
|
||||||
* @param string $text String content that will appear inside the p element.
|
* @param string $text String content that will appear inside the p element.
|
||||||
* @param array $attributes Additional HTML attributes of the P tag
|
* @param array $attributes Additional HTML attributes of the P tag
|
||||||
* @param bool $escape If true, $text will be HTML-escaped
|
* @param boolean $escape If true, $text will be HTML-escaped
|
||||||
* @return string The formatted P element
|
* @return string The formatted P element
|
||||||
*/
|
*/
|
||||||
function para($class, $text, $attributes = array(), $escape = false) {
|
function para($class, $text, $attributes = array(), $escape = false) {
|
||||||
|
|
|
@ -178,11 +178,10 @@ class JavascriptHelper extends AppHelper {
|
||||||
* @param string $object Object to be observed
|
* @param string $object Object to be observed
|
||||||
* @param string $event event to observe
|
* @param string $event event to observe
|
||||||
* @param string $observer function to call
|
* @param string $observer function to call
|
||||||
* @param bool $useCapture default true
|
* @param boolean $useCapture default true
|
||||||
* @return boolean true on success
|
* @return boolean true on success
|
||||||
*/
|
*/
|
||||||
function event($object, $event, $observer = null, $useCapture = false) {
|
function event($object, $event, $observer = null, $useCapture = false) {
|
||||||
|
|
||||||
if ($useCapture == true) {
|
if ($useCapture == true) {
|
||||||
$useCapture = 'true';
|
$useCapture = 'true';
|
||||||
} else {
|
} else {
|
||||||
|
@ -221,8 +220,8 @@ class JavascriptHelper extends AppHelper {
|
||||||
/**
|
/**
|
||||||
* Cache JavaScript events created with event()
|
* Cache JavaScript events created with event()
|
||||||
*
|
*
|
||||||
* @param bool $file If true, code will be written to a file
|
* @param boolean $file If true, code will be written to a file
|
||||||
* @param bool $all If true, all code written with JavascriptHelper will be sent to a file
|
* @param boolean $all If true, all code written with JavascriptHelper will be sent to a file
|
||||||
* @return null
|
* @return null
|
||||||
*/
|
*/
|
||||||
function cacheEvents($file = false, $all = false) {
|
function cacheEvents($file = false, $all = false) {
|
||||||
|
@ -233,7 +232,7 @@ class JavascriptHelper extends AppHelper {
|
||||||
/**
|
/**
|
||||||
* Gets (and clears) the current JavaScript event cache
|
* Gets (and clears) the current JavaScript event cache
|
||||||
*
|
*
|
||||||
* @param bool $clear
|
* @param boolean $clear
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
function getCache($clear = true) {
|
function getCache($clear = true) {
|
||||||
|
@ -261,7 +260,7 @@ class JavascriptHelper extends AppHelper {
|
||||||
/**
|
/**
|
||||||
* Write cached JavaScript events
|
* Write cached JavaScript events
|
||||||
*
|
*
|
||||||
* @param bool $inline If true, returns JavaScript event code. Otherwise it is added to the
|
* @param boolean $inline If true, returns JavaScript event code. Otherwise it is added to the
|
||||||
* output of $scripts_for_layout in the layout.
|
* output of $scripts_for_layout in the layout.
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
|
@ -320,11 +319,11 @@ class JavascriptHelper extends AppHelper {
|
||||||
* from an array
|
* from an array
|
||||||
*
|
*
|
||||||
* @param array $data Data to be converted
|
* @param array $data Data to be converted
|
||||||
* @param bool $block Wraps return value in a <script/> block if true
|
* @param boolean $block Wraps return value in a <script/> block if true
|
||||||
* @param string $prefix Prepends the string to the returned data
|
* @param string $prefix Prepends the string to the returned data
|
||||||
* @param string $postfix Appends the string to the returned data
|
* @param string $postfix Appends the string to the returned data
|
||||||
* @param array $stringKeys A list of array keys to be treated as a string
|
* @param array $stringKeys A list of array keys to be treated as a string
|
||||||
* @param bool $quoteKeys If false, treats $stringKey as a list of keys *not* to be quoted
|
* @param boolean $quoteKeys If false, treats $stringKey as a list of keys *not* to be quoted
|
||||||
* @param string $q The type of quote to use
|
* @param string $q The type of quote to use
|
||||||
* @return string A JSON code block
|
* @return string A JSON code block
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -212,11 +212,11 @@ class JsHelper extends Overloadable2 {
|
||||||
* from an array
|
* from an array
|
||||||
*
|
*
|
||||||
* @param array $data Data to be converted
|
* @param array $data Data to be converted
|
||||||
* @param bool $block Wraps return value in a <script/> block if true
|
* @param boolean $block Wraps return value in a <script/> block if true
|
||||||
* @param string $prefix Prepends the string to the returned data
|
* @param string $prefix Prepends the string to the returned data
|
||||||
* @param string $postfix Appends the string to the returned data
|
* @param string $postfix Appends the string to the returned data
|
||||||
* @param array $stringKeys A list of array keys to be treated as a string
|
* @param array $stringKeys A list of array keys to be treated as a string
|
||||||
* @param bool $quoteKeys If false, treats $stringKey as a list of keys *not* to be quoted
|
* @param boolean $quoteKeys If false, treats $stringKey as a list of keys *not* to be quoted
|
||||||
* @param string $q The type of quote to use
|
* @param string $q The type of quote to use
|
||||||
* @return string A JSON code block
|
* @return string A JSON code block
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -148,10 +148,10 @@ class TextHelper extends AppHelper {
|
||||||
* Cuts a string to the length of $length and replaces the last characters
|
* Cuts a string to the length of $length and replaces the last characters
|
||||||
* with the ending if the text is longer than length.
|
* with the ending if the text is longer than length.
|
||||||
*
|
*
|
||||||
* @param string $text String to truncate.
|
* @param string $text String to truncate.
|
||||||
* @param integer $length Length of returned string, including ellipsis.
|
* @param integer $length Length of returned string, including ellipsis.
|
||||||
* @param string $ending Ending to be appended to the trimmed string.
|
* @param string $ending Ending to be appended to the trimmed string.
|
||||||
* @param bool $exact If false, $text will not be cut mid-word
|
* @param boolean $exact If false, $text will not be cut mid-word
|
||||||
* @return string Trimmed string.
|
* @return string Trimmed string.
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
@ -238,7 +238,7 @@ class TextHelper extends AppHelper {
|
||||||
* Text-to-html parser, similar to Textile or RedCloth, only with a little different syntax.
|
* Text-to-html parser, similar to Textile or RedCloth, only with a little different syntax.
|
||||||
*
|
*
|
||||||
* @param string $text String to "flay"
|
* @param string $text String to "flay"
|
||||||
* @param bool $allowHtml Set to true if if html is allowed
|
* @param boolean $allowHtml Set to true if if html is allowed
|
||||||
* @return string "Flayed" text
|
* @return string "Flayed" text
|
||||||
* @access public
|
* @access public
|
||||||
* @todo Change this. We need a real Textile parser.
|
* @todo Change this. We need a real Textile parser.
|
||||||
|
|
|
@ -198,7 +198,7 @@ class TimeHelper extends AppHelper {
|
||||||
* Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().
|
* Returns a UNIX timestamp from a textual datetime description. Wrapper for PHP function strtotime().
|
||||||
*
|
*
|
||||||
* @param string $date_string Datetime string to be represented as a Unix timestamp
|
* @param string $date_string Datetime string to be represented as a Unix timestamp
|
||||||
* @return int Unix timestamp
|
* @return integer Unix timestamp
|
||||||
*/
|
*/
|
||||||
function toUnix($date_string) {
|
function toUnix($date_string) {
|
||||||
$ret = strtotime($date_string);
|
$ret = strtotime($date_string);
|
||||||
|
|
|
@ -398,7 +398,7 @@ class XMLNode extends Object {
|
||||||
* Debug method. Deletes the parent. Also deletes this node's children,
|
* Debug method. Deletes the parent. Also deletes this node's children,
|
||||||
* if given the $recursive parameter.
|
* if given the $recursive parameter.
|
||||||
*
|
*
|
||||||
* @param bool $recursive Recursively delete elements.
|
* @param boolean $recursive Recursively delete elements.
|
||||||
* @access private
|
* @access private
|
||||||
*/
|
*/
|
||||||
function __killParent($recursive = true) {
|
function __killParent($recursive = true) {
|
||||||
|
@ -618,7 +618,7 @@ class XML extends XMLNode {
|
||||||
/**
|
/**
|
||||||
* Returns a string representation of the XML object
|
* Returns a string representation of the XML object
|
||||||
*
|
*
|
||||||
* @param bool $useHeader Whether to include the XML header with the document (defaults to true)
|
* @param boolean $useHeader Whether to include the XML header with the document (defaults to true)
|
||||||
* @return string XML data
|
* @return string XML data
|
||||||
* @access public
|
* @access public
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue