class PanelizerPanelsIPEController in Panelizer 8.5
Same name and namespace in other branches
- 8.3 src/Controller/PanelizerPanelsIPEController.php \Drupal\panelizer\Controller\PanelizerPanelsIPEController
- 8.4 src/Controller/PanelizerPanelsIPEController.php \Drupal\panelizer\Controller\PanelizerPanelsIPEController
Controller for Panelizer's Panels IPE routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\panelizer\Controller\PanelizerPanelsIPEController
Expanded class hierarchy of PanelizerPanelsIPEController
File
- src/
Controller/ PanelizerPanelsIPEController.php, line 20
Namespace
Drupal\panelizer\ControllerView source
class PanelizerPanelsIPEController extends ControllerBase {
/**
* The Panelizer service.
*
* @var \Drupal\panelizer\PanelizerInterface
*/
protected $panelizer;
/**
* Constructs a PanelizerPanelsIPEController.
*
* @param \Drupal\panelizer\PanelizerInterface $panelizer
* The Panelizer service.
*/
public function __construct(PanelizerInterface $panelizer) {
$this->panelizer = $panelizer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('panelizer'));
}
/**
* Reverts an entity view mode to a particular named default.
*
* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
* The entity.
* @param string $view_mode
* The view mode.
*
* @return \Symfony\Component\HttpFoundation\Response
* An empty response.
*
* @throws \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
*/
public function revertToDefault(FieldableEntityInterface $entity, $view_mode) {
// Get the bundle specific default display as a fallback.
$settings = $this->panelizer
->getPanelizerSettings($entity
->getEntityTypeId(), $entity
->bundle(), $view_mode);
$default = $settings['default'];
// Check the entity for a documented default to which we should revert.
if ($entity
->hasField('panelizer') && $entity->panelizer
->first()) {
foreach ($entity->panelizer as $item) {
if ($item->view_mode == $view_mode && !empty($item->default)) {
$default = $item->default;
break;
}
}
}
// If we somehow ended up not having a default, throw an exception.
if (empty($default)) {
throw new BadRequestHttpException("Default name to revert to must be passed!");
}
$this->panelizer
->setPanelsDisplay($entity, $view_mode, $default);
return new Response();
}
/**
* Custom access checker for reverting an entity view mode to a named default.
*
* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
* The entity.
* @param string $view_mode
* The view mode.
* @param \Drupal\Core\Session\AccountInterface $account
* The user account.
*
* @return \Drupal\Core\Access\AccessResultInterface
* The access result.
*/
public function accessRevertToDefault(FieldableEntityInterface $entity, $view_mode, AccountInterface $account) {
return AccessResult::allowedIf($this->panelizer
->hasEntityPermission('revert to default', $entity, $view_mode, $account));
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The configuration factory. | |
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity manager. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity manager service. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
ControllerBase:: |
protected | function | Returns the state storage service. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PanelizerPanelsIPEController:: |
protected | property | The Panelizer service. | |
PanelizerPanelsIPEController:: |
public | function | Custom access checker for reverting an entity view mode to a named default. | |
PanelizerPanelsIPEController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
PanelizerPanelsIPEController:: |
public | function | Reverts an entity view mode to a particular named default. | |
PanelizerPanelsIPEController:: |
public | function | Constructs a PanelizerPanelsIPEController. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |