class EntityTypeInfoController
Same name in other branches
- 8.x-1.x src/Controller/EntityTypeInfoController.php \Drupal\devel\Controller\EntityTypeInfoController
- 5.x src/Controller/EntityTypeInfoController.php \Drupal\devel\Controller\EntityTypeInfoController
Provides route responses for the entity types info page.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\devel\Controller\EntityTypeInfoController extends \Drupal\Core\Controller\ControllerBase
Expanded class hierarchy of EntityTypeInfoController
File
-
src/
Controller/ EntityTypeInfoController.php, line 16
Namespace
Drupal\devel\ControllerView source
class EntityTypeInfoController extends ControllerBase {
/**
* The dumper service.
*
* @var \Drupal\devel\DevelDumperManagerInterface
*/
protected $dumper;
/**
* The installed entity definition repository service.
*
* @var \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface
*/
protected $entityLastInstalledSchemaRepository;
/**
* EntityTypeInfoController constructor.
*
* @param \Drupal\devel\DevelDumperManagerInterface $dumper
* The dumper service.
* @param \Drupal\Core\Entity\EntityLastInstalledSchemaRepositoryInterface $entityLastInstalledSchemaRepository
* The installed entity definition repository service.
*/
public function __construct(DevelDumperManagerInterface $dumper, EntityLastInstalledSchemaRepositoryInterface $entityLastInstalledSchemaRepository) {
$this->dumper = $dumper;
$this->entityLastInstalledSchemaRepository = $entityLastInstalledSchemaRepository;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('devel.dumper'), $container->get('entity.last_installed_schema.repository'));
}
/**
* Builds the entity types overview page.
*
* @return array
* A render array as expected by the renderer.
*/
public function entityTypeList() {
$headers = [
$this->t('ID'),
$this->t('Name'),
$this->t('Provider'),
$this->t('Class'),
$this->t('Operations'),
];
$rows = [];
foreach ($this->entityTypeManager()
->getDefinitions() as $entity_type_id => $entity_type) {
$row['id'] = [
'data' => $entity_type->id(),
'filter' => TRUE,
];
$row['name'] = [
'data' => $entity_type->getLabel(),
'filter' => TRUE,
];
$row['provider'] = [
'data' => $entity_type->getProvider(),
'filter' => TRUE,
];
$row['class'] = [
'data' => $entity_type->getClass(),
'filter' => TRUE,
];
$row['operations']['data'] = [
'#type' => 'operations',
'#links' => [
'devel' => [
'title' => $this->t('Devel'),
'url' => Url::fromRoute('devel.entity_info_page.detail', [
'entity_type_id' => $entity_type_id,
]),
'attributes' => [
'class' => [
'use-ajax',
],
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'width' => 700,
'minHeight' => 500,
]),
],
],
'fields' => [
'title' => $this->t('Fields'),
'url' => Url::fromRoute('devel.entity_info_page.fields', [
'entity_type_id' => $entity_type_id,
]),
'attributes' => [
'class' => [
'use-ajax',
],
'data-dialog-type' => 'modal',
'data-dialog-options' => Json::encode([
'width' => 700,
'minHeight' => 500,
]),
],
],
],
];
$rows[$entity_type_id] = $row;
}
ksort($rows);
$output['entities'] = [
'#type' => 'devel_table_filter',
'#filter_label' => $this->t('Search'),
'#filter_placeholder' => $this->t('Enter entity type id, provider or class'),
'#filter_description' => $this->t('Enter a part of the entity type id, provider or class to filter by.'),
'#header' => $headers,
'#rows' => $rows,
'#empty' => $this->t('No entity types found.'),
'#sticky' => TRUE,
'#attributes' => [
'class' => [
'devel-entity-type-list',
],
],
];
return $output;
}
/**
* Returns a render array representation of the entity type.
*
* @param string $entity_type_id
* The name of the entity type to retrieve.
*
* @return array
* A render array containing the entity type.
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
* If the requested entity type is not defined.
*/
public function entityTypeDetail($entity_type_id) {
if (!($entity_type = $this->entityTypeManager()
->getDefinition($entity_type_id, FALSE))) {
throw new NotFoundHttpException();
}
return $this->dumper
->exportAsRenderable($entity_type, $entity_type_id);
}
/**
* Returns a render array representation of the entity type field definitions.
*
* @param string $entity_type_id
* The name of the entity type to retrieve.
*
* @return array
* A render array containing the entity type field definitions.
*
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
* If the requested entity type is not defined.
*/
public function entityTypeFields($entity_type_id) {
if (!$this->entityTypeManager()
->getDefinition($entity_type_id, FALSE)) {
throw new NotFoundHttpException();
}
$field_storage_definitions = $this->entityLastInstalledSchemaRepository
->getLastInstalledFieldStorageDefinitions($entity_type_id);
return $this->dumper
->exportAsRenderable($field_storage_definitions, $entity_type_id);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ControllerBase::$configFactory | protected | property | The configuration factory. | ||
ControllerBase::$currentUser | protected | property | The current user service. | 3 | |
ControllerBase::$entityFormBuilder | protected | property | The entity form builder. | ||
ControllerBase::$entityTypeManager | protected | property | The entity type manager. | ||
ControllerBase::$formBuilder | protected | property | The form builder. | 1 | |
ControllerBase::$keyValue | protected | property | The key-value storage. | 1 | |
ControllerBase::$languageManager | protected | property | The language manager. | 1 | |
ControllerBase::$moduleHandler | protected | property | The module handler. | 1 | |
ControllerBase::$stateService | protected | property | The state service. | ||
ControllerBase::cache | protected | function | Returns the requested cache bin. | ||
ControllerBase::config | protected | function | Retrieves a configuration object. | ||
ControllerBase::container | private | function | Returns the service container. | ||
ControllerBase::currentUser | protected | function | Returns the current user. | 3 | |
ControllerBase::entityFormBuilder | protected | function | Retrieves the entity form builder. | ||
ControllerBase::entityTypeManager | protected | function | Retrieves the entity type manager. | ||
ControllerBase::formBuilder | protected | function | Returns the form builder service. | 1 | |
ControllerBase::keyValue | protected | function | Returns a key/value storage collection. | 1 | |
ControllerBase::languageManager | protected | function | Returns the language manager service. | 1 | |
ControllerBase::moduleHandler | protected | function | Returns the module handler. | 1 | |
ControllerBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
ControllerBase::state | protected | function | Returns the state storage service. | ||
EntityTypeInfoController::$dumper | protected | property | The dumper service. | ||
EntityTypeInfoController::$entityLastInstalledSchemaRepository | protected | property | The installed entity definition repository service. | ||
EntityTypeInfoController::create | public static | function | Instantiates a new instance of this class. | Overrides ControllerBase::create | |
EntityTypeInfoController::entityTypeDetail | public | function | Returns a render array representation of the entity type. | ||
EntityTypeInfoController::entityTypeFields | public | function | Returns a render array representation of the entity type field definitions. | ||
EntityTypeInfoController::entityTypeList | public | function | Builds the entity types overview page. | ||
EntityTypeInfoController::__construct | public | function | EntityTypeInfoController constructor. | ||
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | |
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. | 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. |