class FlagListsActionsActionListBuilder in Flag Lists 4.0.x

Defines a class to build a listing of action 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\action\ActionListBuilder
        • class \Drupal\flag_lists_actions\FlagListsActionsActionListBuilder

See also

\Drupal\system\Entity\Action

action_entity_type_build()

File

modules/flag_lists_actions/src/FlagListsActionsActionListBuilder.php, line 20

Namespace

Drupal\flag_lists_actions

class FlagListsActionsActionListBuilder extends ActionListBuilder {

  /**
   * The Flag Lists Service.
   *
   * @var \Drupal\flag_lists\FlagListsService
   */
  protected $flagListsService;

  /**
   * Constructs a new ActionListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The action storage.
   * @param \Drupal\Core\Action\ActionManager $action_manager
   *   The action plugin manager.
   * @param \Drupal\flag_lists\FlagListsServiceInterface $flag_lists_service
   *   The Flag Lists service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The Config Factory.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ActionManager $action_manager, FlagListsServiceInterface $flag_lists_service, ConfigFactoryInterface $config_factory) {
    parent::__construct($entity_type, $storage, $action_manager);
    $this->flagListsService = $flag_lists_service;
    $this->configFactory = $config_factory;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    if ($this->hasConfigurableActions) {
      if (!empty($entity
        ->get('configuration')['flag_id'])) {
        if ($this->flagListsService
          ->getFlaggingCollectionIdByRelated($entity
          ->get('configuration')['flag_id'])) {
          $config = $this->configFactory
            ->get('flag_lists.settings');
          if ($config
            ->get('hide_actions') == 1) {
            return NULL;
          }
        }
      }
      $row['type'] = $entity
        ->getType();
      $row['label'] = $entity
        ->label();
      $row += parent::buildRow($entity);
      return $row;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionListBuilder::$actionManager	protected	property	The action plugin manager.
ActionListBuilder::$hasConfigurableActions	protected	property
ActionListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ActionListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
ActionListBuilder::load	public	function	Loads entities of this type from storage for listing. Overrides ConfigEntityListBuilder::load
ActionListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
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.
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::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
FlagListsActionsActionListBuilder::$flagListsService	protected	property	The Flag Lists Service.
FlagListsActionsActionListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides ActionListBuilder::buildRow
FlagListsActionsActionListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides ActionListBuilder::createInstance
FlagListsActionsActionListBuilder::__construct	public	function	Constructs a new ActionListBuilder object. Overrides ActionListBuilder::__construct
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.