Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #2940038 by Sweetchuck, drunken monkey, rajeshwari10, borisson_: Use $this in @return PhpDoc comments instead of the name of the current class or interface

merge-requests/55/head
Lee Rowlands 2019-08-06 15:56:28 +10:00
parent 344d8422e3
commit a7847919c4
No known key found for this signature in database
GPG Key ID: 2B829A3DF9204DC4
51 changed files with 143 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php
View File

@ -103,7 +103,7 @@ interface ContextAwarePluginInterface extends PluginInspectionInterface {
* The value to set the context to. The value has to validate against the
* provided context definition.
*
* @return \Drupal\Component\Plugin\ContextAwarePluginInterface
* @return $this
* A context aware plugin object for chaining.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException

2
core/lib/Drupal/Core/Ajax/AjaxResponse.php
View File

@ -32,7 +32,7 @@ class AjaxResponse extends JsonResponse implements AttachmentsInterface {
* A boolean which determines whether the new command should be executed
* before previously added commands. Defaults to FALSE.
*
* @return AjaxResponse
* @return $this
* The current AjaxResponse.
*/
public function addCommand(CommandInterface $command, $prepend = FALSE) {

6
core/lib/Drupal/Core/Archiver/ArchiverInterface.php
View File

@ -18,7 +18,7 @@ interface ArchiverInterface {
* The full system path of the file or directory to add. Only local files
* and directories are supported.
*
* @return \Drupal\Core\Archiver\ArchiverInterface
* @return $this
* The called object.
*/
public function add($file_path);
@ -29,7 +29,7 @@ interface ArchiverInterface {
* @param string $path
* The file name relative to the root of the archive to remove.
*
* @return \Drupal\Core\Archiver\ArchiverInterface
* @return $this
* The called object.
*/
public function remove($path);
@ -44,7 +44,7 @@ interface ArchiverInterface {
* relative to the root of the archive. If not specified, all files
* in the archive will be extracted.
*
* @return \Drupal\Core\Archiver\ArchiverInterface
* @return $this
* The called object.
*/
public function extract($path, array $files = []);

2
core/lib/Drupal/Core/Asset/AttachedAssetsInterface.php
View File

@ -21,7 +21,7 @@ interface AttachedAssetsInterface {
* @param array $render_array
* A render array.
*
* @return \Drupal\Core\Asset\AttachedAssetsInterface
* @return static
*
* @throws \LogicException
*/

4
core/lib/Drupal/Core/Cache/BackendChain.php
View File

@ -50,7 +50,7 @@ class BackendChain implements CacheBackendInterface, CacheTagsInvalidatorInterfa
* @param CacheBackendInterface $backend
* The cache backend to be appended to the cache chain.
*
* @return \Drupal\Core\Cache\BackendChain
* @return $this
* The called object.
*/
public function appendBackend(CacheBackendInterface $backend) {
@ -65,7 +65,7 @@ class BackendChain implements CacheBackendInterface, CacheTagsInvalidatorInterfa
* @param CacheBackendInterface $backend
* The backend to be prepended to the cache chain.
*
* @return \Drupal\Core\Cache\BackendChain
* @return $this
* The called object.
*/
public function prependBackend(CacheBackendInterface $backend) {

10
core/lib/Drupal/Core/Config/Config.php
View File

@ -117,7 +117,7 @@ class Config extends StorableConfigBase {
* @param array $data
* The overridden values of the configuration data.
*
* @return \Drupal\Core\Config\Config
* @return $this
* The configuration object.
*/
public function setSettingsOverride(array $data) {
@ -132,7 +132,7 @@ class Config extends StorableConfigBase {
* @param array $data
* The overridden values of the configuration data.
*
* @return \Drupal\Core\Config\Config
* @return $this
* The configuration object.
*/
public function setModuleOverride(array $data) {
@ -149,7 +149,7 @@ class Config extends StorableConfigBase {
* provided by modules. Precedence or different module overrides is
* determined by the priority of the config.factory.override tagged services.
*
* @return \Drupal\Core\Config\Config
* @return $this
* The configuration object.
*/
protected function setOverriddenData() {
@ -169,7 +169,7 @@ class Config extends StorableConfigBase {
* This method should be called after the original data or the overridden data
* has been changed.
*
* @return \Drupal\Core\Config\Config
* @return $this
* The configuration object.
*/
protected function resetOverriddenData() {
@ -236,7 +236,7 @@ class Config extends StorableConfigBase {
/**
* Deletes the configuration object.
*
* @return \Drupal\Core\Config\Config
* @return $this
* The configuration object.
*/
public function delete() {

4
core/lib/Drupal/Core/Config/ConfigImporter.php
View File

@ -248,7 +248,7 @@ class ConfigImporter {
/**
* Resets the storage comparer and processed list.
*
* @return \Drupal\Core\Config\ConfigImporter
* @return $this
* The ConfigImporter instance.
*/
public function reset() {
@ -475,7 +475,7 @@ class ConfigImporter {
/**
* Imports the changelist to the target storage.
*
* @return \Drupal\Core\Config\ConfigImporter
* @return $this
* The ConfigImporter instance.
*
* @throws \Drupal\Core\Config\ConfigException

2
core/lib/Drupal/Core/Config/PreExistingConfigException.php
View File

@ -53,7 +53,7 @@ class PreExistingConfigException extends ConfigException {
* A list of configuration objects that already exist in active
* configuration, keyed by config collection.
*
* @return \Drupal\Core\Config\PreExistingConfigException
* @return $this
*/
public static function create($extension, array $config_objects) {
$message = new FormattableMarkup('Configuration objects (@config_names) provided by @extension already exist in active configuration',

2
core/lib/Drupal/Core/Config/StorageComparerInterface.php
View File

@ -57,7 +57,7 @@ interface StorageComparerInterface {
/**
* Recalculates the differences.
*
* @return \Drupal\Core\Config\StorageComparerInterface
* @return $this
* An object which implements the StorageComparerInterface.
*/
public function reset();

2
core/lib/Drupal/Core/Config/StorageInterface.php
View File

@ -173,7 +173,7 @@ interface StorageInterface {
* configuration in a way that allows retrieval of configuration for a
* particular collection.
*
* @return \Drupal\Core\Config\StorageInterface
* @return $this
* A new instance of the storage backend with the collection set.
*/
public function createCollection($collection);

4
core/lib/Drupal/Core/Database/Query/AlterableInterface.php
View File

@ -19,7 +19,7 @@ interface AlterableInterface {
* @param $tag
* The tag to add.
*
* @return \Drupal\Core\Database\Query\AlterableInterface
* @return $this
* The called object.
*/
public function addTag($tag);
@ -76,7 +76,7 @@ interface AlterableInterface {
* @param $object
* The additional data to add to the query. May be any valid PHP variable.
*
* @return \Drupal\Core\Database\Query\AlterableInterface
* @return $this
* The called object.
*/
public function addMetaData($key, $object);

12
core/lib/Drupal/Core/Database/Query/ConditionInterface.php
View File

@ -58,7 +58,7 @@ interface ConditionInterface {
* - The operators (NOT) BETWEEN, (NOT) IN, (NOT) EXISTS, (NOT) LIKE.
* Other operators (e.g. LIKE, BINARY) may or may not work. Defaults to =.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*
* @throws \Drupal\Core\Database\InvalidQueryException
@ -83,7 +83,7 @@ interface ConditionInterface {
* @param array $args
* An associative array of arguments keyed by the named placeholders.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*/
public function where($snippet, $args = []);
@ -94,7 +94,7 @@ interface ConditionInterface {
* @param string|\Drupal\Core\Database\Query\SelectInterface $field
* The name of the field or a subquery to check.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*/
public function isNull($field);
@ -105,7 +105,7 @@ interface ConditionInterface {
* @param string|\Drupal\Core\Database\Query\SelectInterface $field
* The name of the field or a subquery to check.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*/
public function isNotNull($field);
@ -116,7 +116,7 @@ interface ConditionInterface {
* @param \Drupal\Core\Database\Query\SelectInterface $select
* The subquery that must contain results.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*/
public function exists(SelectInterface $select);
@ -127,7 +127,7 @@ interface ConditionInterface {
* @param \Drupal\Core\Database\Query\SelectInterface $select
* The subquery that must not contain results.
*
* @return \Drupal\Core\Database\Query\ConditionInterface
* @return $this
* The called object.
*/
public function notExists(SelectInterface $select);

2
core/lib/Drupal/Core/Database/Query/Insert.php
View File

@ -44,7 +44,7 @@ class Insert extends Query implements \Countable {
* @param \Drupal\Core\Database\Query\SelectInterface $query
* The query to fetch the rows that should be inserted.
*
* @return \Drupal\Core\Database\Query\Insert
* @return $this
* The called object.
*/
public function from(SelectInterface $query) {

12
core/lib/Drupal/Core/Database/Query/Merge.php
View File

@ -148,7 +148,7 @@ class Merge extends Query implements ConditionInterface {
* The table name or the subquery to be used. Use a Select query object to
* pass in a subquery.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
protected function conditionTable($table) {
@ -163,7 +163,7 @@ class Merge extends Query implements ConditionInterface {
* An associative array of fields to write into the database. The array keys
* are the field names and the values are the values to which to set them.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
public function updateFields(array $fields) {
@ -188,7 +188,7 @@ class Merge extends Query implements ConditionInterface {
* If specified, this is an array of key/value pairs for named placeholders
* corresponding to the expression.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
public function expression($field, $expression, array $arguments = NULL) {
@ -213,7 +213,7 @@ class Merge extends Query implements ConditionInterface {
* An array of fields to insert into the database. The values must be
* specified in the same order as the $fields array.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
public function insertFields(array $fields, array $values = []) {
@ -240,7 +240,7 @@ class Merge extends Query implements ConditionInterface {
* An array of values for which to use the default values
* specified in the table definition.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
public function useDefaults(array $fields) {
@ -266,7 +266,7 @@ class Merge extends Query implements ConditionInterface {
* An array of values to set into the database. The values must be
* specified in the same order as the $fields array.
*
* @return \Drupal\Core\Database\Query\Merge
* @return $this
* The called object.
*/
public function fields(array $fields, array $values = []) {

14
core/lib/Drupal/Core/Database/Query/SelectInterface.php
View File

@ -169,7 +169,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
*
* @param $distinct
* TRUE to flag this query DISTINCT, FALSE to disable it.
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function distinct($distinct = TRUE);
@ -211,7 +211,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
* An indexed array of fields present in the specified table that should be
* included in this query. If not specified, $table_alias.* will be generated
* without any aliases.
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function fields($table_alias, array $fields = []);
@ -411,7 +411,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
* @param $direction
* The direction to sort. Legal values are "ASC" and "DESC". Any other value
* will be converted to "ASC".
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function orderBy($field, $direction = 'ASC');
@ -433,7 +433,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
*
* for an example of such an alternate sorting mechanism.
*
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object
*/
public function orderRandom();
@ -449,7 +449,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
* range directives that are set.
* @param $length
* The number of records to return from the result set.
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function range($start = NULL, $length = NULL);
@ -474,7 +474,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
* @param $type
* The type of UNION to add to the query. Defaults to plain
* UNION.
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function union(SelectInterface $query, $type = '');
@ -484,7 +484,7 @@ interface SelectInterface extends ConditionInterface, AlterableInterface, Extend
*
* @param $field
* The field on which to group. This should be the field as aliased.
* @return \Drupal\Core\Database\Query\SelectInterface
* @return $this
* The called object.
*/
public function groupBy($field);

4
core/lib/Drupal/Core/Database/Query/Update.php
View File

@ -75,7 +75,7 @@ class Update extends Query implements ConditionInterface {
* An associative array of fields to write into the database. The array keys
* are the field names and the values are the values to which to set them.
*
* @return \Drupal\Core\Database\Query\Update
* @return $this
* The called object.
*/
public function fields(array $fields) {
@ -98,7 +98,7 @@ class Update extends Query implements ConditionInterface {
* If specified, this is an array of key/value pairs for named placeholders
* corresponding to the expression.
*
* @return \Drupal\Core\Database\Query\Update
* @return $this
* The called object.
*/
public function expression($field, $expression, array $arguments = NULL) {

2
core/lib/Drupal/Core/Entity/Query/ConditionAggregateInterface.php
View File

@ -24,7 +24,7 @@ interface ConditionAggregateInterface extends \Countable {
* @param string $operator
* @param string $langcode
*
* @return \Drupal\Core\Entity\Query\ConditionAggregateInterface
* @return $this
* The called object.
* @see \Drupal\Core\Entity\Query\QueryInterface::condition()
*/

12
core/lib/Drupal/Core/Entity/Query/ConditionInterface.php
View File

@ -30,7 +30,9 @@ interface ConditionInterface {
* @param mixed $value
* @param string $operator
* @param string $langcode
* @return ConditionInterface
*
* @return $this
*
* @see \Drupal\Core\Entity\Query\QueryInterface::condition()
*/
public function condition($field, $value = NULL, $operator = NULL, $langcode = NULL);
@ -40,7 +42,9 @@ interface ConditionInterface {
*
* @param string $field
* @param string $langcode
* @return ConditionInterface
*
* @return $this
*
* @see \Drupal\Core\Entity\Query\QueryInterface::exists()
*/
public function exists($field, $langcode = NULL);
@ -50,7 +54,9 @@ interface ConditionInterface {
*
* @param string $field
* @param string $langcode
* @return ConditionInterface
*
* @return $this
*
* @see \Drupal\Core\Entity\Query\QueryInterface::notExists()
*/
public function notExists($field, $langcode = NULL);

12
core/lib/Drupal/Core/Entity/Query/QueryAggregateInterface.php
View File

@ -23,7 +23,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param string $alias
* (optional) The key that will be used on the resultset.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*/
public function aggregate($field, $function, $langcode = NULL, &$alias = NULL);
@ -34,7 +34,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param string $field
* The name of the field to group by.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*/
public function groupBy($field);
@ -60,7 +60,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param string $langcode
* (optional) The language code.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*
* @see \Drupal\Core\Entity\Query\QueryInterface::condition()
@ -77,7 +77,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param $langcode
* (optional) The language code.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*/
public function existsAggregate($field, $function, $langcode = NULL);
@ -92,7 +92,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param string $langcode
* (optional) The language code.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*/
public function notExistsAggregate($field, $function, $langcode = NULL);
@ -124,7 +124,7 @@ interface QueryAggregateInterface extends QueryInterface {
* @param string $langcode
* (optional) The language code.
*
* @return \Drupal\Core\Entity\Query\QueryAggregateInterface
* @return $this
* The called object.
*/
public function sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL);

18
core/lib/Drupal/Core/Entity/Query/QueryInterface.php
View File

@ -94,7 +94,7 @@ interface QueryInterface extends AlterableInterface {
* and another does not they are not presumed to apply to the same
* translation.
*
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* @see \Drupal\Core\Entity\Query\andConditionGroup
* @see \Drupal\Core\Entity\Query\orConditionGroup
*/
@ -107,7 +107,7 @@ interface QueryInterface extends AlterableInterface {
* Name of a field.
* @param $langcode
* Language code (optional).
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
*/
public function exists($field, $langcode = NULL);
@ -118,7 +118,7 @@ interface QueryInterface extends AlterableInterface {
* Name of a field.
* @param $langcode
* Language code (optional).
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
*/
public function notExists($field, $langcode = NULL);
@ -132,7 +132,7 @@ interface QueryInterface extends AlterableInterface {
* An optional integer to distinguish between multiple pagers on one page.
* If not provided, one is automatically calculated.
*
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function pager($limit = 10, $element = NULL);
@ -140,7 +140,7 @@ interface QueryInterface extends AlterableInterface {
/**
* @param null $start
* @param null $length
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function range($start = NULL, $length = NULL);
@ -151,7 +151,7 @@ interface QueryInterface extends AlterableInterface {
* @param string $direction
* @param $langcode
* Language code (optional).
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function sort($field, $direction = 'ASC', $langcode = NULL);
@ -161,7 +161,7 @@ interface QueryInterface extends AlterableInterface {
*
* For count queries, execute() returns the number entities found.
*
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function count();
@ -175,13 +175,13 @@ interface QueryInterface extends AlterableInterface {
* specify what to sort on. This can be an entity or a field as described
* in condition().
*
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function tableSort(&$headers);
/**
* @return \Drupal\Core\Entity\Query\QueryInterface
* @return $this
* The called object.
*/
public function accessCheck($access_check = TRUE);

8
core/lib/Drupal/Core/Entity/Query/Sql/Query.php
View File

@ -86,7 +86,7 @@ class Query extends QueryBase implements QueryInterface {
/**
* Prepares the basic query with proper metadata/tags and base fields.
*
* @return \Drupal\Core\Entity\Query\Sql\Query
* @return $this
* Returns the called object.
*
* @throws \Drupal\Core\Entity\Query\QueryException
@ -165,7 +165,7 @@ class Query extends QueryBase implements QueryInterface {
/**
* Compiles the conditions.
*
* @return \Drupal\Core\Entity\Query\Sql\Query
* @return $this
* Returns the called object.
*/
protected function compile() {
@ -176,7 +176,7 @@ class Query extends QueryBase implements QueryInterface {
/**
* Adds the sort to the build query.
*
* @return \Drupal\Core\Entity\Query\Sql\Query
* @return $this
* Returns the called object.
*/
protected function addSort() {
@ -234,7 +234,7 @@ class Query extends QueryBase implements QueryInterface {
/**
* Finish the query by adding fields, GROUP BY and range.
*
* @return \Drupal\Core\Entity\Query\Sql\Query
* @return $this
* Returns the called object.
*/
protected function finish() {

8
core/lib/Drupal/Core/Entity/Query/Sql/QueryAggregate.php
View File

@ -68,7 +68,7 @@ class QueryAggregate extends Query implements QueryAggregateInterface {
/**
* Adds the aggregations to the query.
*
* @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
* @return $this
* Returns the called object.
*/
protected function addAggregate() {
@ -84,7 +84,7 @@ class QueryAggregate extends Query implements QueryAggregateInterface {
/**
* Builds the aggregation conditions part of the query.
*
* @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
* @return $this
* Returns the called object.
*/
protected function compileAggregate() {
@ -95,7 +95,7 @@ class QueryAggregate extends Query implements QueryAggregateInterface {
/**
* Adds the groupby values to the actual query.
*
* @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
* @return $this
* Returns the called object.
*/
protected function addGroupBy() {
@ -113,7 +113,7 @@ class QueryAggregate extends Query implements QueryAggregateInterface {
/**
* Builds the aggregation sort part of the query.
*
* @return \Drupal\Core\Entity\Query\Sql\QueryAggregate
* @return $this
* Returns the called object.
*/
protected function addSortAggregate() {

2
core/lib/Drupal/Core/Executable/ExecutablePluginBase.php
View File

@ -72,7 +72,7 @@ abstract class ExecutablePluginBase extends ContextAwarePluginBase implements Ex
* https://www.drupal.org/node/1764380.
* @todo This does not set a value in \Drupal::config(), so the name is confusing.
*
* @return \Drupal\Core\Executable\ExecutablePluginBase
* @return $this
* The executable object for chaining.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException

2
core/lib/Drupal/Core/Form/EnforcedResponse.php
View File

@ -37,7 +37,7 @@ class EnforcedResponse extends Response {
* @param \Exception $e
* The exception where the enforced response is to be extracted from.
*
* @return \Drupal\Core\Form\EnforcedResponse|null
* @return static|null
* The enforced response or NULL if the exception chain does not contain a
* \Drupal\Core\Form\EnforcedResponseException exception.
*/

2
core/lib/Drupal/Core/ImageToolkit/ImageToolkitInterface.php
View File

@ -52,7 +52,7 @@ interface ImageToolkitInterface extends ContainerFactoryPluginInterface, PluginI
* @param string $source
* The source path of the image file.
*
* @return \Drupal\Core\ImageToolkit\ImageToolkitInterface
* @return $this
* An instance of the current toolkit object.
*
* @throws \BadMethodCallException

2
core/lib/Drupal/Core/Language/LanguageManagerInterface.php
View File

@ -58,7 +58,7 @@ interface LanguageManagerInterface {
* LanguageInterface::TYPE_INTERFACE, or NULL to reset all language types.
* Defaults to NULL.
*
* @return \Drupal\Core\Language\LanguageManagerInterface
* @return $this
* The language manager that has been reset.
*/
public function reset($type = NULL);

2
core/lib/Drupal/Core/Menu/LocalTaskInterface.php
View File

@ -70,7 +70,7 @@ interface LocalTaskInterface {
* @param bool $active
* Sets whether this tab is active (e.g. a parent of the current tab).
*
* @return \Drupal\Core\Menu\LocalTaskInterface
* @return $this
* The called object for chaining.
*/
public function setActive($active = TRUE);

2
core/lib/Drupal/Core/Plugin/Context/EntityContext.php
View File

@ -51,7 +51,7 @@ class EntityContext extends Context {
* @param string $label
* (optional) The label of the context.
*
* @return \Drupal\Core\Plugin\Context\EntityContext
* @return static
*/
public static function fromEntity(EntityInterface $entity, $label = NULL) {
$context = static::fromEntityType($entity->getEntityType(), $label);

4
core/lib/Drupal/Core/Session/AccountSwitcherInterface.php
View File

@ -19,7 +19,7 @@ interface AccountSwitcherInterface {
* @param \Drupal\Core\Session\AccountInterface $account
* The account to switch to.
*
* @return \Drupal\Core\Session\AccountSwitcherInterface
* @return $this
* $this.
*/
public function switchTo(AccountInterface $account);
@ -27,7 +27,7 @@ interface AccountSwitcherInterface {
/**
* Reverts to a previous account after switching.
*
* @return \Drupal\Core\Session\AccountSwitcherInterface
* @return $this
* $this.
*
* @throws \RuntimeException

2
core/lib/Drupal/Core/StringTranslation/PluralTranslatableMarkup.php
View File

@ -92,7 +92,7 @@ class PluralTranslatableMarkup extends TranslatableMarkup {
* @param array $options
* An associative array of additional options. See t() for allowed keys.
*
* @return \Drupal\Core\StringTranslation\PluralTranslatableMarkup
* @return static
* A PluralTranslatableMarkup object.
*/
public static function createFromTranslatedString($count, $translated_string, array $args = [], array $options = []) {

2
core/lib/Drupal/Core/TypedData/ListDataDefinition.php
View File

@ -20,7 +20,7 @@ class ListDataDefinition extends DataDefinition implements ListDataDefinitionInt
* @param string $item_type
* The data type of the list items; e.g., 'string', 'integer' or 'any'.
*
* @return \Drupal\Core\TypedData\ListDataDefinition
* @return static
* A new List Data Definition object.
*/
public static function create($item_type) {

2
core/lib/Drupal/Core/TypedData/TypedDataInterface.php
View File

@ -97,7 +97,7 @@ interface TypedDataInterface {
* TRUE. If a property is updated from a parent object, set it to FALSE to
* avoid being notified again.
*
* @return \Drupal\Core\TypedData\TypedDataInterface
* @return $this
* Returns itself to allow for chaining.
*/
public function applyDefaultValue($notify = TRUE);

12
core/lib/Drupal/Core/Url.php
View File

@ -133,7 +133,7 @@ class Url implements TrustedCallbackInterface {
* @param array $options
* See \Drupal\Core\Url::fromUri() for details.
*
* @return \Drupal\Core\Url
* @return static
* A new Url object for a routed (internal to Drupal) URL.
*
* @see \Drupal\Core\Url::fromUserInput()
@ -149,7 +149,7 @@ class Url implements TrustedCallbackInterface {
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The route match.
*
* @return $this
* @return static
*/
public static function fromRouteMatch(RouteMatchInterface $route_match) {
if ($route_match->getRouteObject()) {
@ -254,7 +254,7 @@ class Url implements TrustedCallbackInterface {
* defined, the current scheme is used, so the user stays on HTTP or HTTPS
* respectively. TRUE enforces HTTPS and FALSE enforces HTTP.
*
* @return \Drupal\Core\Url
* @return static
* A new Url object with properties depending on the URI scheme. Call the
* access() method on this to do access checking.
*
@ -333,7 +333,7 @@ class Url implements TrustedCallbackInterface {
* @param string $uri
* The original entered URI.
*
* @return \Drupal\Core\Url
* @return static
* A new Url object for an entity's canonical route.
*
* @throws \InvalidArgumentException
@ -383,7 +383,7 @@ class Url implements TrustedCallbackInterface {
* @param array $options
* An array of options, see \Drupal\Core\Url::fromUri() for details.
*
* @return \Drupal\Core\Url
* @return static
* A new Url object for a 'internal:' URI.
*
* @throws \InvalidArgumentException
@ -432,7 +432,7 @@ class Url implements TrustedCallbackInterface {
* @param string $uri
* The original passed in URI.
*
* @return \Drupal\Core\Url
* @return static
* A new Url object for a 'route:' URI.
*
* @throws \InvalidArgumentException

24
core/modules/aggregator/src/FeedInterface.php
View File

@ -15,7 +15,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $title
* The short title of the feed.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setTitle($title);
@ -34,7 +34,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $url
* A string containing the url of the feed.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setUrl($url);
@ -53,7 +53,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param int $refresh
* The refresh rate of the feed in seconds.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setRefreshRate($refresh);
@ -72,7 +72,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param int $checked
* The timestamp of the last refresh.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setLastCheckedTime($checked);
@ -91,7 +91,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param int $queued
* The timestamp of the last refresh.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setQueuedTime($queued);
@ -110,7 +110,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $link
* A string containing the parent website of the feed.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setWebsiteUrl($link);
@ -129,7 +129,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $description
* The description of the feed.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setDescription($description);
@ -148,7 +148,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $image
* An image URL.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setImage($image);
@ -168,7 +168,7 @@ interface FeedInterface extends ContentEntityInterface {
* A string containing the calculated hash of the feed. Must contain
* US ASCII characters only.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setHash($hash);
@ -187,7 +187,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param string $etag
* A string containing the entity tag HTTP response header.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setEtag($etag);
@ -206,7 +206,7 @@ interface FeedInterface extends ContentEntityInterface {
* @param int $modified
* The timestamp when the feed was modified.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*/
public function setLastModified($modified);
@ -217,7 +217,7 @@ interface FeedInterface extends ContentEntityInterface {
* This will also reset the last checked and modified time of the feed and
* save it.
*
* @return \Drupal\aggregator\FeedInterface
* @return $this
* The class instance that this method is called on.
*
* @see \Drupal\aggregator\ItemsImporterInterface::delete()

14
core/modules/aggregator/src/ItemInterface.php
View File

@ -23,7 +23,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param int $fid
* The feed id.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setFeedId($fid);
@ -42,7 +42,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param string $title
* The title of the feed item.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setTitle($title);
@ -61,7 +61,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param string $link
* The link to the feed item.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setLink($link);
@ -80,7 +80,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param string $author
* The author name of the feed item.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setAuthor($author);
@ -99,7 +99,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param string $description
* The body of the feed item.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setDescription($description);
@ -118,7 +118,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param int $timestamp
* The posted date of the feed item, as a Unix timestamp.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setPostedTime($timestamp);
@ -137,7 +137,7 @@ interface ItemInterface extends ContentEntityInterface {
* @param string $guid
* The unique identifier for the feed item.
*
* @return \Drupal\aggregator\ItemInterface
* @return $this
* The called feed item entity.
*/
public function setGuid($guid);

6
core/modules/block_content/src/BlockContentInterface.php
View File

@ -30,7 +30,7 @@ interface BlockContentInterface extends ContentEntityInterface, EntityChangedInt
* @param string $info
* The block description.
*
* @return \Drupal\block_content\BlockContentInterface
* @return $this
* The class instance that this method is called on.
*/
public function setInfo($info);
@ -41,7 +41,7 @@ interface BlockContentInterface extends ContentEntityInterface, EntityChangedInt
* @param string $revision_log
* The revision log message.
*
* @return \Drupal\block_content\BlockContentInterface
* @return $this
* The class instance that this method is called on.
*
* @deprecated in Drupal 8.2.0, will be removed before Drupal 9.0.0. Use
@ -81,7 +81,7 @@ interface BlockContentInterface extends ContentEntityInterface, EntityChangedInt
* @param string $theme
* The theme name.
*
* @return \Drupal\block_content\BlockContentInterface
* @return $this
* The class instance that this method is called on.
*/
public function setTheme($theme);

2
core/modules/image/src/ImageStyleInterface.php
View File

@ -37,7 +37,7 @@ interface ImageStyleInterface extends ConfigEntityInterface {
* @param string $name
* The name of the image style.
*
* @return \Drupal\image\ImageStyleInterface
* @return $this
* The class instance this method is called on.
*/
public function setName($name);

2
core/modules/jsonapi/src/JsonApiResource/Data.php
View File

@ -148,7 +148,7 @@ abstract class Data implements \IteratorAggregate, \Countable {
* @param \Drupal\jsonapi\JsonApiResource\Data $b
* A Data object to be merged.
*
* @return \Drupal\jsonapi\JsonApiResource\Data
* @return static
* A new merged Data object.
*/
public static function merge(Data $a, Data $b) {

2
core/modules/jsonapi/src/Query/OffsetPage.php
View File

@ -104,7 +104,7 @@ class OffsetPage {
* @param mixed $parameter
* The `page` query parameter from the Symfony request object.
*
* @return \Drupal\jsonapi\Query\OffsetPage
* @return static
* An OffsetPage object with defaults.
*/
public static function createFromQueryParameter($parameter) {

4
core/modules/locale/src/StringStorageInterface.php
View File

@ -101,7 +101,7 @@ interface StringStorageInterface {
* @param \Drupal\locale\StringInterface $string
* The string object.
*
* @return \Drupal\locale\StringStorageInterface
* @return $this
* The called object.
*
* @throws \Drupal\locale\StringStorageException
@ -115,7 +115,7 @@ interface StringStorageInterface {
* @param \Drupal\locale\StringInterface $string
* The string object.
*
* @return \Drupal\locale\StringStorageInterface
* @return $this
* The called object.
*
* @throws \Drupal\locale\StringStorageException

2
core/modules/locale/src/TranslationString.php
View File

@ -58,7 +58,7 @@ class TranslationString extends StringBase {
* @param bool $customized
* (optional) Whether the string is customized or not. Defaults to TRUE.
*
* @return \Drupal\locale\TranslationString
* @return $this
* The called object.
*/
public function setCustomized($customized = TRUE) {

2
core/modules/media/src/MediaInterface.php
View File

@ -51,7 +51,7 @@ interface MediaInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $timestamp
* The media creation timestamp.
*
* @return \Drupal\media\MediaInterface
* @return $this
* The called media item.
*/
public function setCreatedTime($timestamp);

4
core/modules/media_library/src/MediaLibraryState.php
View File

@ -71,7 +71,7 @@ class MediaLibraryState extends ParameterBag {
* @param array $opener_parameters
* (optional) Any additional opener-specific parameter values.
*
* @return \Drupal\media_library\MediaLibraryState
* @return static
* A state object.
*/
public static function create($opener_id, array $allowed_media_type_ids, $selected_type_id, $remaining_slots, array $opener_parameters = []) {
@ -91,7 +91,7 @@ class MediaLibraryState extends ParameterBag {
* @param \Symfony\Component\HttpFoundation\Request $request
* The request.
*
* @return \Drupal\media_library\MediaLibraryState
* @return static
* A state object.
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException

12
core/modules/node/src/NodeInterface.php
View File

@ -65,7 +65,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param string $title
* The node title.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*/
public function setTitle($title);
@ -84,7 +84,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $timestamp
* The node creation timestamp.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*/
public function setCreatedTime($timestamp);
@ -103,7 +103,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param bool $promoted
* TRUE to set this node to promoted, FALSE to set it to not promoted.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*/
public function setPromoted($promoted);
@ -122,7 +122,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param bool $sticky
* TRUE to set this node to sticky, FALSE to set it to not sticky.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*/
public function setSticky($sticky);
@ -141,7 +141,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*/
public function setRevisionCreationTime($timestamp);
@ -165,7 +165,7 @@ interface NodeInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $uid
* The user ID of the revision author.
*
* @return \Drupal\node\NodeInterface
* @return $this
* The called node entity.
*
* @deprecated in drupal:8.2.0 and is removed from drupal:9.0.0. Use

2
core/modules/search/src/Plugin/SearchInterface.php
View File

@ -21,7 +21,7 @@ interface SearchInterface extends PluginInspectionInterface {
* @param array $attributes
* Array of attributes, usually from the current request object.
*
* @return \Drupal\search\Plugin\SearchInterface
* @return $this
* A search plugin object for chaining.
*/
public function setSearch($keywords, array $parameters, array $attributes);

4
core/modules/shortcut/src/ShortcutInterface.php
View File

@ -23,7 +23,7 @@ interface ShortcutInterface extends ContentEntityInterface {
* @param string $title
* The title of this shortcut.
*
* @return \Drupal\shortcut\ShortcutInterface
* @return $this
* The called shortcut entity.
*/
public function setTitle($title);
@ -42,7 +42,7 @@ interface ShortcutInterface extends ContentEntityInterface {
* @param int $weight
* The shortcut weight.
*
* @return \Drupal\shortcut\ShortcutInterface
* @return $this
* The called shortcut entity.
*/
public function setWeight($weight);

2
core/modules/shortcut/src/ShortcutSetInterface.php
View File

@ -16,7 +16,7 @@ interface ShortcutSetInterface extends ConfigEntityInterface {
* to the set. If the link is added to the end of the array and this function
* is called, it will force that link to display at the end of the list.
*
* @return \Drupal\shortcut\ShortcutSetInterface
* @return $this
* The shortcut set.
*/
public function resetLinkWeights();

2
core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
View File

@ -131,7 +131,7 @@ class GDToolkit extends ImageToolkitBase {
* @param resource $resource
* The GD image resource.
*
* @return \Drupal\system\Plugin\ImageToolkit\GDToolkit
* @return $this
* An instance of the current toolkit object.
*/
public function setResource($resource) {

2
core/modules/update/tests/modules/update_test/src/TestFileTransferWithSettingsForm.php
View File

@ -18,7 +18,7 @@ class TestFileTransferWithSettingsForm extends Local {
/**
* Returns a Drupal\update_test\TestFileTransferWithSettingsForm object.
*
* @return \Drupal\update_test\TestFileTransferWithSettingsForm
* @return static
* A new Drupal\update_test\TestFileTransferWithSettingsForm object.
*/
public static function factory($jail, $settings) {

14
core/modules/user/src/UserInterface.php
View File

@ -83,7 +83,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @param string $username
* The new user name.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function setUsername($username);
@ -102,7 +102,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @param string $password
* The new unhashed password.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function setPassword($password);
@ -113,7 +113,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @param string $mail
* The new email address of the user.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function setEmail($mail);
@ -132,7 +132,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $timestamp
* Timestamp of the last access.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function setLastAccessTime($timestamp);
@ -151,7 +151,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
* @param int $timestamp
* Timestamp of the last login time.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function setLastLoginTime($timestamp);
@ -175,7 +175,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
/**
* Activates the user.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function activate();
@ -183,7 +183,7 @@ interface UserInterface extends ContentEntityInterface, EntityChangedInterface,
/**
* Blocks the user.
*
* @return \Drupal\user\UserInterface
* @return $this
* The called user entity.
*/
public function block();

2
core/modules/workflows/src/WorkflowTypeInterface.php
View File

@ -177,7 +177,7 @@ interface WorkflowTypeInterface extends PluginWithFormsInterface, DerivativeInsp
* @param string $state_id
* The state ID to delete.
*
* @return \Drupal\workflows\WorkflowTypeInterface
* @return $this
* The workflow type plugin.
*
* @throws \InvalidArgumentException