class BreakpointGroup

Defines the BreakpointGroup entity.

Plugin annotation


@Plugin(
  id = "breakpoint_group",
  label = @Translation("Breakpoint group"),
  module = "breakpoint",
  controller_class = "Drupal\Core\Config\Entity\ConfigStorageController",
  config_prefix = "breakpoint.breakpoint_group",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "uuid" = "uuid"
  }
)

Hierarchy

class \Drupal\Core\Entity\Entity implements \IteratorAggregate, EntityInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface
  - class \Drupal\breakpoint\Plugin\Core\Entity\BreakpointGroup

Expanded class hierarchy of BreakpointGroup

5 files declare their use of BreakpointGroup

File

drupal/core/modules/breakpoint/lib/Drupal/breakpoint/Plugin/Core/Entity/BreakpointGroup.php, line 32: Definition of Drupal\breakpoint\Plugin\Core\Entity\BreakpointGroup.

Namespace

Drupal\breakpoint\Plugin\Core\Entity

View source

class BreakpointGroup extends ConfigEntityBase {

  /**
   * The breakpoint group ID.
   *
   * @var string
   */
  public $id;

  /**
   * The breakpoint group UUID.
   *
   * @var string
   */
  public $uuid;

  /**
   * The breakpoint group machine name.
   *
   * @var string
   */
  public $name;

  /**
   * The breakpoint group label.
   *
   * @var string
   */
  public $label;

  /**
   * The breakpoint group breakpoints.
   *
   * @var array
   *   Array containing all breakpoints of this group.
   *
   * @see Drupal\breakpoint\Plugin\Core\Entity\Breakpoint
   */
  public $breakpoints = array();

  /**
   * The breakpoint group source: theme or module name. Use 'user' for
   * user-created groups.
   *
   * @var string
   */
  public $source = 'user';

  /**
   * The breakpoint group source type.
   *
   * @var string
   *   Allowed values:
   *     Breakpoint::SOURCE_TYPE_THEME
   *     Breakpoint::SOURCE_TYPE_MODULE
   *     Breakpoint::SOURCE_TYPE_USER_DEFINED
   *
   * @see Drupal\breakpoint\Plugin\Core\Entity\Breakpoint
   */
  public $sourceType = Breakpoint::SOURCE_TYPE_USER_DEFINED;

  /**
   * Overrides Drupal\config\ConfigEntityBase::__construct().
   */
  public function __construct(array $values, $entity_type) {
    parent::__construct($values, $entity_type);
    $this
      ->loadAllBreakpoints();
  }

  /**
   * Overrides Drupal\Core\Entity\Entity::save().
   */
  public function save() {

    // Check if everything is valid.
    if (!$this
      ->isValid()) {
      throw new InvalidBreakpointException('Invalid data detected.');
    }
    if (empty($this->id)) {
      $this->id = $this->sourceType . '.' . $this->source . '.' . $this->name;
    }

    // Only save the keys, but return the full objects.
    $this->breakpoints = array_keys($this->breakpoints);
    parent::save();
    $this
      ->loadAllBreakpoints();
  }

  /**
   * Checks if the breakpoint group is valid.
   *
   * @throws Drupal\breakpoint\InvalidBreakpointSourceTypeException
   * @throws Drupal\breakpoint\InvalidBreakpointSourceException
   *
   * @return true
   *   Returns true if the breakpoint group is valid.
   */
  public function isValid() {

    // Check for illegal values in breakpoint group source type.
    if (!in_array($this->sourceType, array(
      Breakpoint::SOURCE_TYPE_USER_DEFINED,
      Breakpoint::SOURCE_TYPE_MODULE,
      Breakpoint::SOURCE_TYPE_THEME,
    ))) {
      throw new InvalidBreakpointSourceTypeException(format_string('Invalid source type @source_type', array(
        '@source_type' => $this->sourceType,
      )));
    }

    // Check for illegal characters in breakpoint group source.
    if (preg_match('/[^a-z_]+/', $this->source) || empty($this->source)) {
      throw new InvalidBreakpointSourceException(format_string("Invalid value '@source' for breakpoint group source property. Breakpoint group source property can only contain lowercase letters and underscores.", array(
        '@source' => $this->source,
      )));
    }

    // Check for illegal characters in breakpoint group name.
    if (preg_match('/[^a-z0-9_]+/', $this->name || empty($this->name))) {
      throw new InvalidBreakpointNameException(format_string("Invalid value '@name' for breakpoint group name property. Breakpoint group name property can only contain lowercase letters, numbers and underscores.", array(
        '@name' => $this->name,
      )));
    }
    return TRUE;
  }

