CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 1.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 1.2
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Classes

  • AclBase
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • AjaxHelper
  • ApcEngine
  • ApiShell
  • App
  • AppController
  • AppHelper
  • AppModel
  • Aro
  • AuthComponent
  • BakeShell
  • BehaviorCollection
  • Cache
  • CacheEngine
  • CacheHelper
  • CakeErrorController
  • CakeLog
  • CakeSchema
  • CakeSession
  • CakeSocket
  • ClassRegistry
  • Component
  • Configure
  • ConnectionManager
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerTask
  • CookieComponent
  • DataSource
  • DbAcl
  • DbAclSchema
  • DbConfigTask
  • DboAdodb
  • DboDb2
  • DboFirebird
  • DboMssql
  • DboMysql
  • DboMysqlBase
  • DboMysqli
  • DboOdbc
  • DboOracle
  • DboPostgres
  • DboSource
  • DboSqlite
  • DboSybase
  • Debugger
  • EmailComponent
  • ErrorHandler
  • ExtractTask
  • File
  • FileEngine
  • Flay
  • Folder
  • FormHelper
  • Helper
  • HtmlHelper
  • HttpSocket
  • I18n
  • I18nModel
  • i18nSchema
  • I18nShell
  • Inflector
  • IniAcl
  • JavascriptHelper
  • JsHelper
  • JsHelperObject
  • L10n
  • MagicDb
  • MagicFileResource
  • MediaView
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • Multibyte
  • NumberHelper
  • Object
  • Overloadable
  • Overloadable2
  • PagesController
  • PaginatorHelper
  • Permission
  • PluginTask
  • ProjectTask
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • SessionComponent
  • SessionHelper
  • SessionsSchema
  • Set
  • Shell
  • String
  • TestSuiteShell
  • TestTask
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • Validation
  • View
  • ViewTask
  • XcacheEngine
  • Xml
  • XmlElement
  • XmlHelper
  • XmlManager
  • XmlNode
  • XmlTextNode

Functions

  • __enclose
  • make_clean_css
  • mb_encode_mimeheader
  • mb_stripos
  • mb_stristr
  • mb_strlen
  • mb_strpos
  • mb_strrchr
  • mb_strrichr
  • mb_strripos
  • mb_strrpos
  • mb_strstr
  • mb_strtolower
  • mb_strtoupper
  • mb_substr
  • mb_substr_count
  • write_css_cache

Class Multibyte

Multibyte handling methods.

Object
Extended by Multibyte
Package: cake\cake\libs
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: multibyte.php

Properties summary

  • $__caseFold public
    array
    Holds the case folding values
  • $__codeRange public
    array
    Holds an array of Unicode code point ranges
  • $__table public
    string
    Holds the current code point range

Inherited Properties

  • _log

Method Summary

  • __codepoint() public
    Return the Code points range for Unicode characters
  • __find() public
    Find the related code folding values for $char
  • ascii() public

    Converts the decimal value of a multibyte character string to a string

  • checkMultibyte() public
    Check the $string for multibyte characters
  • getInstance() public
    Gets a reference to the Multibyte object instance
  • mimeEncode() public
    Prepare a string for mail transport, using the provided encoding
  • stripos() public
    Find position of first occurrence of a case-insensitive string.
  • stristr() public
    Finds first occurrence of a string within another, case insensitive.
  • strlen() public
    Get string length.
  • strpos() public
    Find position of first occurrence of a string.
  • strrchr() public
    Finds the last occurrence of a character in a string within another.
  • strrichr() public
    Finds the last occurrence of a character in a string within another, case insensitive.
  • strripos() public
    Finds position of last occurrence of a string within another, case insensitive
  • strrpos() public
    Find position of last occurrence of a string in a string.
  • strstr() public
    Finds first occurrence of a string within another
  • strtolower() public
    Make a string lowercase
  • strtoupper() public
    Make a string uppercase
  • substr() public
    Get part of string
  • substrCount() public
    Count the number of substring occurrences
  • utf8() public

    Converts a multibyte character string to the decimal value of the character

Method Detail

__codepoint() public ¶

__codepoint( interger $decimal )

Return the Code points range for Unicode characters

Parameters
interger $decimal
Returns
string

__find() public ¶

__find( integer $char , string $type = 'lower' )

Find the related code folding values for $char

Parameters
integer $char
decimal value of character
string $type optional 'lower'
Returns
array

ascii() public ¶

ascii( array $array )

Converts the decimal value of a multibyte character string to a string

Parameters
array $array
Returns
string

checkMultibyte() public ¶

checkMultibyte( string $string )

Check the $string for multibyte characters

Parameters
string $string
value to test
Returns
boolean

getInstance() public ¶

getInstance( )

Gets a reference to the Multibyte object instance

Returns
object
Multibyte instance

mimeEncode() public ¶

mimeEncode( string $string , string $charset = null , string $newline = "\r\n" )

Prepare a string for mail transport, using the provided encoding

Parameters
string $string
value to encode
string $charset optional null
charset to use for encoding. defaults to UTF-8
string $newline optional "\r\n"
Returns
string
Todo:
add support for 'Q'('Quoted Printable') encoding

stripos() public ¶

stripos( multi-byte $haystack , multi-byte $needle , integer $offset = 0 )

Find position of first occurrence of a case-insensitive string.

Parameters
multi-byte $haystack
$haystack The string from which to get the position of the first occurrence of $needle.
multi-byte $needle
$needle The string to find in $haystack.
integer $offset optional 0
The position in $haystack to start searching.
Returns
integer|boolean

