class ModalListBuilder in Modal 8.3

Same name and namespace in other branches

8.2 src/Entity/Controller/ModalListBuilder.php \Drupal\modal_page\Entity\Controller\ModalListBuilder

Provides a list controller for Modal entity.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
  - class \Drupal\modal_page\Entity\Controller\ModalListBuilder

Expanded class hierarchy of ModalListBuilder

File

src/Entity/Controller/ModalListBuilder.php, line 16

Namespace

Drupal\modal_page\Entity\Controller

View source

class ModalListBuilder extends EntityListBuilder {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The url generator.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($container
      ->get('language_manager'), $entity_type, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type
      ->id()), $container
      ->get('url_generator'));
  }

  /**
   * Constructs a new ModalListBuilder object.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage class.
   * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
   *   The url generator.
   */
  public function __construct(LanguageManagerInterface $language_manager, EntityTypeInterface $entity_type, EntityStorageInterface $storage, UrlGeneratorInterface $url_generator) {
    $this->languageManager = $language_manager;
    parent::__construct($entity_type, $storage);
    $this->urlGenerator = $url_generator;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $modal_page) {
    $operations = parent::getDefaultOperations($modal_page);
    $operations['published'] = [
      'title' => $this
        ->t('Toggle Published'),
      'weight' => 15,
      'url' => $this
        ->ensureDestination($modal_page
        ->toUrl('published-form')),
    ];
    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $build['table'] = parent::render();
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['id'] = $this
      ->t('ID');
    $header['title'] = $this
      ->t('Title');
    $header['langcode'] = $this
      ->t('Language');
    $header['pages'] = $this
      ->t('Pages');
    $header['parameters'] = $this
      ->t('Parameters');
    $header['size'] = $this
      ->t('Modal Size');
    $header['delay'] = $this
      ->t('Delay');
    $header['published'] = $this
      ->t('Published');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['id'] = $entity->id->value;
    $row['title'] = $entity->title->value;
    $row['langcode'] = $this
      ->getLanguageLabel($entity->langcode->value);
    if ($entity->type->value === 'parameter') {
      $row['pages'] = 'N/A';
      $row['parameters'] = $this
        ->getParameters($entity->parameters->value);
    }
    else {
      $row['pages'] = $this
        ->getPages($entity->pages->value);
      $row['parameters'] = 'N/A';
    }
    $row['size'] = $entity->modal_size
      ->getSetting('allowed_values')[$this
      ->getColValue($entity->modal_size->value)];
    $row['delay_display'] = $this
      ->getColValue($entity->delay_display->value, '0s');
    $row['published'] = $entity->published->value ? 'Yes' : 'No';
    return $row + parent::buildRow($entity);
  }

  /**
   * Get the value.
   *
   * @param mixed $value
   *   The some value.
   * @param mixed $default
   *   Values for empty case.
   *
   * @return string
   *   Return valeu.
   */
  public function getColValue($value, $default = 'N/A') {
    if (!empty($value)) {
      return $value;
    }
    return $default;
  }

  /**
   * Get the pages.
   *
   * @param string $pages
   *   Text with pages.
   * @param mixed $default
   *   Values for empty case.
   *
   * @return string
   *   Return list pages.
   */
  public function getPages($pages, $default = 'N/A') {
    $pages_value = '';
    $pages = explode(PHP_EOL, $pages);
    if (empty($pages)) {
      return $default;
    }
    foreach ($pages as $key => $page) {
      $pages_value .= $key !== 0 ? ', ' : '';
      $pages_value .= trim($page);
    }
    return !strlen($pages_value) > 44 ?: substr($pages_value, 0, 44) . ' ...';
  }

  /**
   * Get the parameters.
   *
   * @param string $parameters
   *   Text with parameters.
   * @param mixed $default
   *   Values for empty case.
   *
   * @return string
   *   Return list pages.
   */
  public function getParameters($parameters, $default = 'N/A') {
    $parameters_value = '';
    $parameters = explode(PHP_EOL, $parameters);
    if (empty($parameters)) {
      return $default;
    }
    foreach ($parameters as $key => $parameter) {
      $parameters_value .= $key !== 0 ? ', ' : '';
      $parameters_value .= 'modal=' . trim($parameter);
    }
    return !strlen($parameters_value) > 44 ?: substr($parameters_value, 0, 44) . ' ...';
  }

  /**
   * Get the language label.
   *
   * @param string $languageCode
   *   The code of language.
   * @param mixed $default
   *   Values for empty case.
   *
   * @return string
   *   Return label language.
   */
  public function getLanguageLabel($languageCode, $default = '- Any -') {
    if (empty($languageCode)) {
      return $default;
    }
    $languages = $this->languageManager
      ->getLanguages();
    return empty($languages[$languageCode]
      ->getName()) ? $default : $languages[$languageCode]
      ->getName();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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::$limit	protected	property	The number of entities to list per page, or FALSE to list all entities.	3
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::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
EntityListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides EntityListBuilderInterface::load	4
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
ModalListBuilder::$languageManager	protected	property	The language manager.
ModalListBuilder::$urlGenerator	protected	property	The url generator.
ModalListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ModalListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ModalListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
ModalListBuilder::getColValue	public	function	Get the value.
ModalListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations
ModalListBuilder::getLanguageLabel	public	function	Get the language label.
ModalListBuilder::getPages	public	function	Get the pages.
ModalListBuilder::getParameters	public	function	Get the parameters.
ModalListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
ModalListBuilder::__construct	public	function	Constructs a new ModalListBuilder object. Overrides EntityListBuilder::__construct
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.

You are here

class ModalListBuilder in Modal 8.3

Hierarchy

File

Namespace

Members

API Navigation