  /**
   * Adds a breakpoint using a name and a media query.
   *
   * @param string $name
   *   The name of the breakpoint.
   * @param string $media_query
   *   Media query.
   */
  public function addBreakpointFromMediaQuery($name, $media_query) {

    // Use the existing breakpoint if it exists.
    $breakpoint = entity_load('breakpoint', $this->sourceType . '.' . $this->name . '.' . $name);
    if (!$breakpoint) {

      // Build a new breakpoint.
      $breakpoint = entity_create('breakpoint', array(
        'name' => $name,
        'label' => $name,
        'mediaQuery' => $media_query,
        'source' => $this->name,
        'sourceType' => $this->sourceType,
        'weight' => count($this->breakpoints),
      ));
      $breakpoint
        ->save();
    }
    $this->breakpoints[$breakpoint
      ->id()] = $breakpoint;
  }

  /**
   * Adds one or more breakpoints to this group.
   *
   * The breakpoint name is either the machine_name or the id of a breakpoint.
   *
   * @param array $breakpoints
   *   Array containing breakpoints keyed by their id.
   */
  public function addBreakpoints($breakpoints) {
    foreach ($breakpoints as $breakpoint_name) {

      // Check if breakpoint exists, assume $breakpoint_name is a machine name.
      $breakpoint = entity_load('breakpoint', $this->sourceType . '.' . $this->source . '.' . $breakpoint_name);

      // If the breakpoint doesn't exist, assume $breakpoint_name is an id.
      if (!$breakpoint) {
        $breakpoint = entity_load('breakpoint', $breakpoint_name);
      }

      // If the breakpoint doesn't exists, do not add it.
      if ($breakpoint) {

        // Add breakpoint to group.
        $this->breakpoints[$breakpoint
          ->id()] = $breakpoint;
      }
    }
  }

