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

Breadcrumb

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

interface AttributeBagInterface

Attributes store.

@author Drak <drak@zikula.org>

Hierarchy

  • interface \Symfony\Component\HttpFoundation\Session\SessionBagInterface
    • interface \Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface extends \Symfony\Component\HttpFoundation\Session\SessionBagInterface

Expanded class hierarchy of AttributeBagInterface

All classes that implement AttributeBagInterface

1 file declares its use of AttributeBagInterface
Session.php in vendor/symfony/http-foundation/Session/Session.php

File

vendor/symfony/http-foundation/Session/Attribute/AttributeBagInterface.php, line 21

Namespace

Symfony\Component\HttpFoundation\Session\Attribute
View source
interface AttributeBagInterface extends SessionBagInterface {
    
    /**
     * Checks if an attribute is defined.
     */
    public function has(string $name) : bool;
    
    /**
     * Returns an attribute.
     */
    public function get(string $name, mixed $default = null) : mixed;
    
    /**
     * Sets an attribute.
     */
    public function set(string $name, mixed $value) : void;
    
    /**
     * Returns attributes.
     *
     * @return array<string, mixed>
     */
    public function all() : array;
    public function replace(array $attributes) : void;
    
    /**
     * Removes an attribute.
     *
     * @return mixed The removed value or null when it does not exist
     */
    public function remove(string $name) : mixed;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AttributeBagInterface::all public function Returns attributes. 1
AttributeBagInterface::get public function Returns an attribute. 1
AttributeBagInterface::has public function Checks if an attribute is defined. 1
AttributeBagInterface::remove public function Removes an attribute. 1
AttributeBagInterface::replace public function 1
AttributeBagInterface::set public function Sets an attribute. 1
SessionBagInterface::clear public function Clears out data from bag. 5
SessionBagInterface::getName public function Gets this bag&#039;s name. 5
SessionBagInterface::getStorageKey public function Gets the storage key for this bag. 5
SessionBagInterface::initialize public function Initializes the Bag. 5

API Navigation

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