summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorxjm2017-02-12 16:50:41 -0600
committerxjm2017-02-12 16:50:41 -0600
commita7c559777e446d6180c8bb53894105cbcc8f803f (patch)
tree4a852f59cb803c1e216dd4a44310f4389d140bfc
parentce118a0085104372ca3f1e9d912a8a802c3177d3 (diff)
Issue #2807785 by claudiu.cristea, OwilliwO, mpdonadio, cllamas, klausi, xjm, Berdir, Wim Leers, Mile23, daffie, Prashant.c, dawehner, sneha_surve: Move global constants from *.module files into interfaces
-rw-r--r--core/modules/aggregator/aggregator.module3
-rw-r--r--core/modules/aggregator/src/FeedStorageInterface.php5
-rw-r--r--core/modules/block/src/BlockRepositoryInterface.php14
-rw-r--r--core/modules/comment/comment.module9
-rw-r--r--core/modules/comment/src/CommentInterface.php15
-rw-r--r--core/modules/menu_ui/menu_ui.module7
-rw-r--r--core/modules/responsive_image/responsive_image.module12
-rw-r--r--core/modules/responsive_image/src/ResponsiveImageStyleInterface.php10
-rw-r--r--core/modules/system/system.module15
-rw-r--r--core/modules/update/src/UpdateFetcherInterface.php20
-rw-r--r--core/modules/update/src/UpdateManagerInterface.php25
-rw-r--r--core/modules/update/update.module31
-rw-r--r--core/modules/user/src/UserInterface.php38
-rw-r--r--core/modules/user/user.module13
14 files changed, 214 insertions, 3 deletions
diff --git a/core/modules/aggregator/aggregator.module b/core/modules/aggregator/aggregator.module
index 15b7353..cf32734 100644
--- a/core/modules/aggregator/aggregator.module
+++ b/core/modules/aggregator/aggregator.module
@@ -10,6 +10,9 @@ use Drupal\Core\Routing\RouteMatchInterface;
/**
* Denotes that a feed's items should never expire.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\aggregator\FeedStorageInterface::CLEAR_NEVER instead.
*/
const AGGREGATOR_CLEAR_NEVER = 0;
diff --git a/core/modules/aggregator/src/FeedStorageInterface.php b/core/modules/aggregator/src/FeedStorageInterface.php
index f0318fd..cf30c6a 100644
--- a/core/modules/aggregator/src/FeedStorageInterface.php
+++ b/core/modules/aggregator/src/FeedStorageInterface.php
@@ -10,6 +10,11 @@ use Drupal\Core\Entity\ContentEntityStorageInterface;
interface FeedStorageInterface extends ContentEntityStorageInterface {
/**
+ * Denotes that a feed's items should never expire.
+ */
+ const CLEAR_NEVER = 0;
+
+ /**
* Returns the fids of feeds that need to be refreshed.
*
* @return array
diff --git a/core/modules/block/src/BlockRepositoryInterface.php b/core/modules/block/src/BlockRepositoryInterface.php
index 6e3f904..9c4f871 100644
--- a/core/modules/block/src/BlockRepositoryInterface.php
+++ b/core/modules/block/src/BlockRepositoryInterface.php
@@ -5,6 +5,20 @@ namespace Drupal\block;
interface BlockRepositoryInterface {
/**
+ * Return only visible regions.
+ *
+ * @see system_region_list()
+ */
+ const REGIONS_VISIBLE = 'visible';
+
+ /**
+ * Return all regions.
+ *
+ * @see system_region_list()
+ */
+ const REGIONS_ALL = 'all';
+
+ /**
* Returns an array of regions and their block entities.
*
* @param \Drupal\Core\Cache\CacheableMetadata[] $cacheable_metadata
diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module
index aa61d7e..ae81315 100644
--- a/core/modules/comment/comment.module
+++ b/core/modules/comment/comment.module
@@ -28,16 +28,25 @@ use Drupal\user\RoleInterface;
/**
* Anonymous posters cannot enter their contact information.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\comment\CommentInterface::ANONYMOUS_MAYNOT_CONTACT instead.
*/
const COMMENT_ANONYMOUS_MAYNOT_CONTACT = 0;
/**
* Anonymous posters may leave their contact information.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\comment\CommentInterface::ANONYMOUS_MAY_CONTACT instead.
*/
const COMMENT_ANONYMOUS_MAY_CONTACT = 1;
/**
* Anonymous posters are required to leave their contact information.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\comment\CommentInterface::ANONYMOUS_MUST_CONTACT instead.
*/
const COMMENT_ANONYMOUS_MUST_CONTACT = 2;
diff --git a/core/modules/comment/src/CommentInterface.php b/core/modules/comment/src/CommentInterface.php
index 9f3360c..e80e5ed 100644
--- a/core/modules/comment/src/CommentInterface.php
+++ b/core/modules/comment/src/CommentInterface.php
@@ -23,6 +23,21 @@ interface CommentInterface extends ContentEntityInterface, EntityChangedInterfac
const PUBLISHED = 1;
/**
+ * Anonymous posters cannot enter their contact information.
+ */
+ const ANONYMOUS_MAYNOT_CONTACT = 0;
+
+ /**
+ * Anonymous posters may leave their contact information.
+ */
+ const ANONYMOUS_MAY_CONTACT = 1;
+
+ /**
+ * Anonymous posters are required to leave their contact information.
+ */
+ const ANONYMOUS_MUST_CONTACT = 2;
+
+ /**
* Determines if this comment is a reply to another comment.
*
* @return bool
diff --git a/core/modules/menu_ui/menu_ui.module b/core/modules/menu_ui/menu_ui.module
index 92254c2..bb3ec23 100644
--- a/core/modules/menu_ui/menu_ui.module
+++ b/core/modules/menu_ui/menu_ui.module
@@ -22,8 +22,11 @@ use Drupal\system\Entity\Menu;
use Drupal\node\NodeInterface;
/**
- * Maximum length of menu name as entered by the user. Database length is 32
- * and we add a menu- prefix.
+ * Maximum length of menu name as entered by the user.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Use
+ * \Drupal\Core\Config\Entity\ConfigEntityStorage::MAX_ID_LENGTH because the
+ * menu name is a configuration entity ID.
*/
const MENU_MAX_MENU_NAME_LENGTH_UI = 27;
diff --git a/core/modules/responsive_image/responsive_image.module b/core/modules/responsive_image/responsive_image.module
index 751c19b..359368d 100644
--- a/core/modules/responsive_image/responsive_image.module
+++ b/core/modules/responsive_image/responsive_image.module
@@ -16,8 +16,20 @@ use Drupal\breakpoint\BreakpointInterface;
/**
* The machine name for the empty image breakpoint image style option.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Use
+ * Drupal\responsive_image\ResponsiveImageStyleInterface::EMPTY_IMAGE
+ * instead.
*/
const RESPONSIVE_IMAGE_EMPTY_IMAGE = '_empty image_';
+
+/**
+ * The machine name for the original image breakpoint image style option.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Use
+ * \Drupal\responsive_image\ResponsiveImageStyleInterface::ORIGINAL_IMAGE
+ * instead.
+ */
const RESPONSIVE_IMAGE_ORIGINAL_IMAGE = '_original image_';
/**
diff --git a/core/modules/responsive_image/src/ResponsiveImageStyleInterface.php b/core/modules/responsive_image/src/ResponsiveImageStyleInterface.php
index a3fbc71..2267971 100644
--- a/core/modules/responsive_image/src/ResponsiveImageStyleInterface.php
+++ b/core/modules/responsive_image/src/ResponsiveImageStyleInterface.php
@@ -10,6 +10,16 @@ use Drupal\Core\Config\Entity\ConfigEntityInterface;
interface ResponsiveImageStyleInterface extends ConfigEntityInterface {
/**
+ * The machine name for the empty image breakpoint image style option.
+ */
+ const EMPTY_IMAGE = '_empty image_';
+
+ /**
+ * The machine name for the original image breakpoint image style option.
+ */
+ const ORIGINAL_IMAGE = '_original image_';
+
+ /**
* Checks if there is at least one mapping defined.
*
* @return bool
diff --git a/core/modules/system/system.module b/core/modules/system/system.module
index a637443..b6f9774 100644
--- a/core/modules/system/system.module
+++ b/core/modules/system/system.module
@@ -30,16 +30,25 @@ use GuzzleHttp\Exception\RequestException;
/**
* New users will be set to the default time zone at registration.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::TIMEZONE_DEFAULT instead.
*/
const DRUPAL_USER_TIMEZONE_DEFAULT = 0;
/**
* New users will get an empty time zone at registration.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::TIMEZONE_EMPTY instead.
*/
const DRUPAL_USER_TIMEZONE_EMPTY = 1;
/**
* New users will select their own timezone at registration.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::TIMEZONE_SELECT instead.
*/
const DRUPAL_USER_TIMEZONE_SELECT = 2;
@@ -61,6 +70,9 @@ const DRUPAL_REQUIRED = 2;
/**
* Return only visible regions.
*
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\block\BlockRepositoryInterface::REGIONS_VISIBLE instead.
+ *
* @see system_region_list()
*/
const REGIONS_VISIBLE = 'visible';
@@ -68,6 +80,9 @@ const REGIONS_VISIBLE = 'visible';
/**
* Return all regions.
*
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\block\BlockRepositoryInterface::REGIONS_ALL instead.
+ *
* @see system_region_list()
*/
const REGIONS_ALL = 'all';
diff --git a/core/modules/update/src/UpdateFetcherInterface.php b/core/modules/update/src/UpdateFetcherInterface.php
index 8d8f2a9..e9f4410 100644
--- a/core/modules/update/src/UpdateFetcherInterface.php
+++ b/core/modules/update/src/UpdateFetcherInterface.php
@@ -8,6 +8,26 @@ namespace Drupal\update;
interface UpdateFetcherInterface {
/**
+ * Project's status cannot be checked.
+ */
+ const NOT_CHECKED = -1;
+
+ /**
+ * No available update data was found for project.
+ */
+ const UNKNOWN = -2;
+
+ /**
+ * There was a failure fetching available update data for this project.
+ */
+ const NOT_FETCHED = -3;
+
+ /**
+ * We need to (re)fetch available update data for this project.
+ */
+ const FETCH_PENDING = -4;
+
+ /**
* Returns the base of the URL to fetch available update data for a project.
*
* @param array $project
diff --git a/core/modules/update/src/UpdateManagerInterface.php b/core/modules/update/src/UpdateManagerInterface.php
index d3ea88f..036138d 100644
--- a/core/modules/update/src/UpdateManagerInterface.php
+++ b/core/modules/update/src/UpdateManagerInterface.php
@@ -8,6 +8,31 @@ namespace Drupal\update;
interface UpdateManagerInterface {
/**
+ * Project is missing security update(s).
+ */
+ const NOT_SECURE = 1;
+
+ /**
+ * Current release has been unpublished and is no longer available.
+ */
+ const REVOKED = 2;
+
+ /**
+ * Current release is no longer supported by the project maintainer.
+ */
+ const NOT_SUPPORTED = 3;
+
+ /**
+ * Project has a new release available, but it is not a security release.
+ */
+ const NOT_CURRENT = 4;
+
+ /**
+ * Project is up to date.
+ */
+ const CURRENT = 5;
+
+ /**
* Fetches an array of installed and enabled projects.
*
* This is only responsible for generating an array of projects (taking into
diff --git a/core/modules/update/update.module b/core/modules/update/update.module
index f45b589..30c01b7 100644
--- a/core/modules/update/update.module
+++ b/core/modules/update/update.module
@@ -16,50 +16,79 @@ use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Site\Settings;
-// These are internally used constants for this code, do not modify.
+/*
+ * These are internally used constants for this code, do not modify.
+ */
/**
* Project is missing security update(s).
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateManagerInterface::NOT_SECURE instead.
*/
const UPDATE_NOT_SECURE = 1;
/**
* Current release has been unpublished and is no longer available.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateManagerInterface::REVOKED instead.
*/
const UPDATE_REVOKED = 2;
/**
* Current release is no longer supported by the project maintainer.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateManagerInterface::NOT_SUPPORTED instead.
*/
const UPDATE_NOT_SUPPORTED = 3;
/**
* Project has a new release available, but it is not a security release.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateManagerInterface::NOT_CURRENT instead.
*/
const UPDATE_NOT_CURRENT = 4;
/**
* Project is up to date.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateManagerInterface::CURRENT instead.
*/
const UPDATE_CURRENT = 5;
/**
* Project's status cannot be checked.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateFetcherInterface::NOT_CHECKED instead.
*/
const UPDATE_NOT_CHECKED = -1;
/**
* No available update data was found for project.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateFetcherInterface::UNKNOWN instead.
*/
const UPDATE_UNKNOWN = -2;
/**
* There was a failure fetching available update data for this project.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateFetcherInterface::NOT_FETCHED instead.
*/
const UPDATE_NOT_FETCHED = -3;
/**
* We need to (re)fetch available update data for this project.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\update\UpdateFetcherInterface::FETCH_PENDING instead.
*/
const UPDATE_FETCH_PENDING = -4;
diff --git a/core/modules/user/src/UserInterface.php b/core/modules/user/src/UserInterface.php
index 1aea757..291a149 100644
--- a/core/modules/user/src/UserInterface.php
+++ b/core/modules/user/src/UserInterface.php
@@ -14,6 +14,44 @@ use Drupal\Core\Session\AccountInterface;
interface UserInterface extends ContentEntityInterface, EntityChangedInterface, AccountInterface {
/**
+ * Maximum length of username text field.
+ *
+ * Keep this under 191 characters so we can use a unique constraint in MySQL.
+ */
+ const USERNAME_MAX_LENGTH = 60;
+
+ /**
+ * Only administrators can create user accounts.
+ */
+ const REGISTER_ADMINISTRATORS_ONLY = 'admin_only';
+
+ /**
+ * Visitors can create their own accounts.
+ */
+ const REGISTER_VISITORS = 'visitors';
+
+ /**
+ * Visitors can create accounts, but they don't become active without
+ * administrative approval.
+ */
+ const REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL = 'visitors_admin_approval';
+
+ /**
+ * New users will be set to the default time zone at registration.
+ */
+ const TIMEZONE_DEFAULT = 0;
+
+ /**
+ * New users will get an empty time zone at registration.
+ */
+ const TIMEZONE_EMPTY = 1;
+
+ /**
+ * New users will select their own timezone at registration.
+ */
+ const TIMEZONE_SELECT = 2;
+
+ /**
* Whether a user has a certain role.
*
* @param string $rid
diff --git a/core/modules/user/user.module b/core/modules/user/user.module
index 90b813f..00205a6 100644
--- a/core/modules/user/user.module
+++ b/core/modules/user/user.module
@@ -28,22 +28,35 @@ use Drupal\user\UserInterface;
* Maximum length of username text field.
*
* Keep this under 191 characters so we can use a unique constraint in MySQL.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::USERNAME_MAX_LENGTH instead.
*/
const USERNAME_MAX_LENGTH = 60;
/**
* Only administrators can create user accounts.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::REGISTER_ADMINISTRATORS_ONLY instead.
*/
const USER_REGISTER_ADMINISTRATORS_ONLY = 'admin_only';
/**
* Visitors can create their own accounts.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::REGISTER_VISITORS instead.
*/
const USER_REGISTER_VISITORS = 'visitors';
/**
* Visitors can create accounts, but they don't become active without
* administrative approval.
+ *
+ * @deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0.
+ * Use \Drupal\user\UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL
+ * instead.
*/
const USER_REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL = 'visitors_admin_approval';