  /**
   * Loads all breakpoints, remove non-existing ones.
   *
   * @return array
   *   Array containing breakpoints keyed by their id.
   */
  protected function loadAllBreakpoints() {
    $breakpoints = $this->breakpoints;
    $this->breakpoints = array();
    foreach ($breakpoints as $breakpoint_id) {
      $breakpoint = breakpoint_load($breakpoint_id);
      if ($breakpoint) {
        $this->breakpoints[$breakpoint_id] = $breakpoint;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BreakpointGroup::$breakpoints	public	property	The breakpoint group breakpoints.
BreakpointGroup::$id	public	property	The breakpoint group ID.
BreakpointGroup::$label	public	property	The breakpoint group label.
BreakpointGroup::$name	public	property	The breakpoint group machine name.
BreakpointGroup::$source	public	property	The breakpoint group source: theme or module name. Use 'user' for user-created groups.
BreakpointGroup::$sourceType	public	property	The breakpoint group source type.
BreakpointGroup::$uuid	public	property	The breakpoint group UUID.
BreakpointGroup::addBreakpointFromMediaQuery	public	function	Adds a breakpoint using a name and a media query.
BreakpointGroup::addBreakpoints	public	function	Adds one or more breakpoints to this group.
BreakpointGroup::isValid	public	function	Checks if the breakpoint group is valid.
BreakpointGroup::loadAllBreakpoints	protected	function	Loads all breakpoints, remove non-existing ones.
BreakpointGroup::save	public	function	Overrides Drupal\Core\Entity\Entity::save(). Overrides Entity::save
BreakpointGroup::__construct	public	function	Overrides Drupal\config\ConfigEntityBase::__construct(). Overrides ConfigEntityBase::__construct
ConfigEntityBase::$originalID	protected	property	The original ID of the configuration entity.
ConfigEntityBase::createDuplicate	public	function	Overrides Entity::createDuplicate(). Overrides Entity::createDuplicate	1
ConfigEntityBase::get	public	function	Overrides Entity::get(). Overrides Entity::get	1
ConfigEntityBase::getOriginalID	public	function	Implements ConfigEntityInterface::getOriginalID(). Overrides ConfigEntityInterface::getOriginalID
ConfigEntityBase::isNew	final public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::set	public	function	Overrides Entity::set(). Overrides Entity::set
ConfigEntityBase::setOriginalID	public	function	Implements ConfigEntityInterface::setOriginalID(). Overrides ConfigEntityInterface::setOriginalID
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityType	protected	property	The entity type.
Entity::$isDefaultRevision	protected	property	Indicates whether this is the default revision.	1
Entity::$langcode	public	property	The language code of the entity's default language.	4
Entity::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
Entity::access	public	function	Implements AccessibleInterface::access(). Overrides AccessibleInterface::access
Entity::bundle	public	function	Implements EntityInterface::bundle(). Overrides EntityInterface::bundle	4
Entity::delete	public	function	Implements EntityInterface::delete(). Overrides EntityInterface::delete
Entity::enforceIsNew	public	function	Implements EntityInterface::enforceIsNew(). Overrides EntityInterface::enforceIsNew
Entity::entityInfo	public	function	Implements EntityInterface::entityInfo(). Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Implements EntityInterface::entityType(). Overrides EntityInterface::entityType
Entity::getIterator	public	function	Implements ComplexDataInterface::getIterator().	1
Entity::getProperties	public	function	Implements ComplexDataInterface::getProperties(). Overrides ComplexDataInterface::getProperties	1
Entity::getPropertyDefinition	public	function	Implements ComplexDataInterface::getPropertyDefinition(). Overrides ComplexDataInterface::getPropertyDefinition	1
Entity::getPropertyDefinitions	public	function	Implements ComplexDataInterface::getPropertyDefinitions(). Overrides ComplexDataInterface::getPropertyDefinitions	1
Entity::getPropertyValues	public	function	Implements ComplexDataInterface::getPropertyValues(). Overrides ComplexDataInterface::getPropertyValues	1
Entity::getRevisionId	public	function	Implements Drupal\Core\Entity\EntityInterface::getRevisionId(). Overrides EntityInterface::getRevisionId	3
Entity::getTranslation	public	function	Implements TranslatableInterface::getTranslation(). Overrides TranslatableInterface::getTranslation	1
Entity::getTranslationLanguages	public	function	Implements TranslatableInterface::getTranslationLanguages(). Overrides TranslatableInterface::getTranslationLanguages	1
Entity::id	public	function	Implements EntityInterface::id(). Overrides EntityInterface::id	10
Entity::isDefaultRevision	public	function	Implements Drupal\Core\Entity\EntityInterface::isDefaultRevision(). Overrides EntityInterface::isDefaultRevision	1
Entity::isEmpty	public	function	Implements ComplexDataInterface::isEmpty(). Overrides ComplexDataInterface::isEmpty	1
Entity::isNewRevision	public	function	Implements EntityInterface::isNewRevision(). Overrides EntityInterface::isNewRevision
Entity::label	public	function	Implements EntityInterface::label(). Overrides EntityInterface::label	1
Entity::language	public	function	Implements TranslatableInterface::language(). Overrides TranslatableInterface::language	1
Entity::setNewRevision	public	function	Implements EntityInterface::setNewRevision(). Overrides EntityInterface::setNewRevision
Entity::setPropertyValues	public	function	Implements ComplexDataInterface::setPropertyValues(). Overrides ComplexDataInterface::setPropertyValues	1
Entity::translations	public	function	Returns the languages the entity is translated to.
Entity::uri	public	function	Implements EntityInterface::uri(). Overrides EntityInterface::uri	1
Entity::uuid	public	function	Implements EntityInterface::uuid(). Overrides EntityInterface::uuid	1

Main menu

Search Drupal 9.x

API Navigation

class BreakpointGroup

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 9.x

API Navigation

class BreakpointGroup

Plugin annotation

Hierarchy

File

Namespace

Members