Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\views_ui\ParamConverter;
Chris@0: 
Chris@0: use Drupal\Core\Config\ConfigFactoryInterface;
Chris@18: use Drupal\Core\Entity\EntityTypeManagerInterface;
Chris@0: use Drupal\Core\ParamConverter\AdminPathConfigEntityConverter;
Chris@18: use Drupal\Core\ParamConverter\ParamConverterInterface;
Chris@0: use Drupal\Core\Routing\AdminContext;
Chris@14: use Drupal\Core\TempStore\SharedTempStoreFactory;
Chris@0: use Drupal\views_ui\ViewUI;
Chris@18: use Symfony\Component\Routing\Route;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides upcasting for a view entity to be used in the Views UI.
Chris@0:  *
Chris@0:  * Example:
Chris@0:  *
Chris@0:  * pattern: '/some/{view}/and/{bar}'
Chris@0:  * options:
Chris@0:  *   parameters:
Chris@0:  *     view:
Chris@0:  *       type: 'entity:view'
Chris@0:  *       tempstore: TRUE
Chris@0:  *
Chris@0:  * The value for {view} will be converted to a view entity prepared for the
Chris@0:  * Views UI and loaded from the views temp store, but it will not touch the
Chris@0:  * value for {bar}.
Chris@0:  */
Chris@0: class ViewUIConverter extends AdminPathConfigEntityConverter implements ParamConverterInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Stores the tempstore factory.
Chris@0:    *
Chris@14:    * @var \Drupal\Core\TempStore\SharedTempStoreFactory
Chris@0:    */
Chris@0:   protected $tempStoreFactory;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new ViewUIConverter.
Chris@0:    *
Chris@18:    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
Chris@18:    *   The entity type manager.
Chris@14:    * @param \Drupal\Core\TempStore\SharedTempStoreFactory $temp_store_factory
Chris@0:    *   The factory for the temp store object.
Chris@18:    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
Chris@18:    *   The config factory.
Chris@18:    * @param \Drupal\Core\Routing\AdminContext $admin_context
Chris@18:    *   The route admin context service.
Chris@18:    * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
Chris@18:    *   The entity repository.
Chris@0:    */
Chris@18:   public function __construct(EntityTypeManagerInterface $entity_type_manager, SharedTempStoreFactory $temp_store_factory, ConfigFactoryInterface $config_factory = NULL, AdminContext $admin_context = NULL, $entity_repository = NULL) {
Chris@0:     // The config factory and admin context are new arguments due to changing
Chris@0:     // the parent. Avoid an error on updated sites by falling back to getting
Chris@0:     // them from the container.
Chris@0:     // @todo Remove in 8.2.x in https://www.drupal.org/node/2674328.
Chris@0:     if (!$config_factory) {
Chris@0:       $config_factory = \Drupal::configFactory();
Chris@0:     }
Chris@0:     if (!$admin_context) {
Chris@0:       $admin_context = \Drupal::service('router.admin_context');
Chris@0:     }
Chris@18:     parent::__construct($entity_type_manager, $config_factory, $admin_context, $entity_repository);
Chris@0: 
Chris@0:     $this->tempStoreFactory = $temp_store_factory;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function convert($value, $definition, $name, array $defaults) {
Chris@0:     if (!$entity = parent::convert($value, $definition, $name, $defaults)) {
Chris@0:       return;
Chris@0:     }
Chris@0: 
Chris@0:     // Get the temp store for this variable if it needs one. Attempt to load the
Chris@0:     // view from the temp store, synchronize its status with the existing view,
Chris@0:     // and store the lock metadata.
Chris@0:     $store = $this->tempStoreFactory->get('views');
Chris@0:     if ($view = $store->get($value)) {
Chris@0:       if ($entity->status()) {
Chris@0:         $view->enable();
Chris@0:       }
Chris@0:       else {
Chris@0:         $view->disable();
Chris@0:       }
Chris@18:       $view->setLock($store->getMetadata($value));
Chris@0:     }
Chris@0:     // Otherwise, decorate the existing view for use in the UI.
Chris@0:     else {
Chris@0:       $view = new ViewUI($entity);
Chris@0:     }
Chris@0: 
Chris@0:     return $view;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function applies($definition, $name, Route $route) {
Chris@0:     if (parent::applies($definition, $name, $route)) {
Chris@0:       return !empty($definition['tempstore']) && $definition['type'] === 'entity:view';
Chris@0:     }
Chris@0:     return FALSE;
Chris@0:   }
Chris@0: 
Chris@0: }