tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Update deprecation PHPDocs to be PSR-5 compliant

Browse Source 
See: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#55-deprecated
This commit is contained in:
Robbie Averill 2018-09-28 10:46:36 +02:00
parent aec562f048
commit f842ee2eec
29 changed files with 63 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/Control/Controller.php
View File

@ -63,7 +63,7 @@ class Controller extends RequestHandler implements TemplateGlobalProvider
protected $templates = [];
/**
* @deprecated 4.1.0...5.0.0 Add this controller's url to
* @deprecated 4.1.0:5.0.0 Add this controller's url to
* SilverStripe\Security\BasicAuthMiddleware.URLPatterns injected property instead of setting false
* @var bool
*/
@ -531,7 +531,7 @@ class Controller extends RequestHandler implements TemplateGlobalProvider
* called before Controller::init(). That is, you must call it in your controller's init method
* before it calls parent::init().
*
* @deprecated 4.1.0...5.0.0 Add this controller's url to
* @deprecated 4.1.0:5.0.0 Add this controller's url to
* SilverStripe\Security\BasicAuthMiddleware.URLPatterns injected property instead of setting false
*/
public function disableBasicAuth()

28
src/Control/HTTP.php
View File

@ -21,19 +21,19 @@ class HTTP
use Configurable;
/**
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
* @var int
*/
protected static $cache_age = 0;
/**
* @deprecated 4.2..5.0 Handled by HTTPCacheControlMiddleware
* @deprecated 4.2.0:5.0.0 Handled by HTTPCacheControlMiddleware
* @var int
*/
protected static $modification_date = null;
/**
* @deprecated 4.2..5.0 Handled by ChangeDetectionMiddleware
* @deprecated 4.2.0:5.0.0 Handled by ChangeDetectionMiddleware
* @var string
*/
protected static $etag = null;
@ -41,7 +41,7 @@ class HTTP
/**
* @config
* @var bool
* @deprecated 4.2..5.0 'HTTP.cache_ajax_requests config is deprecated.
* @deprecated 4.2.0:5.0.0 'HTTP.cache_ajax_requests config is deprecated.
* Use HTTPCacheControlMiddleware::disableCache() instead'
*/
private static $cache_ajax_requests = false;
@ -49,7 +49,7 @@ class HTTP
/**
* @config
* @var bool
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware.defaultState/.defaultForcingLevel instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware.defaultState/.defaultForcingLevel instead
*/
private static $disable_http_cache = false;
@ -71,7 +71,7 @@ class HTTP
/**
* List of names to add to the Cache-Control header.
*
* @deprecated 4.2..5.0 Handled by HTTPCacheControlMiddleware instead
* @deprecated 4.2.0:5.0.0 Handled by HTTPCacheControlMiddleware instead
* @see HTTPCacheControlMiddleware::__construct()
* @config
* @var array Keys are cache control names, values are boolean flags
@ -81,7 +81,7 @@ class HTTP
/**
* Vary string; A comma separated list of var header names
*
* @deprecated 4.2..5.0 Handled by HTTPCacheControlMiddleware instead
* @deprecated 4.2.0:5.0.0 Handled by HTTPCacheControlMiddleware instead
* @config
* @var string|null
*/
@ -372,7 +372,7 @@ class HTTP
/**
* Set the maximum age of this page in web caches, in seconds.
*
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
* @param int $age
*/
public static function set_cache_age($age)
@ -384,7 +384,7 @@ class HTTP
/**
* @param string $dateString
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
*/
public static function register_modification_date($dateString)
{
@ -394,7 +394,7 @@ class HTTP
/**
* @param int $timestamp
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
*/
public static function register_modification_timestamp($timestamp)
{
@ -403,7 +403,7 @@ class HTTP
}
/**
* @deprecated 4.2..5.0 Use ChangeDetectionMiddleware instead
* @deprecated 4.2.0:5.0.0 Use ChangeDetectionMiddleware instead
* @param string $etag
*/
public static function register_etag($etag)
@ -426,7 +426,7 @@ class HTTP
* output directly.
*
* @param HTTPResponse $response
* @deprecated 4.2..5.0 Headers are added automatically by HTTPCacheControlMiddleware instead.
* @deprecated 4.2.0:5.0.0 Headers are added automatically by HTTPCacheControlMiddleware instead.
*/
public static function add_cache_headers($response = null)
{
@ -473,7 +473,7 @@ class HTTP
/**
* Ensure that all deprecated HTTP cache settings are respected
*
* @deprecated 4.2..5.0 Use HTTPCacheControlMiddleware instead
* @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware instead
* @throws \LogicException
* @param HTTPRequest $request
* @param HTTPResponse $response
@ -560,7 +560,7 @@ class HTTP
* is always in GMT: the number of seconds since January 1 1970 00:00:00 GMT)
*
* @param int $timestamp
* @deprecated 4.2..5.0 Inline if you need this
* @deprecated 4.2.0:5.0.0 Inline if you need this
* @return string
*/
public static function gmt_date($timestamp)

2
src/Control/RequestFilter.php
View File

@ -9,7 +9,7 @@ namespace SilverStripe\Control;
*
* @author marcus@silverstripe.com.au
* @license BSD License http://silverstripe.org/bsd-license/
* @deprecated 4.0..5.0 Use HTTPMiddleware instead
* @deprecated 4.0.0:5.0.0 Use HTTPMiddleware instead
*/
interface RequestFilter
{

2
src/Control/RequestProcessor.php
View File

@ -9,7 +9,7 @@ use SilverStripe\Dev\Deprecation;
/**
* Middleware that provides back-support for the deprecated RequestFilter API.
*
* @deprecated 4.0..5.0 Use HTTPMiddleware directly instead.
* @deprecated 4.0.0:5.0.0 Use HTTPMiddleware directly instead.
*/
class RequestProcessor implements HTTPMiddleware
{

2
src/Control/Session.php
View File

@ -529,7 +529,7 @@ class Session
* Recursively apply the changes represented in $data to $dest.
* Used to update $_SESSION
*
* @deprecated 4.1...5.0 Use recursivelyApplyChanges() instead
* @deprecated 4.1.0:5.0.0 Use recursivelyApplyChanges() instead
* @param array $data
* @param array $dest
*/

2
src/Control/SimpleResourceURLGenerator.php
View File

@ -151,7 +151,7 @@ class SimpleResourceURLGenerator implements ResourceURLGenerator
/**
* Resolve resource in the absence of a public/ folder
*
* @deprecated 4.1.0...5.0.0 Will be removed in 5.0 when public/ folder becomes mandatory
* @deprecated 4.1.0:5.0.0 Will be removed in 5.0 when public/ folder becomes mandatory
* @param string $relativePath
* @return array List of [$exists, $absolutePath, $relativePath]
*/

4
src/Core/ClassInfo.php
View File

@ -155,7 +155,7 @@ class ClassInfo
}
/**
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @param string $class
* @return string
*/
@ -368,7 +368,7 @@ class ClassInfo
}
/**
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
public static function table_for_object_field($candidateClass, $fieldName)
{

2
src/Core/Extensible.php
View File

@ -108,7 +108,7 @@ trait Extensible
}
/**
* @deprecated 4.0..5.0 Extensions and methods are now lazy-loaded
* @deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded
*/
protected function constructExtensions()
{

10
src/Core/Manifest/Module.php
View File

@ -11,7 +11,7 @@ use SilverStripe\Dev\Deprecation;
class Module implements Serializable
{
/**
* @deprecated 4.1..5.0 Use Path::normalise() instead
* @deprecated 4.1.0:5.0.0 Use Path::normalise() instead
*/
const TRIM_CHARS = ' /\\';
@ -207,7 +207,7 @@ class Module implements Serializable
}
/**
* @deprecated 4.0...5.0 Use getResource($path)->getRelativePath() instead
* @deprecated 4.0.0:5.0.0 Use getResource($path)->getRelativePath() instead
* @param string $path
* @return string
*/
@ -220,7 +220,7 @@ class Module implements Serializable
}
/**
* @deprecated 4.0...5.0 Use ->getResource($path)->getPath() instead
* @deprecated 4.0.0:5.0.0 Use ->getResource($path)->getPath() instead
* @param string $path
* @return string
*/
@ -233,7 +233,7 @@ class Module implements Serializable
}
/**
* @deprecated 4.0...5.0 Use ->getResource($path)->getURL() instead
* @deprecated 4.0.0:5.0.0 Use ->getResource($path)->getURL() instead
* @param string $path
* @return string
*/
@ -246,7 +246,7 @@ class Module implements Serializable
}
/**
* @deprecated 4.0...5.0 Use ->getResource($path)->exists() instead
* @deprecated 4.0.0:5.0.0 Use ->getResource($path)->exists() instead
* @param string $path
* @return string
*/

