You are here

interface AttributeBagInterface in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/symfony/http-foundation/Session/Attribute/AttributeBagInterface.php \Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface

Attributes store.

@author Drak <drak@zikula.org>

Hierarchy

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.
   *
   * @param string $name The attribute name
   *
   * @return bool true if the attribute is defined, false otherwise
   */
  public function has($name);

  /**
   * Returns an attribute.
   *
   * @param string $name    The attribute name
   * @param mixed  $default The default value if not found
   *
   * @return mixed
   */
  public function get($name, $default = null);

  /**
   * Sets an attribute.
   *
   * @param string $name
   * @param mixed  $value
   */
  public function set($name, $value);

  /**
   * Returns attributes.
   *
   * @return array Attributes
   */
  public function all();

  /**
   * Sets attributes.
   *
   * @param array $attributes Attributes
   */
  public function replace(array $attributes);

  /**
   * Removes an attribute.
   *
   * @param string $name
   *
   * @return mixed The removed value or null when it does not exist
   */
  public function remove($name);

}

Members

Namesort descending Modifiers Type Description 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 Sets attributes. 1
AttributeBagInterface::set public function Sets an attribute. 1
SessionBagInterface::clear public function Clears out data from bag. 4
SessionBagInterface::getName public function Gets this bag's name. 4
SessionBagInterface::getStorageKey public function Gets the storage key for this bag. 4
SessionBagInterface::initialize public function Initializes the Bag. 4