The numeric position of the first occurrence of $needle in the $haystack string, or false if $needle is not found.


stristr() public ¶

stristr( string $haystack , string $needle , boolean $part = false )

Finds first occurrence of a string within another, case insensitive.

Parameters
string $haystack
The string from which to get the first occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false

Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is false.

Returns
integer|boolean
The portion of $haystack, or false if $needle is not found.

strlen() public ¶

strlen( string $string )

Get string length.

Parameters
string $string
The string being checked for length.
Returns
integer
The number of characters in string $string

strpos() public ¶

strpos( string $haystack , string $needle , integer $offset = 0 )

Find position of first occurrence of a string.

Parameters
string $haystack
The string being checked.
string $needle
The position counted from the beginning of haystack.
integer $offset optional 0
The search offset. If it is not specified, 0 is used.
Returns
integer|boolean

The numeric position of the first occurrence of $needle in the $haystack string. If $needle is not found, it returns false.


strrchr() public ¶

strrchr( string $haystack , string $needle , boolean $part = false )

Finds the last occurrence of a character in a string within another.

Parameters
string $haystack
The string from which to get the last occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false

Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false.

Returns
string|boolean
The portion of $haystack. or false if $needle is not found.

strrichr() public ¶

strrichr( string $haystack , string $needle , boolean $part = false )

Finds the last occurrence of a character in a string within another, case insensitive.

Parameters
string $haystack
The string from which to get the last occurrence of $needle.
string $needle
The string to find in $haystack.
boolean $part optional false

Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the last occurrence of $needle. If set to false, it returns all of $haystack from the last occurrence of $needle to the end, Default value is false.

Returns
string|boolean
The portion of $haystack. or false if $needle is not found.

strripos() public ¶

strripos( string $haystack , string $needle , integer $offset = 0 )

Finds position of last occurrence of a string within another, case insensitive

Parameters
string $haystack
The string from which to get the position of the last occurrence of $needle.
string $needle
The string to find in $haystack.
integer $offset optional 0
The position in $haystack to start searching.
Returns
integer|boolean

The numeric position of the last occurrence of $needle in the $haystack string, or false if $needle is not found.


strrpos() public ¶

strrpos( string $haystack , string $needle , integer $offset = 0 )

Find position of last occurrence of a string in a string.

Parameters
string $haystack
The string being checked, for the last occurrence of $needle.
string $needle
The string to find in $haystack.
integer $offset optional 0

May be specified to begin searching an arbitrary number of characters into the string. Negative values will stop searching at an arbitrary point prior to the end of the string.

Returns
integer|boolean

The numeric position of the last occurrence of $needle in the $haystack string. If $needle is not found, it returns false.


strstr() public ¶

strstr( string $haystack , string $needle , boolean $part = false )

Finds first occurrence of a string within another

Parameters
string $haystack
The string from which to get the first occurrence of $needle.
string $needle
The string to find in $haystack
boolean $part optional false

Determines which portion of $haystack this function returns. If set to true, it returns all of $haystack from the beginning to the first occurrence of $needle. If set to false, it returns all of $haystack from the first occurrence of $needle to the end, Default value is FALSE.

Returns
string|boolean
The portion of $haystack, or true if $needle is not found.

strtolower() public ¶

strtolower( string $string )

Make a string lowercase

Parameters
string $string
The string being lowercased.
Returns
string
with all alphabetic characters converted to lowercase.

strtoupper() public ¶

strtoupper( string $string , string $encoding ,… )

Make a string uppercase

Parameters
string $string
The string being uppercased.
string $encoding ,…
Character encoding name to use. If it is omitted, internal character encoding is used.
Returns
string
with all alphabetic characters converted to uppercase.

substr() public ¶

substr( string $string , integer $start , integer $length = null )

Get part of string

Parameters
string $string
The string being checked.
integer $start
The first position used in $string.
integer $length optional null
The maximum length of the returned string.
Returns
string
The portion of $string specified by the $string and $length parameters.

substrCount() public ¶

substrCount( string $haystack , string $needle )

Count the number of substring occurrences

Parameters
string $haystack
The string being checked.
string $needle
The string being found.
Returns
integer
The number of times the $needle substring occurs in the $haystack string.

utf8() public ¶

utf8( multibyte $string )

Converts a multibyte character string to the decimal value of the character

Parameters
multibyte $string
$string
Returns
array

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns
Object

__construct() public ¶

__construct( )

Class constructor, overridden in descendant classes.

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters
string $name
Name of persisted class
string $type optional null
Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters
string $name
name of the class to persist
string $return
$object the object to persist
$object
$type optional null
Returns
boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters
string $name
name used for object to cache
object $object
the object to persist
Returns
boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code.

Parameters
array $properties optional array()
An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

Parameters
$status optional 0
http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters
string $method
Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array()
Message that is to be displayed by the error class
Returns
error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.

Parameters
string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method
Returns
mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

API for logging events.

Parameters
string $msg
Log message
integer $type optional LOG_ERROR
Error type constant. Defined in app/config/core.php.
Returns
boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location.

Parameters
mixed $url
String or array-based url.
array $extra optional array()
if array includes the key "return" it sets the AutoRender to true.
Returns
mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.


toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns
string
The name of this class

Properties detail

$__caseFold ¶

public array

Holds the case folding values

array()

$__codeRange ¶

public array

Holds an array of Unicode code point ranges

array()

$__table ¶

public string

Holds the current code point range

null
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs