class LingotekProfileListBuilder in Lingotek Translation 8

Defines a class to build a listing of Lingotek profile entities.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityListBuilder implements EntityHandlerInterface, EntityListBuilderInterface uses MessengerTrait, RedirectDestinationTrait
    • class \Drupal\Core\Config\Entity\ConfigEntityListBuilder
      • class \Drupal\Core\Config\Entity\DraggableListBuilder implements FormInterface
        • class \Drupal\lingotek\LingotekProfileListBuilder

See also

\Drupal\lingotek\Entity\LingotekProfile

File

src/LingotekProfileListBuilder.php, line 23

Namespace

Drupal\lingotek

class LingotekProfileListBuilder extends DraggableListBuilder {

  /**
   * {@inheritdoc}
   */
  protected $entitiesKey = 'profile';

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

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

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

  /**
   * Constructs a new LingotekProfileListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The entity storage controller class.
   * @param \Drupal\Core\Language\LanguageManagerInterface
   *   The language manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory) {
    parent::__construct($entity_type, $storage);
    $this->languageManager = $language_manager;
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public function load() {
    $entities = $this->storage
      ->loadMultiple();

    // Sort the entities using the entity class's sort() method.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
    uasort($entities, array(
      $this->entityType
        ->getClass(),
      'sort',
    ));
    return $entities;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header = array(
      'label' => t('Name'),
      'auto_upload' => t('Automatic Upload'),
      'auto_download' => t('Automatic Download'),
    ) + parent::buildHeader();
    return $header;
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $this
      ->getLabel($entity);
    $row['auto_upload'] = array(
      '#type' => 'checkbox',
      '#title' => t('Set @title for automatic upload', array(
        '@title' => $entity
          ->label(),
      )),
      '#title_display' => 'invisible',
      '#disabled' => $entity
        ->isLocked(),
      '#default_value' => $entity
        ->hasAutomaticUpload(),
    );
    $row['auto_download'] = array(
      '#type' => 'checkbox',
      '#title' => t('Set @title for automatic download', array(
        '@title' => $entity
          ->label(),
      )),
      '#title_display' => 'invisible',
      '#disabled' => $entity
        ->isLocked(),
      '#default_value' => $entity
        ->hasAutomaticDownload(),
    );
    return $row + parent::buildRow($entity);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form[$this->entitiesKey]['#profiles'] = $this->entities;
    $form['actions']['submit']['#value'] = t('Save configuration');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Parent submit handler takes care of the weights, but not the checkboxes.
    parent::submitForm($form, $form_state);
    foreach ($this->entities as $entity_id => $entity) {
      if (!$entity
        ->isLocked() && ($entity
        ->hasAutomaticUpload() != $form_state
        ->getValue([
        'profile',
        $entity_id,
        'auto_upload',
      ]) || $entity
        ->hasAutomaticDownload() != $form_state
        ->getValue([
        'profile',
        $entity_id,
        'auto_download',
      ]))) {
        $entity
          ->setAutomaticUpload($form_state
          ->getValue([
          'profile',
          $entity_id,
          'auto_upload',
        ]));
        $entity
          ->setAutomaticDownload($form_state
          ->getValue([
          'profile',
          $entity_id,
          'auto_download',
        ]));
        $entity
          ->save();
      }
    }
    drupal_set_message(t('Configuration saved.'));
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations(EntityInterface $entity) {

    // We don't call parent, as we don't want config_translation operations.
    $operations = [];
    if (!$entity
      ->isLocked() && $entity
      ->hasLinkTemplate('edit-form')) {
      $operations['edit'] = array(
        'title' => $this
          ->t('Edit'),
        'weight' => 10,
        'url' => $entity
          ->urlInfo('edit-form'),
      );
    }
    if (!$entity
      ->isLocked() && $entity
      ->hasLinkTemplate('delete-form')) {
      $operations['delete'] = array(
        'title' => $this
          ->t('Delete'),
        'weight' => 100,
        'url' => $entity
          ->urlInfo('delete-form'),
      );
    }
    return $operations;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
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
DraggableListBuilder::$entities	protected	property	The entities being listed.	1
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::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render	1
DraggableListBuilder::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	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::$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::getStorage	public	function	Gets the entity storage. Overrides EntityListBuilderInterface::getStorage
EntityListBuilder::getTitle	protected	function	Gets the title of the page.	1
LingotekProfileListBuilder::$configFactory	protected	property	The configuration factory.
LingotekProfileListBuilder::$entitiesKey	protected	property	The key to use for the form element containing the entities. Overrides DraggableListBuilder::$entitiesKey
LingotekProfileListBuilder::$languageManager	protected	property	The language manager.
LingotekProfileListBuilder::buildForm	public	function	Form constructor. Overrides DraggableListBuilder::buildForm
LingotekProfileListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides DraggableListBuilder::buildHeader
LingotekProfileListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides DraggableListBuilder::buildRow
LingotekProfileListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
LingotekProfileListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
LingotekProfileListBuilder::getOperations	public	function	Provides an array of information to build a list of operation links. Overrides EntityListBuilder::getOperations
LingotekProfileListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
LingotekProfileListBuilder::submitForm	public	function	Form submission handler. Overrides DraggableListBuilder::submitForm
LingotekProfileListBuilder::__construct	public	function	Constructs a new LingotekProfileListBuilder object. Overrides DraggableListBuilder::__construct
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.