Skip to content
Permalink
Browse files

Update all @deprecated annotations

to adhere to the @deprecated <version> <description> format, where version and description are mandatory.
  • Loading branch information...
ravage84 committed Sep 2, 2014
1 parent 9c2a25d commit 67ba9cb40623deeddf6326c9ccff09afc27be447
@@ -22,7 +22,7 @@
* more information.
*
* @package Cake.Cache.Engine
* @deprecated You should use the Memcached adapter instead.
* @deprecated 3.0.0 You should use the Memcached adapter instead.
*/
class MemcacheEngine extends CacheEngine {
@@ -19,7 +19,7 @@
* Provides a very basic 'interactive' console for CakePHP apps.
*
* @package Cake.Console.Command
* @deprecated Deprecated since version 2.4, will be removed in 3.0
* @deprecated 3.0.0 Deprecated since version 2.4, will be removed in 3.0
*/
class ConsoleShell extends AppShell {
@@ -156,7 +156,7 @@ public function inherit($aro, $aco, $action = "*") {
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return bool Success
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
public function grant($aro, $aco, $action = "*") {
trigger_error(__d('cake_dev', '%s is deprecated, use %s instead', 'AclComponent::grant()', 'allow()'), E_USER_WARNING);
@@ -170,7 +170,7 @@ public function grant($aro, $aco, $action = "*") {
* @param array|string|Model $aco ACO The controlled object identifier. See `AclNode::node()` for possible formats
* @param string $action Action (defaults to *)
* @return bool Success
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
public function revoke($aro, $aco, $action = "*") {
trigger_error(__d('cake_dev', '%s is deprecated, use %s instead', 'AclComponent::revoke()', 'deny()'), E_USER_WARNING);
@@ -166,7 +166,7 @@ public function passwordHasher() {
*
* @param string $password The plain text password.
* @return string The hashed form of the password.
* @deprecated Since 2.4. Use a PasswordHasher class instead.
* @deprecated 3.0.0 Since 2.4. Use a PasswordHasher class instead.
*/
protected function _password($password) {
return Security::hash($password, null, true);
@@ -35,7 +35,7 @@
* @package Cake.Controller.Component.Auth
* @since CakePHP(tm) v 2.3
* @see AuthComponent::$authenticate
* @deprecated Since 2.4. Just use FormAuthenticate with 'passwordHasher' setting set to 'Blowfish'
* @deprecated 3.0.0 Since 2.4. Just use FormAuthenticate with 'passwordHasher' setting set to 'Blowfish'
*/
class BlowfishAuthenticate extends FormAuthenticate {
@@ -692,7 +692,7 @@ protected function _getUser() {
*
* @param string|array $url Optional URL to write as the login redirect URL.
* @return string Redirect URL
* @deprecated 2.3 Use AuthComponent::redirectUrl() instead
* @deprecated 3.0.0 Since 2.3.0, use AuthComponent::redirectUrl() instead
*/
public function redirect($url = null) {
return $this->redirectUrl($url);
@@ -804,7 +804,7 @@ public function constructAuthenticate() {
*
* @param string $password Password to hash
* @return string Hashed password
* @deprecated Since 2.4. Use Security::hash() directly or a password hasher object.
* @deprecated 3.0.0 Since 2.4. Use Security::hash() directly or a password hasher object.
*/
public static function password($password) {
return Security::hash($password, null, true);
@@ -814,7 +814,7 @@ public static function password($password) {
* Check whether or not the current user has data in the session, and is considered logged in.
*
* @return bool true if the user is logged in, false otherwise
* @deprecated Since 2.5. Use AuthComponent::user() directly.
* @deprecated 3.0.0 Since 2.5. Use AuthComponent::user() directly.
*/
public function loggedIn() {
return (bool)$this->user();
@@ -29,7 +29,7 @@
* @package Cake.Controller.Component
* @link http://book.cakephp.org/2.0/en/core-libraries/components/email.html
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/email.html
* @deprecated Will be removed in 3.0. Use Network/CakeEmail instead
* @deprecated 3.0.0 Will be removed in 3.0. Use Network/CakeEmail instead
*/
class EmailComponent extends Component {
@@ -292,7 +292,7 @@ public function beforeRender(Controller $controller) {
* Returns true if the current HTTP request is Ajax, false otherwise
*
* @return bool True if call is Ajax
* @deprecated use `$this->request->is('ajax')` instead.
* @deprecated 3.0.0 Use `$this->request->is('ajax')` instead.
*/
public function isAjax() {
return $this->request->is('ajax');
@@ -302,7 +302,7 @@ public function isAjax() {
* Returns true if the current HTTP request is coming from a Flash-based client
*
* @return bool True if call is from Flash
* @deprecated use `$this->request->is('flash')` instead.
* @deprecated 3.0.0 Use `$this->request->is('flash')` instead.
*/
public function isFlash() {
return $this->request->is('flash');
@@ -312,7 +312,7 @@ public function isFlash() {
* Returns true if the current request is over HTTPS, false otherwise.
*
* @return bool True if call is over HTTPS
* @deprecated use `$this->request->is('ssl')` instead.
* @deprecated 3.0.0 Use `$this->request->is('ssl')` instead.
*/
public function isSSL() {
return $this->request->is('ssl');
@@ -368,7 +368,7 @@ public function isWap() {
* Returns true if the current call a POST request
*
* @return bool True if call is a POST
* @deprecated Use $this->request->is('post'); from your controller.
* @deprecated 3.0.0 Use $this->request->is('post'); from your controller.
*/
public function isPost() {
return $this->request->is('post');
@@ -378,7 +378,7 @@ public function isPost() {
* Returns true if the current call a PUT request
*
* @return bool True if call is a PUT
* @deprecated Use $this->request->is('put'); from your controller.
* @deprecated 3.0.0 Use $this->request->is('put'); from your controller.
*/
public function isPut() {
return $this->request->is('put');
@@ -388,7 +388,7 @@ public function isPut() {
* Returns true if the current call a GET request
*
* @return bool True if call is a GET
* @deprecated Use $this->request->is('get'); from your controller.
* @deprecated 3.0.0 Use $this->request->is('get'); from your controller.
*/
public function isGet() {
return $this->request->is('get');
@@ -398,7 +398,7 @@ public function isGet() {
* Returns true if the current call a DELETE request
*
* @return bool True if call is a DELETE
* @deprecated Use $this->request->is('delete'); from your controller.
* @deprecated 3.0.0 Use $this->request->is('delete'); from your controller.
*/
public function isDelete() {
return $this->request->is('delete');
@@ -425,7 +425,7 @@ public function getAjaxVersion() {
* @param string|array $type The Content-type or array of Content-types assigned to the name,
* i.e. "text/html", or "application/xml"
* @return void
* @deprecated use `$this->response->type()` instead.
* @deprecated 3.0.0 Use `$this->response->type()` instead.
*/
public function setContent($name, $type = null) {
$this->response->type(array($name => $type));
@@ -435,7 +435,7 @@ public function setContent($name, $type = null) {
* Gets the server name from which this request was referred
*
* @return string Server address
* @deprecated use $this->request->referer() from your controller instead
* @deprecated 3.0.0 Use $this->request->referer() from your controller instead
*/
public function getReferer() {
return $this->request->referer(false);
@@ -447,7 +447,7 @@ public function getReferer() {
* @param bool $safe Use safe = false when you think the user might manipulate
* their HTTP_CLIENT_IP header. Setting $safe = false will also look at HTTP_X_FORWARDED_FOR
* @return string Client IP address
* @deprecated use $this->request->clientIp() from your, controller instead.
* @deprecated 3.0.0 Use $this->request->clientIp() from your, controller instead.
*/
public function getClientIP($safe = true) {
return $this->request->clientIp($safe);
@@ -714,7 +714,7 @@ public function responseType() {
*
* @param string|array $cType Either a string content type to map, or an array of types.
* @return string|array Aliases for the types provided.
* @deprecated Use $this->response->mapType() in your controller instead.
* @deprecated 3.0.0 Use $this->response->mapType() in your controller instead.
*/
public function mapType($cType) {
return $this->response->mapType($cType);
@@ -47,7 +47,7 @@ class SecurityComponent extends Component {
* List of controller actions for which a POST request is required
*
* @var array
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @see SecurityComponent::requirePost()
*/
public $requirePost = array();
@@ -56,7 +56,7 @@ class SecurityComponent extends Component {
* List of controller actions for which a GET request is required
*
* @var array
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @see SecurityComponent::requireGet()
*/
public $requireGet = array();
@@ -65,7 +65,7 @@ class SecurityComponent extends Component {
* List of controller actions for which a PUT request is required
*
* @var array
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @see SecurityComponent::requirePut()
*/
public $requirePut = array();
@@ -74,7 +74,7 @@ class SecurityComponent extends Component {
* List of controller actions for which a DELETE request is required
*
* @var array
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @see SecurityComponent::requireDelete()
*/
public $requireDelete = array();
@@ -117,7 +117,7 @@ class SecurityComponent extends Component {
* Deprecated property, superseded by unlockedFields.
*
* @var array
* @deprecated
* @deprecated 3.0.0 Superseded by unlockedFields.
* @see SecurityComponent::$unlockedFields
*/
public $disabledFields = array();
@@ -252,7 +252,7 @@ public function startup(Controller $controller) {
* Sets the actions that require a POST request, or empty for all actions
*
* @return void
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @link http://book.cakephp.org/2.0/en/core-libraries/components/security-component.html#SecurityComponent::requirePost
*/
public function requirePost() {
@@ -263,7 +263,7 @@ public function requirePost() {
/**
* Sets the actions that require a GET request, or empty for all actions
*
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @return void
*/
public function requireGet() {
@@ -274,7 +274,7 @@ public function requireGet() {
/**
* Sets the actions that require a PUT request, or empty for all actions
*
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @return void
*/
public function requirePut() {
@@ -285,7 +285,7 @@ public function requirePut() {
/**
* Sets the actions that require a DELETE request, or empty for all actions
*
* @deprecated Use CakeRequest::onlyAllow() instead.
* @deprecated 3.0.0 Use CakeRequest::onlyAllow() instead.
* @return void
*/
public function requireDelete() {
@@ -705,7 +705,7 @@ public function shutdownProcess() {
*
* @return array Associative array of the HTTP codes as keys, and the message
* strings as values, or null of the given $code does not exist.
* @deprecated Since 2.4. Will be removed in 3.0. Use CakeResponse::httpCodes().
* @deprecated 3.0.0 Since 2.4. Will be removed in 3.0. Use CakeResponse::httpCodes().
*/
public function httpCodes($code = null) {
return $this->response->httpCodes($code);
@@ -820,7 +820,7 @@ protected function _parseBeforeRedirect($response, $url, $status, $exit) {
*
* @param string $status The header message that is being set.
* @return void
* @deprecated Will be removed in 3.0. Use CakeResponse::header().
* @deprecated 3.0.0 Will be removed in 3.0. Use CakeResponse::header().
*/
public function header($status) {
$this->response->header($status);
@@ -874,7 +874,7 @@ public function setAction($action) {
* Returns number of errors in a submitted FORM.
*
* @return int Number of errors
* @deprecated This method will be removed in 3.0
* @deprecated 3.0.0 This method will be removed in 3.0
*/
public function validate() {
$args = func_get_args();
@@ -893,7 +893,7 @@ public function validate() {
* `$errors = $this->validateErrors($this->Article, $this->User);`
*
* @return array Validation errors, or false if none
* @deprecated This method will be removed in 3.0
* @deprecated 3.0.0 This method will be removed in 3.0
*/
public function validateErrors() {
$objects = func_get_args();
@@ -980,7 +980,7 @@ public function referer($default = null, $local = false) {
*
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::disableCache
* @deprecated Will be removed in 3.0. Use CakeResponse::disableCache().
* @deprecated 3.0.0 Will be removed in 3.0. Use CakeResponse::disableCache().
*/
public function disableCache() {
$this->response->disableCache();
@@ -997,7 +997,7 @@ public function disableCache() {
* @param string $layout Layout you want to use, defaults to 'flash'
* @return void
* @link http://book.cakephp.org/2.0/en/controllers.html#Controller::flash
* @deprecated Will be removed in 3.0. Use Session::setFlash().
* @deprecated 3.0.0 Will be removed in 3.0. Use Session::setFlash().
*/
public function flash($message, $url, $pause = 1, $layout = 'flash') {
$this->autoRender = false;
@@ -1018,7 +1018,7 @@ public function flash($message, $url, $pause = 1, $layout = 'flash') {
* @param bool $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
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
public function postConditions($data = array(), $op = null, $bool = 'AND', $exclusive = false) {
if (!is_array($data) || empty($data)) {
@@ -1148,7 +1148,7 @@ public function beforeScaffold($method) {
* @param string $method Method name.
* @return bool
* @see Controller::beforeScaffold()
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
protected function _beforeScaffold($method) {
return $this->beforeScaffold($method);
@@ -1171,7 +1171,7 @@ public function afterScaffoldSave($method) {
* @param string $method Method name.
* @return bool
* @see Controller::afterScaffoldSave()
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
protected function _afterScaffoldSave($method) {
return $this->afterScaffoldSave($method);
@@ -1194,7 +1194,7 @@ public function afterScaffoldSaveError($method) {
* @param string $method Method name.
* @return bool
* @see Controller::afterScaffoldSaveError()
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
protected function _afterScaffoldSaveError($method) {
return $this->afterScaffoldSaveError($method);
@@ -1219,7 +1219,7 @@ public function scaffoldError($method) {
* @param string $method Method name.
* @return bool
* @see Controller::scaffoldError()
* @deprecated Will be removed in 3.0.
* @deprecated 3.0.0 Will be removed in 3.0.
*/
protected function _scaffoldError($method) {
return $this->scaffoldError($method);
@@ -27,7 +27,7 @@
* scaffolded actions with custom-made ones.
*
* @package Cake.Controller
* @deprecated Dynamic scaffolding will be removed and replaced in 3.0
* @deprecated 3.0.0 Dynamic scaffolding will be removed and replaced in 3.0
*/
class Scaffold {
@@ -361,7 +361,7 @@ public static function build($paths = array(), $mode = App::PREPEND) {
* @param string $plugin CamelCased/lower_cased plugin name to find the path of.
* @return string full path to the plugin.
* @link http://book.cakephp.org/2.0/en/core-utility-libraries/app.html#App::pluginPath
* @deprecated Use CakePlugin::path() instead.
* @deprecated 3.0.0 Use CakePlugin::path() instead.
*/
public static function pluginPath($plugin) {
return CakePlugin::path($plugin);
Oops, something went wrong.

0 comments on commit 67ba9cb

Please sign in to comment.
You can’t perform that action at this time.