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 2.5 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.5
      • 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

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • AbstractPasswordHasher
  • AbstractTransport
  • AclBehavior
  • AclComponent
  • AclNode
  • AclShell
  • Aco
  • AcoAction
  • ActionsAuthorize
  • ApcEngine
  • ApiShell
  • App
  • Aro
  • AssetDispatcher
  • AuthComponent
  • BakeShell
  • BakeTask
  • BaseAuthenticate
  • BaseAuthorize
  • BaseCoverageReport
  • BaseLog
  • BasicAuthenticate
  • BasicAuthentication
  • BehaviorCollection
  • BlowfishAuthenticate
  • BlowfishPasswordHasher
  • Cache
  • CacheDispatcher
  • CacheEngine
  • CacheHelper
  • CacheSession
  • CakeBaseReporter
  • CakeEmail
  • CakeErrorController
  • CakeEvent
  • CakeEventManager
  • CakeFixtureManager
  • CakeHtmlReporter
  • CakeLog
  • CakeNumber
  • CakePlugin
  • CakeRequest
  • CakeResponse
  • CakeRoute
  • CakeSchema
  • CakeSession
  • CakeSocket
  • CakeTestCase
  • CakeTestFixture
  • CakeTestLoader
  • CakeTestModel
  • CakeTestRunner
  • CakeTestSuite
  • CakeTestSuiteCommand
  • CakeTestSuiteDispatcher
  • CakeTextReporter
  • CakeTime
  • CakeValidationRule
  • CakeValidationSet
  • ClassRegistry
  • CommandListShell
  • CommandTask
  • CompletionShell
  • Component
  • ComponentCollection
  • Configure
  • ConnectionManager
  • ConsoleErrorHandler
  • ConsoleInput
  • ConsoleInputArgument
  • ConsoleInputOption
  • ConsoleInputSubcommand
  • ConsoleLog
  • ConsoleOptionParser
  • ConsoleOutput
  • ConsoleShell
  • ContainableBehavior
  • Controller
  • ControllerAuthorize
  • ControllerTask
  • ControllerTestCase
  • ControllerTestDispatcher
  • CookieComponent
  • CrudAuthorize
  • DatabaseSession
  • DataSource
  • DbAcl
  • DbConfigTask
  • DboSource
  • Debugger
  • DebugTransport
  • DigestAuthenticate
  • DigestAuthentication
  • Dispatcher
  • DispatcherFilter
  • EmailComponent
  • ErrorHandler
  • ExceptionRenderer
  • ExtractTask
  • File
  • FileEngine
  • FileLog
  • FixtureTask
  • Folder
  • FormAuthenticate
  • FormHelper
  • Hash
  • Helper
  • HelperCollection
  • HelpFormatter
  • HtmlCoverageReport
  • HtmlHelper
  • HttpResponse
  • HttpSocket
  • HttpSocketResponse
  • I18n
  • I18nModel
  • I18nShell
  • Inflector
  • IniAcl
  • IniReader
  • InterceptContentHelper
  • JqueryEngineHelper
  • JsBaseEngineHelper
  • JsHelper
  • JsonView
  • L10n
  • LogEngineCollection
  • MailTransport
  • MediaView
  • MemcachedEngine
  • MemcacheEngine
  • Model
  • ModelBehavior
  • ModelTask
  • ModelValidator
  • MootoolsEngineHelper
  • Multibyte
  • Mysql
  • NumberHelper
  • Object
  • ObjectCollection
  • PaginatorComponent
  • PaginatorHelper
  • Permission
  • PhpAcl
  • PhpAco
  • PhpAro
  • PhpReader
  • PluginShortRoute
  • PluginTask
  • Postgres
  • ProjectTask
  • PrototypeEngineHelper
  • RedirectRoute
  • RedisEngine
  • RequestHandlerComponent
  • Router
  • RssHelper
  • Sanitize
  • Scaffold
  • ScaffoldView
  • SchemaShell
  • Security
  • SecurityComponent
  • ServerShell
  • SessionComponent
  • SessionHelper
  • Set
  • Shell
  • ShellDispatcher
  • SimplePasswordHasher
  • SmtpTransport
  • Sqlite
  • Sqlserver
  • String
  • SyslogLog
  • TaskCollection
  • TemplateTask
  • TestShell
  • TestsuiteShell
  • TestTask
  • TextCoverageReport
  • TextHelper
  • ThemeView
  • TimeHelper
  • TranslateBehavior
  • TreeBehavior
  • UpgradeShell
  • Validation
  • View
  • ViewBlock
  • ViewTask
  • WincacheEngine
  • XcacheEngine
  • Xml
  • XmlView

Interfaces

  • AclInterface
  • CakeEventListener
  • CakeLogInterface
  • CakeSessionHandlerInterface
  • ConfigReaderInterface

Exceptions

  • AclException
  • BadRequestException
  • CacheException
  • CakeBaseException
  • CakeException
  • CakeLogException
  • CakeSessionException
  • ConfigureException
  • ConsoleException
  • FatalErrorException
  • ForbiddenException
  • HttpException
  • InternalErrorException
  • MethodNotAllowedException
  • MissingActionException
  • MissingBehaviorException
  • MissingComponentException
  • MissingConnectionException
  • MissingControllerException
  • MissingDatabaseException
  • MissingDatasourceConfigException
  • MissingDatasourceException
  • MissingDispatcherFilterException
  • MissingHelperException
  • MissingLayoutException
  • MissingModelException
  • MissingPluginException
  • MissingShellException
  • MissingShellMethodException
  • MissingTableException
  • MissingTaskException
  • MissingTestLoaderException
  • MissingViewException
  • NotFoundException
  • NotImplementedException
  • PrivateActionException
  • RouterException
  • SocketException
  • UnauthorizedException
  • XmlException

Functions

  • __
  • __c
  • __d
  • __dc
  • __dcn
  • __dn
  • __n
  • am
  • cache
  • clearCache
  • config
  • convertSlash
  • debug
  • env
  • fileExistsInPath
  • h
  • LogError
  • 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
  • pluginSplit
  • pr
  • sortByKey
  • stripslashes_deep

Deprecated

Classes summary

  • BlowfishAuthenticate

    3.0.0 Since 2.4. Just use FormAuthenticate with 'passwordHasher' setting set to 'Blowfish'

  • ConsoleShell

    3.0.0 Deprecated since version 2.4, will be removed in 3.0

  • EmailComponent

    3.0.0 Will be removed in 3.0. Use Network/CakeEmail instead

  • HttpResponse

    3.0.0 This class is deprecated as it has naming conflicts with pecl/http

  • MediaView

    3.0.0 Deprecated since version 2.3, use CakeResponse::file() instead

  • MemcacheEngine

    3.0.0 You should use the Memcached adapter instead.

  • Sanitize

    3.0.0 Deprecated since version 2.4

  • Scaffold

    3.0.0 Dynamic scaffolding will be removed and replaced in 3.0

  • ScaffoldView

    3.0.0 Dynamic scaffolding will be removed and replaced in 3.0

  • Set

    3.0.0 Will be removed in 3.0. Use Hash instead.

  • ThemeView

    3.0.0 Deprecated since 2.1, use View class instead

