API Update deprecations

src/Control/Controller.php

@@ -533,8 +533,7 @@ public function render($params = null)
      * 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
-     * SilverStripe\Security\BasicAuthMiddleware.URLPatterns injected property instead of setting false
+     * @deprecated 4.1.0 Add this controller's url to SilverStripe\Security\BasicAuthMiddleware.URLPatterns injected property instead of setting false
      */
     public function disableBasicAuth()
     {

src/Control/CookieJar.php

@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Control;
 
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use LogicException;
 
@@ -204,6 +205,7 @@ private function cookieIsSecure(string $sameSite, bool $secure): bool
      */
     private function getSameSite(string $name): string
     {
+        Deprecation::notice('4.12.0', 'The relevant methods will include a `$sameSite` parameter instead.');
         if ($name === session_name()) {
             return Session::config()->get('cookie_samesite');
         }

src/Control/Director.php

@@ -390,6 +390,7 @@ public function handleRequest(HTTPRequest $request)
      */
     public static function isManifestFlushed()
     {
+        Deprecation::notice('4.12.0', 'Kernel::isFlushed to be used instead');
         $kernel = Injector::inst()->get(Kernel::class);
 
         // Only CoreKernel implements this method at the moment

src/Control/Email/SwiftMailer.php

@@ -37,6 +37,11 @@ class SwiftMailer implements Mailer
      * @param Email $message
      * @return bool Whether the sending was "successful" or not
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'Will be replaced with symfony/mailer', Deprecation::SCOPE_CLASS);
+    }
+
     public function send($message)
     {
         $swiftMessage = $message->getSwiftMessage();

src/Control/Email/SwiftPlugin.php

@@ -12,6 +12,11 @@ class SwiftPlugin implements \Swift_Events_SendListener
      *
      * @param \Swift_Events_SendEvent $evt
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'Will be replaced with symfony/mailer', Deprecation::SCOPE_CLASS);
+    }
+
     public function beforeSendPerformed(\Swift_Events_SendEvent $evt)
     {
         /** @var \Swift_Message $message */

src/Control/HTTP.php

@@ -372,7 +372,7 @@ public static function get_mime_type($filename)
     /**
      * Set the maximum age of this page in web caches, in seconds.
      *
-     * @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
+     * @deprecated 4.2.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead
      * @param int $age
      */
     public static function set_cache_age($age)
@@ -384,7 +384,7 @@ public static function set_cache_age($age)
 
     /**
      * @param string $dateString
-     * @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
+     * @deprecated 4.2.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
      */
     public static function register_modification_date($dateString)
     {
@@ -394,7 +394,7 @@ public static function register_modification_date($dateString)
 
     /**
      * @param int $timestamp
-     * @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
+     * @deprecated 4.2.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead
      */
     public static function register_modification_timestamp($timestamp)
     {
@@ -403,7 +403,7 @@ public static function register_modification_timestamp($timestamp)
     }
 
     /**
-     * @deprecated 4.2.0:5.0.0 Use ChangeDetectionMiddleware instead
+     * @deprecated 4.2.0 Use ChangeDetectionMiddleware instead
      * @param string $etag
      */
     public static function register_etag($etag)
@@ -426,7 +426,7 @@ public static function register_etag($etag)
      * output directly.
      *
      * @param HTTPResponse $response
-     * @deprecated 4.2.0:5.0.0 Headers are added automatically by HTTPCacheControlMiddleware instead.
+     * @deprecated 4.2.0 Headers are added automatically by HTTPCacheControlMiddleware instead.
      */
     public static function add_cache_headers($response = null)
     {
@@ -473,13 +473,14 @@ public static function add_cache_headers($response = null)
     /**
      * Ensure that all deprecated HTTP cache settings are respected
      *
-     * @deprecated 4.2.0:5.0.0 Use HTTPCacheControlMiddleware instead
+     * @deprecated 4.2.0 Use HTTPCacheControlMiddleware instead
      * @throws \LogicException
      * @param HTTPRequest $request
      * @param HTTPResponse $response
      */
     public static function augmentState(HTTPRequest $request, HTTPResponse $response)
     {
+        Deprecation::notice('4.2.0', 'Use HTTPCacheControlMiddleware instead');
         // Skip if deprecated API is disabled
         $config = Config::forClass(HTTP::class);
         if ($config->get('ignoreDeprecatedCaching')) {
@@ -560,11 +561,12 @@ public static function augmentState(HTTPRequest $request, HTTPResponse $response
      * is always in GMT: the number of seconds since January 1 1970 00:00:00 GMT)
      *
      * @param int $timestamp
-     * @deprecated 4.2.0:5.0.0 Inline if you need this
+     * @deprecated 4.2.0 Inline if you need this
      * @return string
      */
     public static function gmt_date($timestamp)
     {
+        Deprecation::notice('4.2.0', 'Inline if you need this');
         return gmdate('D, d M Y H:i:s', $timestamp) . ' GMT';
     }
 

src/Control/HTTPRequest.php

@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Control;
 
+use SilverStripe\Dev\Deprecation;
 use ArrayAccess;
 use BadMethodCallException;
 use InvalidArgumentException;
@@ -914,6 +915,7 @@ private static function isValidHttpMethod($method)
      */
     public static function detect_method($origMethod, $postVars)
     {
+        Deprecation::notice('4.4.7');
         if (isset($postVars['_method'])) {
             if (!self::isValidHttpMethod($postVars['_method'])) {
                 throw new InvalidArgumentException('HTTPRequest::detect_method(): Invalid "_method" parameter');

src/Control/RequestProcessor.php

@@ -9,7 +9,7 @@
 /**
  * Middleware that provides back-support for the deprecated RequestFilter API.
  *
- * @deprecated 4.0.0:5.0.0 Use HTTPMiddleware directly instead.
+ * @deprecated 4.0.0 Use HTTPMiddleware directly instead.
  */
 class RequestProcessor implements HTTPMiddleware
 {
@@ -29,6 +29,7 @@ class RequestProcessor implements HTTPMiddleware
      */
     public function __construct($filters = [])
     {
+        Deprecation::notice('4.12.0', 'Use HTTPMiddleware directly instead.', Deprecation::SCOPE_CLASS);
         $this->filters = $filters;
     }
 

src/Control/Session.php

@@ -586,7 +586,7 @@ public function save(HTTPRequest $request)
      * Recursively apply the changes represented in $data to $dest.
      * Used to update $_SESSION
      *
-     * @deprecated 4.1.0:5.0.0 Use recursivelyApplyChanges() instead
+     * @deprecated 4.1.0 Use recursivelyApplyChanges() instead
      * @param array $data
      * @param array $dest
      */

src/Control/SimpleResourceURLGenerator.php

@@ -2,6 +2,7 @@
 
 namespace SilverStripe\Control;
 
+use SilverStripe\Dev\Deprecation;
 use InvalidArgumentException;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Convert;
@@ -159,12 +160,13 @@ protected function resolveModuleResource(ModuleResource $resource)
     /**
      * 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 Will be removed in 5.0 when public/ folder becomes mandatory
      * @param string $relativePath
      * @return array List of [$exists, $absolutePath, $relativePath]
      */
     protected function resolveUnsecuredResource($relativePath)
     {
+        Deprecation::notice('4.1.0', 'Will be removed in 5.0 when public/ folder becomes mandatory');
         // Check if the path requested is public-only, but we have no public folder
         $publicOnly = $this->inferPublicResourceRequired($relativePath);
         if ($publicOnly) {

src/Core/BaseKernel.php

@@ -264,6 +264,7 @@ protected function bootErrorHandling()
      */
     public function getEnvironment()
     {
+        Deprecation::notice('4.12.0', 'Use Director::get_environment_type() instead. Since 5.0 it should return only if kernel overrides. No checking SESSION or Environment.');
         // Check set
         if ($this->enviroment) {
             return $this->enviroment;
@@ -292,6 +293,7 @@ public function getEnvironment()
      */
     protected function sessionEnvironment()
     {
+        Deprecation::notice('4.12.0', 'Use Director::get_session_environment_type() instead');
         if (!$this->booted) {
             // session is not initialyzed yet, neither is manifest
             return null;

src/Core/ClassInfo.php

@@ -156,7 +156,7 @@ public static function dataClassesFor($nameOrObject)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0
+     * @deprecated 4.0.0
      * @param string $class
      * @return string
      */
@@ -371,7 +371,7 @@ public static function has_method_from($class, $method, $compclass)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0
+     * @deprecated 4.0.0
      */
     public static function table_for_object_field($candidateClass, $fieldName)
     {

src/Core/Convert.php

@@ -161,7 +161,7 @@ public static function raw2js($val)
      * Encode a value as a JSON encoded string. You can optionally pass a bitmask of
      * JSON constants as options through to the encode function.
      *
-     * @deprecated 4.4.0:5.0.0 Use json_encode() instead
+     * @deprecated 4.4.0 Use json_encode() instead
      * @param  mixed $val     Value to be encoded
      * @param  int   $options Optional bitmask of JSON constants
      * @return string           JSON encoded string
@@ -176,7 +176,7 @@ public static function raw2json($val, $options = 0)
     /**
      * Encode an array as a JSON encoded string.
      *
-     * @deprecated 4.4.0:5.0.0 Use json_encode() instead
+     * @deprecated 4.4.0 Use json_encode() instead
      * @param  array  $val     Array to convert
      * @param  int    $options Optional bitmask of JSON constants
      * @return string          JSON encoded string
@@ -261,7 +261,7 @@ public static function xml2raw($val)
     /**
      * Convert a JSON encoded string into an object.
      *
-     * @deprecated 4.4.0:5.0.0 Use json_decode() instead
+     * @deprecated 4.4.0 Use json_decode() instead
      * @param string $val
      * @return object|boolean
      */
@@ -275,7 +275,7 @@ public static function json2obj($val)
     /**
      * Convert a JSON string into an array.
      *
-     * @deprecated 4.4.0:5.0.0 Use json_decode() instead
+     * @deprecated 4.4.0 Use json_decode() instead
      * @param string $val JSON string to convert
      * @return array|boolean
      */
@@ -295,7 +295,7 @@ public static function json2array($val)
      * @param boolean $disableDoctypes Disables the use of DOCTYPE, and will trigger an error if encountered.
      * false by default.
      * @param boolean $disableExternals Does nothing because xml entities are removed
-     * @deprecated 4.11.0:5.0.0
+     * @deprecated 4.11.0
      * @return array
      * @throws Exception
      */

src/Core/Injector/Injector.php

@@ -854,7 +854,7 @@ protected function setObjectProperty($object, $name, $value)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0 Use Injector::has() instead
+     * @deprecated 4.0.0 Use Injector::has() instead
      * @param $name
      * @return string
      */

src/Core/Manifest/Module.php

@@ -210,6 +210,7 @@ public function __unserialize(array $data): void
      */
     public function serialize()
     {
+        Deprecation::notice('4.12.0', 'Will be removed in 5.0');
         return json_encode([$this->path, $this->basePath, $this->composerData]);
     }
 
@@ -223,6 +224,7 @@ public function serialize()
      */
     public function unserialize($serialized)
     {
+        Deprecation::notice('4.12.0', 'Will be removed in 5.0');
         list($this->path, $this->basePath, $this->composerData) = json_decode($serialized ?? '', true);
         $this->resources = [];
     }
@@ -275,7 +277,7 @@ public function getResource($path)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0 Use getResource($path)->getRelativePath() instead
+     * @deprecated 4.0.0 Use getResource($path)->getRelativePath() instead
      * @param string $path
      * @return string
      */
@@ -288,7 +290,7 @@ public function getRelativeResourcePath($path)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0 Use ->getResource($path)->getPath() instead
+     * @deprecated 4.0.0 Use ->getResource($path)->getPath() instead
      * @param string $path
      * @return string
      */
@@ -301,7 +303,7 @@ public function getResourcePath($path)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0 Use ->getResource($path)->getURL() instead
+     * @deprecated 4.0.0 Use ->getResource($path)->getURL() instead
      * @param string $path
      * @return string
      */
@@ -314,7 +316,7 @@ public function getResourceURL($path)
     }
 
     /**
-     * @deprecated 4.0.0:5.0.0 Use ->getResource($path)->exists() instead
+     * @deprecated 4.0.0 Use ->getResource($path)->exists() instead
      * @param string $path
      * @return string
      */

src/Core/Startup/AbstractConfirmationToken.php

@@ -39,6 +39,11 @@ abstract class AbstractConfirmationToken
      * @param HTTPRequest $request
      * @return static The token container for the unvalidated $key given with the highest priority
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'To be removed in SilverStripe 5.0', Deprecation::SCOPE_CLASS);
+    }
+
     public static function prepare_tokens($keys, HTTPRequest $request)
     {
         $target = null;

src/Core/Startup/ConfirmationTokenChain.php

@@ -25,6 +25,11 @@ class ConfirmationTokenChain
     /**
      * @param AbstractConfirmationToken $token
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'To be removed in SilverStripe 5.0', Deprecation::SCOPE_CLASS);
+    }
+
     public function pushToken(AbstractConfirmationToken $token)
     {
         $this->tokens[] = $token;

src/Core/Startup/ErrorControlChain.php

@@ -62,6 +62,11 @@ class ErrorControlChain
      *
      * @return bool
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'To be removed in SilverStripe 5.0', Deprecation::SCOPE_CLASS);
+    }
+
     public function hasErrored()
     {
         return $this->error;

src/Core/Startup/ErrorDirector.php

@@ -27,6 +27,11 @@ class ErrorDirector extends Director
      * @param Kernel $kernel
      * @return null|HTTPResponse Redirection response, or null if not able to redirect
      */
+    public function __construct()
+    {
+        Deprecation::notice('4.12.0', 'To be removed in SilverStripe 5.0', Deprecation::SCOPE_CLASS);
+    }
+
     public function handleRequestWithTokenChain(
         HTTPRequest $request,
         ConfirmationTokenChain $confirmationTokenChain,

src/Core/Startup/ParameterConfirmationToken.php

@@ -47,6 +47,7 @@ class ParameterConfirmationToken extends AbstractConfirmationToken
      */
     public function __construct($parameterName, HTTPRequest $request)
     {
+        Deprecation::notice('4.12.0', 'To be removed in SilverStripe 5.0', Deprecation::SCOPE_CLASS);
         // Store the parameter name
         $this->parameterName = $parameterName;
         $this->request = $request;