6
src/Dev/FunctionalTest.php
View File

@ -45,7 +45,7 @@ class FunctionalTest extends SapphireTest implements TestOnly
/**
* Set this to true on your sub-class to use the draft site by default for every test in this class.
*
* @deprecated 4.2..5.0 Use ?stage=Stage in your ->get() querystring requests instead
* @deprecated 4.2.0:5.0.0 Use ?stage=Stage in your ->get() querystring requests instead
* @var bool
*/
protected static $use_draft_site = false;
@ -404,7 +404,7 @@ class FunctionalTest extends SapphireTest implements TestOnly
* This is helpful if you're not testing publication functionality and don't want "stage management" cluttering
* your test.
*
* @deprecated 4.2..5.0 Use ?stage=Stage querystring arguments instead of useDraftSite
* @deprecated 4.2.0:5.0.0 Use ?stage=Stage querystring arguments instead of useDraftSite
* @param bool $enabled toggle the use of the draft site
*/
public function useDraftSite($enabled = true)
@ -428,7 +428,7 @@ class FunctionalTest extends SapphireTest implements TestOnly
}
/**
* @deprecated 4.2..5.0 Use ?stage=Stage in your querystring arguments instead
* @deprecated 4.2.0:5.0.0 Use ?stage=Stage in your querystring arguments instead
* @return bool
*/
public static function get_use_draft_site()