Methods summary

  • AclComponent::grant()

    3.0.0 Will be removed in 3.0.

  • AclComponent::revoke()

    3.0.0 Will be removed in 3.0.

  • App::pluginPath()

    3.0.0 Use CakePlugin::path() instead.

  • AuthComponent::redirect()

    3.0.0 Since 2.3.0, use AuthComponent::redirectUrl() instead

  • AuthComponent::password()

    3.0.0 Since 2.4. Use Security::hash() directly or a password hasher object.

  • AuthComponent::loggedIn()

    3.0.0 Since 2.5. Use AuthComponent::user() directly.

  • BaseAuthenticate::_password()

    3.0.0 Since 2.4. Use a PasswordHasher class instead.

  • BehaviorCollection::attach()

    3.0.0 Will be removed in 3.0. Replaced with load().

  • BehaviorCollection::detach()

    3.0.0 Will be removed in 3.0. Use unload instead.

  • CakeRequest::onlyAllow()

    3.0.0 Since 2.5, use CakeRequest::allowMethod() instead.

  • CakeTestCase::assertEqual()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertNotEqual()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertPattern()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertIdentical()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertNotIdentical()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertNoPattern()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertNoErrors()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::expectError()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::expectException()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertReference()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • CakeTestCase::assertIsA()

    3.0.0 This is a compatiblity wrapper for 1.x. It will be removed in 3.0

  • Controller::httpCodes()

    3.0.0 Since 2.4. Will be removed in 3.0. Use CakeResponse::httpCodes().

  • Controller::header()

    3.0.0 Will be removed in 3.0. Use CakeResponse::header().

  • Controller::validate()

    3.0.0 This method will be removed in 3.0

  • Controller::validateErrors()

    3.0.0 This method will be removed in 3.0

  • Controller::disableCache()

    3.0.0 Will be removed in 3.0. Use CakeResponse::disableCache().

  • Controller::flash()

    3.0.0 Will be removed in 3.0. Use Session::setFlash().

  • Controller::postConditions()

    3.0.0 Will be removed in 3.0.

  • Controller::_beforeScaffold()

    3.0.0 Will be removed in 3.0.

  • Controller::_afterScaffoldSave()

    3.0.0 Will be removed in 3.0.

  • Controller::_afterScaffoldSaveError()

    3.0.0 Will be removed in 3.0.

  • Controller::_scaffoldError()

    3.0.0 Will be removed in 3.0.

  • Debugger::showError()

    3.0.0 Will be removed in 3.0. This function is superseded by Debugger::outputError().

  • Debugger::output()

    3.0.0 Use Debugger::outputAs() and Debugger::addFormat(). Will be removed in 3.0


  • Helper::__get()

    3.0.0 Accessing request properties through this method is deprecated and will be removed in 3.0.

  • Helper::__set()

    3.0.0 This method will be removed in 3.0

  • Helper::clean()

    3.0.0 This method will be removed in 3.0

  • Helper::_parseAttributes()

    3.0.0 This method will be moved to HtmlHelper in 3.0

  • Helper::_formatAttribute()

    3.0.0 This method will be moved to HtmlHelper in 3.0

  • Helper::output()

    3.0.0 This method will be removed in future versions.

  • ObjectCollection::attached()

    3.0.0 Will be removed in 3.0. Use loaded instead.

  • RequestHandlerComponent::isAjax()

    3.0.0 Use $this->request->is('ajax') instead.

  • RequestHandlerComponent::isFlash()

    3.0.0 Use $this->request->is('flash') instead.

  • RequestHandlerComponent::isSSL()

    3.0.0 Use $this->request->is('ssl') instead.

  • RequestHandlerComponent::isPost()

    3.0.0 Use $this->request->is('post'); from your controller.

  • RequestHandlerComponent::isPut()

    3.0.0 Use $this->request->is('put'); from your controller.

  • RequestHandlerComponent::isGet()

    3.0.0 Use $this->request->is('get'); from your controller.

  • RequestHandlerComponent::isDelete()

    3.0.0 Use $this->request->is('delete'); from your controller.

  • RequestHandlerComponent::setContent()

    3.0.0 Use $this->response->type() instead.

  • RequestHandlerComponent::getReferer()

    3.0.0 Use $this->request->referer() from your controller instead

  • RequestHandlerComponent::getClientIP()

    3.0.0 Use $this->request->clientIp() from your, controller instead.

  • RequestHandlerComponent::mapType()

    3.0.0 Use $this->response->mapType() in your controller instead.

  • Security::inactiveMins()

    3.0.0 Exists for backwards compatibility only, not used by the core

  • Security::cipher()

    3.0.0 Will be removed in 3.0.

  • SecurityComponent::requirePost()

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::requireGet()

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::requirePut()

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::requireDelete()

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • View::getVar()

    3.0.0 Will be removed in 3.0. Use View::get() instead.

  • View::addScript()

    3.0.0 Will be removed in 3.0. Superseded by blocks functionality.

  • ViewBlock::append()

    3.0.0 As of 2.3 use ViewBlock::concat() instead.

Properties summary

  • SecurityComponent::$requirePost

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::$requireGet

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::$requirePut

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::$requireDelete

    3.0.0 Use CakeRequest::onlyAllow() instead.

  • SecurityComponent::$disabledFields

    3.0.0 Superseded by unlockedFields.

Functions summary

  • 3.0.0 Will be removed in 3.0. Please use Cache::write() instead.

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