AttributeInterface.php

Same filename and directory in other branches
  1. 10 core/lib/Drupal/Component/Plugin/Attribute/AttributeInterface.php

Namespace

Drupal\Component\Plugin\Attribute

File

core/lib/Drupal/Component/Plugin/Attribute/AttributeInterface.php

View source
<?php

namespace Drupal\Component\Plugin\Attribute;


/**
 * Defines a common interface for classed attributes.
 */
interface AttributeInterface {
    
    /**
     * Gets the value of an attribute.
     */
    public function get() : mixed;
    
    /**
     * Gets the name of the provider of the attribute class.
     *
     * @return string|null
     */
    public function getProvider() : ?string;
    
    /**
     * Sets the name of the provider of the attribute class.
     *
     * @param string $provider
     *   The provider of the annotated class.
     */
    public function setProvider(string $provider) : void;
    
    /**
     * Gets the unique ID for this attribute class.
     *
     * @return string
     */
    public function getId() : string;
    
    /**
     * Gets the class of the attribute class.
     *
     * @return class-string|null
     */
    public function getClass() : ?string;
    
    /**
     * Sets the class of the attributed class.
     *
     * @param class-string $class
     *   The class of the attributed class.
     */
    public function setClass(string $class) : void;

}

Interfaces

Title Deprecated Summary
AttributeInterface Defines a common interface for classed attributes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.