4
src/Dev/Install/InstallEnvironmentAware.php
View File

@ -107,7 +107,7 @@ trait InstallEnvironmentAware
{
$base = $this->getBaseDir();
if (is_dir($base . 'mysite')) {
/** @deprecated 4.2..5.0 */
/** @deprecated 4.2.0:5.0.0 */
return 'mysite';
}
@ -124,7 +124,7 @@ trait InstallEnvironmentAware
{
$projectDir = $this->getProjectDir();
if ($projectDir === 'mysite') {
/** @deprecated 4.2..5.0 */
/** @deprecated 4.2.0:5.0.0 */
return $projectDir . DIRECTORY_SEPARATOR . 'code';
}

6
src/Dev/SapphireTest.php
View File

@ -416,7 +416,7 @@ class SapphireTest extends PHPUnit_Framework_TestCase implements TestOnly
}
/**
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @return FixtureFactory|false
*/
public function getFixtureFactory()
@ -429,7 +429,7 @@ class SapphireTest extends PHPUnit_Framework_TestCase implements TestOnly
/**
* Sets a new fixture factory
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @param FixtureFactory $factory
* @return $this
*/
@ -504,7 +504,7 @@ class SapphireTest extends PHPUnit_Framework_TestCase implements TestOnly
* Load a YAML fixture file into the database.
* Once loaded, you can use idFromFixture() and objFromFixture() to get items from the fixture.
* Doesn't clear existing fixtures.
* @deprecated 4.0...5.0
* @deprecated 4.0.0:5.0.0
*
* @param string $fixtureFile The location of the .yml fixture file, relative to the site base dir
*/

2
src/Forms/FieldList.php
View File

@ -183,7 +183,7 @@ class FieldList extends ArrayList
}
/**
* @deprecated 4.1..5.0 Please use dataFields or saveableFields
* @deprecated 4.1.0:5.0.0 Please use dataFields or saveableFields
* @param $list
* @param bool $saveableOnly
*/

2
src/Forms/GridField/GridFieldVersionedState.php
View File

