Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Alias.php

class Alias

Same name in this branch
  1. 11.1.x vendor/nikic/php-parser/lib/PhpParser/Node/Stmt/TraitUseAdaptation/Alias.php \PhpParser\Node\Stmt\TraitUseAdaptation\Alias
  2. 11.1.x vendor/symfony/routing/Alias.php \Symfony\Component\Routing\Alias

Hierarchy

  • class \Symfony\Component\DependencyInjection\Alias

Expanded class hierarchy of Alias

16 files declare their use of Alias
AbstractConfigurator.php in vendor/symfony/dependency-injection/Loader/Configurator/AbstractConfigurator.php
AliasConfigurator.php in vendor/symfony/dependency-injection/Loader/Configurator/AliasConfigurator.php
AutoAliasServicePass.php in vendor/symfony/dependency-injection/Compiler/AutoAliasServicePass.php
BackendCompilerPass.php in core/lib/Drupal/Core/DependencyInjection/Compiler/BackendCompilerPass.php
ContainerBuilder.php in core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php

... See full list

23 string references to 'Alias'
AliasRepository::preloadPathAlias in core/modules/path_alias/src/AliasRepository.php
d7_url_alias.yml in core/modules/path/migrations/d7_url_alias.yml
core/modules/path/migrations/d7_url_alias.yml
DataFieldRow::buildOptionsForm in core/modules/rest/src/Plugin/views/row/DataFieldRow.php
Provide a form for setting options.
DataFieldRow::init in core/modules/rest/src/Plugin/views/row/DataFieldRow.php
Initialize the plugin.
DataFieldRow::validateOptionsForm in core/modules/rest/src/Plugin/views/row/DataFieldRow.php
Validate the options form.

... See full list

File

vendor/symfony/dependency-injection/Alias.php, line 16

Namespace

Symfony\Component\DependencyInjection
View source
class Alias {
    private const DEFAULT_DEPRECATION_TEMPLATE = 'The "%alias_id%" service alias is deprecated. You should stop using it, as it will be removed in the future.';
    private array $deprecation = [];
    public function __construct(string $id, bool $public = false) {
    }
    
    /**
     * Checks if this DI Alias should be public or not.
     */
    public function isPublic() : bool {
        return $this->public;
    }
    
    /**
     * Sets if this Alias is public.
     *
     * @return $this
     */
    public function setPublic(bool $boolean) : static {
        $this->public = $boolean;
        return $this;
    }
    
    /**
     * Whether this alias is private.
     */
    public function isPrivate() : bool {
        return !$this->public;
    }
    
    /**
     * Whether this alias is deprecated, that means it should not be referenced
     * anymore.
     *
     * @param string $package The name of the composer package that is triggering the deprecation
     * @param string $version The version of the package that introduced the deprecation
     * @param string $message The deprecation message to use
     *
     * @return $this
     *
     * @throws InvalidArgumentException when the message template is invalid
     */
    public function setDeprecated(string $package, string $version, string $message) : static {
        if ('' !== $message) {
            if (preg_match('#[\\r\\n]|\\*/#', $message)) {
                throw new InvalidArgumentException('Invalid characters found in deprecation template.');
            }
            if (!str_contains($message, '%alias_id%')) {
                throw new InvalidArgumentException('The deprecation template must contain the "%alias_id%" placeholder.');
            }
        }
        $this->deprecation = [
            'package' => $package,
            'version' => $version,
            'message' => $message ?: self::DEFAULT_DEPRECATION_TEMPLATE,
        ];
        return $this;
    }
    public function isDeprecated() : bool {
        return (bool) $this->deprecation;
    }
    
    /**
     * @param string $id Service id relying on this definition
     */
    public function getDeprecation(string $id) : array {
        return [
            'package' => $this->deprecation['package'],
            'version' => $this->deprecation['version'],
            'message' => str_replace('%alias_id%', $id, $this->deprecation['message']),
        ];
    }
    public function __toString() : string {
        return $this->id;
    }

}

Members

Title Sort descending Modifiers Object type Summary
Alias::$deprecation private property
Alias::DEFAULT_DEPRECATION_TEMPLATE private constant
Alias::getDeprecation public function
Alias::isDeprecated public function
Alias::isPrivate public function Whether this alias is private.
Alias::isPublic public function Checks if this DI Alias should be public or not.
Alias::setDeprecated public function Whether this alias is deprecated, that means it should not be referenced
anymore.
Alias::setPublic public function Sets if this Alias is public.
Alias::__construct public function
Alias::__toString public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal