class FlowListBuilder in CMS Content Sync 2.1.x

Same name and namespace in other branches

8 src/Controller/FlowListBuilder.php \Drupal\cms_content_sync\Controller\FlowListBuilder
2.0.x src/Controller/FlowListBuilder.php \Drupal\cms_content_sync\Controller\FlowListBuilder

Provides a listing of Flow.

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\cms_content_sync\Controller\FlowListBuilder

Expanded class hierarchy of FlowListBuilder

File

src/Controller/FlowListBuilder.php, line 19

Namespace

Drupal\cms_content_sync\Controller

View source

class FlowListBuilder extends ConfigEntityListBuilder {

  /**
   * Constructs a new EntityListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface    $entity_type
   *                                                                   The entity type definition
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *                                                                   The entity storage class
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *                                                                   The config factory
   */
  public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, ConfigFactoryInterface $config_factory) {
    parent::__construct($entity_type, $storage);
    $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('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['name'] = $this
      ->t('Synchronization');
    $header['id'] = $this
      ->t('Machine name');
    $header['status'] = $this
      ->t('Status');
    return $header + parent::buildHeader();
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {

    /**
     * @var \Drupal\cms_content_sync\Entity\Flow $entity
     */
    $row['name'] = $entity
      ->label();
    $row['id'] = $entity
      ->id();
    $config = $this->configFactory
      ->get('cms_content_sync.flow.' . $entity
      ->id());
    $overwritten = $config
      ->get('status') != $entity
      ->status();
    $active = $overwritten ? !$entity
      ->status() : $entity
      ->status();
    $status = $active ? $this
      ->t('Active') : $this
      ->t('Inactive');
    if ($overwritten) {
      $status .= ' <i>(' . $this
        ->t('Overwritten') . ')</i>';
    }
    if ($active) {
      if ($entity
        ->getController()
        ->needsEntityTypeUpdate()) {
        $status .= ' <i>(' . $this
          ->t('Requires export') . ')</i>';
      }
    }
    $row['status'] = new FormattableMarkup($status, []);
    return $row + parent::buildRow($entity);
  }
  public function render() {
    $build = parent::render();
    $status_overwritten = false;
    $version_mismatch = false;
    $rows = $build['table']['#rows'];

    // Check if the site has already been registered.
    $settings = ContentSyncSettings::getInstance();
    if (Migration::alwaysUseV2() && !$settings
      ->getSiteUuid()) {
      $link = Link::fromTextAndUrl($this
        ->t('registered'), Url::fromRoute('cms_content_sync.site'))
        ->toString();
      $this
        ->messenger()
        ->addWarning($this
        ->t('The site needs to be @link before creating a flow.', [
        '@link' => $link,
      ]));
    }
    $build['advanced'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Advanced'),
      'add_form_advanced' => [
        '#type' => 'link',
        '#title' => $this
          ->t('Add advanced Flow (not recommended)'),
        '#url' => Url::fromRoute('entity.cms_content_sync_flow.add_form_advanced'),
        '#attributes' => [
          'class' => [
            'button',
            'button-action',
            'button--small',
          ],
        ],
      ],
      'copy_remote' => [
        '#type' => 'link',
        '#title' => $this
          ->t('Copy advanced Flow from other site'),
        '#url' => Url::fromRoute('entity.cms_content_sync_flow.copy_remote'),
        '#attributes' => [
          'class' => [
            'button',
            'button-action',
            'button--small',
          ],
        ],
      ],
      'assignment_form' => [
        '#type' => 'link',
        '#title' => $this
          ->t('Change Pool assignment of advanced Flow'),
        '#url' => Url::fromRoute('cms_content_sync.pool_assignment_form'),
        '#attributes' => [
          'class' => [
            'button',
            'button-action',
            'button--small',
          ],
        ],
      ],
    ];
    if (!empty($rows)) {
      foreach ($rows as $row) {
        if (strpos($row['status']
          ->__toString(), 'Overwritten')) {
          $status_overwritten = true;
        }
        if (strpos($row['status']
          ->__toString(), 'Requires export')) {
          $version_mismatch = true;
        }
      }
      if ($status_overwritten) {
        $build['explanation_overwritten'] = [
          '#markup' => '<i>' . $this
            ->t('Overwritten: The status of this flow has been overwritten in a settings file.') . '</i><br>',
        ];
      }
      if ($version_mismatch) {
        $always_v2 = Migration::alwaysUseV2();
        $message = $this
          ->t('Requires export: Entity types were changed, so the Flow must be exported again.');
        $build['explanation_version_mismatch'] = [
          '#markup' => '<i>' . $message . '</i>',
        ];
      }
      $build['hints'] = [
        '#markup' => '<h3>' . $this
          ->t('Hints') . '</h3>' . $this
          ->t('You can enable / disable Flows using your settings.php file:'),
      ];
      $overwrite_status = '<li>' . $this
        ->t('Status: <i>@overwrite_status</i>', [
        '@overwrite_status' => '$config["cms_content_sync.flow.<flow_machine_name>"]["status"] = FALSE;',
      ]) . '</li>';
      $build['hints_examples'] = [
        '#markup' => '<ul>' . $overwrite_status . '</ul>',
      ];
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityListBuilder::getDefaultOperations	public	function	Gets this list's default operations. Overrides EntityListBuilder::getDefaultOperations	15
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		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
FlowListBuilder::buildHeader	public	function	Builds the header row for the entity listing. Overrides EntityListBuilder::buildHeader
FlowListBuilder::buildRow	public	function	Builds a row for an entity in the entity listing. Overrides EntityListBuilder::buildRow
FlowListBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
FlowListBuilder::render	public	function	Builds the entity listing as renderable array for table.html.twig. Overrides EntityListBuilder::render
FlowListBuilder::__construct	public	function	Constructs a new EntityListBuilder object. Overrides EntityListBuilder::__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.

You are here

class FlowListBuilder in CMS Content Sync 2.1.x

Hierarchy

File

Namespace

Members

API Navigation