@ -11,7 +11,7 @@ if (!class_exists(VersionedGridFieldState::class)) {
/**
* @deprecated 4.1..5.0
* @deprecated 4.1.0:5.0.0
*/
class GridFieldVersionedState extends VersionedGridFieldState
{

4
src/Forms/HTMLEditor/TinyMCEConfig.php
View File

@ -827,7 +827,7 @@ class TinyMCEConfig extends HTMLEditorConfig
}
/**
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
public function getTinyMCEPath()
{
@ -837,7 +837,7 @@ class TinyMCEConfig extends HTMLEditorConfig
/**
* @return Module
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
protected function getAdminModule()
{

2
src/Forms/HTMLEditor/TinyMCEGZIPGenerator.php
View File

@ -11,7 +11,7 @@ use TinyMCE_Compressor;
/**
* Uses the default tiny_mc_gzip.php handler
*
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
class TinyMCEGZIPGenerator implements TinyMCEScriptGenerator
{

4
src/Forms/TreeDropdownField.php
View File

@ -600,7 +600,7 @@ class TreeDropdownField extends FormField
/**
* HTML-encoded label for this node, including css classes and other markup.
*
* @deprecated 4.0...5.0 Use setTitleField()
* @deprecated 4.0.0:5.0.0 Use setTitleField()
* @param string $field
* @return $this
*/
@ -613,7 +613,7 @@ class TreeDropdownField extends FormField
/**
* HTML-encoded label for this node, including css classes and other markup.
*
* @deprecated 4.0...5.0 Use getTitleField()
* @deprecated 4.0.0:5.0.0 Use getTitleField()
* @return string
*/
public function getLabelField()

2
src/ORM/Connect/DBSchemaManager.php
View File

@ -57,7 +57,7 @@ abstract class DBSchemaManager
/**
* @param string
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
public static function showTableNameWarning($table, $class)
{

4
src/ORM/DataObject.php
View File

@ -139,7 +139,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
private static $default_classname = null;
/**
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @var bool
*/
public $destroyed = false;
@ -498,7 +498,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
/**
* Copies the many_many and belongs_many_many relations from one object to another instance of the name of object.
*
* @deprecated 4.1...5.0 Use duplicateRelations() instead
* @deprecated 4.1.0:5.0.0 Use duplicateRelations() instead
* @param DataObject $sourceObject the source object to duplicate from
* @param DataObject $destinationObject the destination object to populate with the duplicated relations
* @param bool|string $filter

2
src/Security/LoginAttempt.php
View File

@ -15,7 +15,7 @@ use SilverStripe\ORM\DataObject;
* complies with your privacy standards. We're logging
* username and IP.
*
* @property string $Email Email address used for login attempt. @deprecated 3.0...5.0
* @property string $Email Email address used for login attempt. @deprecated 3.0.0:5.0.0
* @property string $EmailHashed sha1 hashed Email address used for login attempt
* @property string $Status Status of the login attempt, either 'Success' or 'Failure'
* @property string $IP IP address of user attempting to login

4
src/Security/Member.php
View File

@ -282,7 +282,7 @@ class Member extends DataObject
/**
* Get the default admin record if it exists, or creates it otherwise if enabled
*
* @deprecated 4.0.0...5.0.0 Use DefaultAdminService::findOrCreateDefaultAdmin() instead
* @deprecated 4.0.0:5.0.0 Use DefaultAdminService::findOrCreateDefaultAdmin() instead
* @return Member
*/
public static function default_admin()
@ -294,7 +294,7 @@ class Member extends DataObject
/**
* Check if the passed password matches the stored one (if the member is not locked out).
*
* @deprecated 4.0.0...5.0.0 Use Authenticator::checkPassword() instead
* @deprecated 4.0.0:5.0.0 Use Authenticator::checkPassword() instead
*
* @param string $password
* @return ValidationResult

14
src/Security/Security.php
View File

@ -1062,7 +1062,7 @@ class Security extends Controller implements TemplateGlobalProvider
*
* @return Member
*
* @deprecated 4.0.0..5.0.0 Please use DefaultAdminService::findOrCreateDefaultAdmin()
* @deprecated 4.0.0:5.0.0 Please use DefaultAdminService::findOrCreateDefaultAdmin()
*/
public static function findAnAdministrator()
{
@ -1075,7 +1075,7 @@ class Security extends Controller implements TemplateGlobalProvider
/**
* Flush the default admin credentials
*
* @deprecated 4.0.0..5.0.0 Please use DefaultAdminService::clearDefaultAdmin()
* @deprecated 4.0.0:5.0.0 Please use DefaultAdminService::clearDefaultAdmin()
*/
public static function clear_default_admin()
{
@ -1096,7 +1096,7 @@ class Security extends Controller implements TemplateGlobalProvider
* @param string $password The password (in cleartext)
* @return bool True if successfully set
*
* @deprecated 4.0.0..5.0.0 Please use DefaultAdminService::setDefaultAdmin($username, $password)
* @deprecated 4.0.0:5.0.0 Please use DefaultAdminService::setDefaultAdmin($username, $password)
*/
public static function setDefaultAdmin($username, $password)
{
@ -1114,7 +1114,7 @@ class Security extends Controller implements TemplateGlobalProvider
* @param string $password
* @return bool
*
* @deprecated 4.0.0..5.0.0 Use DefaultAdminService::isDefaultAdminCredentials() instead
* @deprecated 4.0.0:5.0.0 Use DefaultAdminService::isDefaultAdminCredentials() instead
*/
public static function check_default_admin($username, $password)
{
@ -1127,7 +1127,7 @@ class Security extends Controller implements TemplateGlobalProvider
/**
* Check that the default admin account has been set.
*
* @deprecated 4.0.0..5.0.0 Use DefaultAdminService::hasDefaultAdmin() instead
* @deprecated 4.0.0:5.0.0 Use DefaultAdminService::hasDefaultAdmin() instead
*/
public static function has_default_admin()
{
@ -1139,7 +1139,7 @@ class Security extends Controller implements TemplateGlobalProvider
/**
* Get default admin username
*
* @deprecated 4.0.0..5.0.0 Use DefaultAdminService::getDefaultAdminUsername()
* @deprecated 4.0.0:5.0.0 Use DefaultAdminService::getDefaultAdminUsername()
* @return string
*/
public static function default_admin_username()
@ -1152,7 +1152,7 @@ class Security extends Controller implements TemplateGlobalProvider
/**
* Get default admin password
*
* @deprecated 4.0.0..5.0.0 Use DefaultAdminService::getDefaultAdminPassword()
* @deprecated 4.0.0:5.0.0 Use DefaultAdminService::getDefaultAdminPassword()
* @return string
*/
public static function default_admin_password()

2
src/View/Requirements.php
View File

@ -331,7 +331,7 @@ class Requirements implements Flushable
* 'framework/javascript/lang'
* @param bool $return Return all relative file paths rather than including them in
* requirements
* @param bool $langOnly @deprecated 4.1...5.0 as i18n.js should be included manually in your project
* @param bool $langOnly @deprecated 4.1.0:5.0.0 as i18n.js should be included manually in your project
*
* @return array
*/

2
src/View/Requirements_Backend.php
View File

@ -222,7 +222,7 @@ class Requirements_Backend
/**
* Gets the minification service for this backend
*
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @return Requirements_Minifier
*/
public function getMinifier()

2
src/View/Requirements_Minifier.php
View File

@ -5,7 +5,7 @@ namespace SilverStripe\View;
/**
* Provides an abstract interface for minifying content
*
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
*/
interface Requirements_Minifier
{

2
src/View/SSViewer.php
View File

@ -74,7 +74,7 @@ class SSViewer implements Flushable
* The used "theme", which usually consists of templates, images and stylesheets.
* Only used when {@link $theme_enabled} is set to TRUE, and $themes is empty
*
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @config
* @var string
*/

2
src/View/ViewableData.php
View File

@ -611,7 +611,7 @@ class ViewableData implements IteratorAggregate
* project directory.
*
* @return string URL to the current theme
* @deprecated 4.0.0..5.0.0 Use $resourcePath or $resourceURL template helpers instead
* @deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
*/
public function ThemeDir()
{

2
src/conf/ConfigureFromEnv.php
View File

@ -1,7 +1,7 @@
<?php
/**
* @deprecated 4.0...5.0
* @deprecated 4.0.0:5.0.0
*
* Placeholder empty file
*/

2
tests/php/Security/BasicAuthTest/ControllerNotSecured.php
View File

@ -15,7 +15,7 @@ class ControllerNotSecured extends Controller implements TestOnly
/**
* Disable legacy global-enable
*
* @deprecated 4.0..5.0
* @deprecated 4.0.0:5.0.0
* @var bool
*/
protected $basicAuthEnabled = false;