class ExampleConfigEntityListBuilder

Same name in other branches
  1. 8.x-3.x tests/modules/ctools_wizard_test/src/ExampleConfigEntityListBuilder.php \Drupal\ctools_wizard_test\ExampleConfigEntityListBuilder

Provides a listing of Example config entity entities.

Hierarchy

Expanded class hierarchy of ExampleConfigEntityListBuilder

File

tests/modules/ctools_wizard_test/src/ExampleConfigEntityListBuilder.php, line 11

Namespace

Drupal\ctools_wizard_test
View source 
class ExampleConfigEntityListBuilder extends ConfigEntityListBuilder {
    
    /**
     * {@inheritdoc}
     */
    public function buildHeader() {
        $header['label'] = $this->t('Example config entity');
        $header['id'] = $this->t('Machine name');
        return $header + parent::buildHeader();
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildRow(EntityInterface $entity) {
        $row['label'] = $entity->label();
        $row['id'] = $entity->id();
        // You probably want a few more properties here...
        return $row + parent::buildRow($entity);
    }
    
    /**
     * @inheritDoc
     */
    public function getOperations(EntityInterface $entity) {
        $operations = parent::getOperations($entity);
        if (!empty($operations['edit'])) {
            
            /** @var \Drupal\Core\Url $edit */
            $edit = $operations['edit']['url'];
            $edit->setRouteParameters([
                'machine_name' => $entity->id(),
                'step' => 'general',
            ]);
        }
        return $operations;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getDefaultOperations public function Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations 15
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
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::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 22
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getTitle protected function Gets the title of the page. 1
EntityListBuilder::render public function Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilderInterface::render 17
EntityListBuilder::__construct public function Constructs a new EntityListBuilder object. 18
ExampleConfigEntityListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
ExampleConfigEntityListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
ExampleConfigEntityListBuilder::getOperations public function @inheritDoc Overrides EntityListBuilder::getOperations
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 3
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.