You are here

Home » API reference » Responsive Theme Preview 8 » DeviceListBuilder.php

class DeviceListBuilder in Responsive Theme Preview 8

Provides a listing of Device entities.

Hierarchy

Expanded class hierarchy of DeviceListBuilder

File

src/DeviceListBuilder.php, line 14

Namespace

Drupal\responsive_preview
View source 
class DeviceListBuilder extends DraggableListBuilder {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'responsive_preview_device';
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = $this
      ->t('Name');
    $header['status'] = $this
      ->t('Show in list');
    $header['dimensions'] = $this
      ->t('Dimensions');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity
      ->label();
    $row['status'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show %title in list', [
        '%title' => $entity
          ->label(),
      ]),
      '#title_display' => 'invisible',
      '#default_value' => $entity
        ->status(),
    ];
    $dimensions = $entity
      ->getDimensions();
    $row['dimensions']['#markup'] = new FormattableMarkup('@widthx@height (@dppx dppx)', [
      '@width' => $dimensions['width'],
      '@height' => $dimensions['height'],
      '@dppx' => $dimensions['dppx'],
    ]);
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    if (empty($this->entities)) {
      $form['actions']['#access'] = FALSE;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $entities = $form_state
      ->getValue($this->entitiesKey);
    if (!empty($entities)) {
      parent::submitForm($form, $form_state);
      foreach ($entities as $id => $value) {
        if (isset($this->entities[$id]) && $this->entities[$id]
          ->status() !== $value['status']) {
          $this->entities[$id]
            ->setStatus($value['status']);
          $this->entities[$id]
            ->save();
        }
      }
      $this
        ->messenger()
        ->addStatus($this
        ->t('The device settings have been updated.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build = parent::render();
    $build[$this->entitiesKey]['#empty'] = $this
      ->t('No devices available. <a href=":link">Add devices</a>.', [
      ':link' => Url::fromRoute('entity.responsive_preview_device.add_form')
        ->toString(),
    ]);
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeviceListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilder::buildForm
DeviceListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
DeviceListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
DeviceListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeviceListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides DraggableListBuilder::render
DeviceListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilder::submitForm
DraggableListBuilder::$entities protected property The entities being listed. 1
DraggableListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. 3
DraggableListBuilder::$formBuilder protected property The form builder.
DraggableListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities. Overrides EntityListBuilder::$limit
DraggableListBuilder::$weightKey protected property Name of the entity's weight field or FALSE if no field is provided.
DraggableListBuilder::formBuilder protected function Returns the form builder.
DraggableListBuilder::validateForm public function Form validation handler. Overrides FormInterface::validateForm 2
DraggableListBuilder::__construct public function Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__construct 5
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 2
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$storage protected property The entity storage class. 1
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance 20
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL.
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 4
EntityListBuilder::getLabel Deprecated protected function Gets the label of an entity.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 2
EntityListBuilder::getStorage public function Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle protected function Gets the title of the page. 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.