class ChannelForm in Entity Share 8.3

Same name and namespace in other branches

8 modules/entity_share_server/src/Form/ChannelForm.php \Drupal\entity_share_server\Form\ChannelForm
8.2 modules/entity_share_server/src/Form/ChannelForm.php \Drupal\entity_share_server\Form\ChannelForm

Entity form for the channel entity.

@package Drupal\entity_share_server\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\entity_share_server\Form\ChannelForm implements ContainerInjectionInterface

Expanded class hierarchy of ChannelForm

File

modules/entity_share_server/src/Form/ChannelForm.php, line 22

Namespace

Drupal\entity_share_server\Form

View source

class ChannelForm extends EntityForm implements ContainerInjectionInterface {

  /**
   * The bundle infos from the website.
   *
   * @var array
   */
  protected $bundleInfos;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a ChannelForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle info service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(EntityTypeBundleInfoInterface $entity_type_bundle_info, RendererInterface $renderer) {
    $this->bundleInfos = $entity_type_bundle_info
      ->getAllBundleInfo();
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.bundle.info'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#maxlength' => 255,
      '#default_value' => $channel
        ->label(),
      '#description' => $this
        ->t('Label for the channel.'),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $channel
        ->id(),
      '#machine_name' => [
        'exists' => '\\Drupal\\entity_share_server\\Entity\\Channel::load',
      ],
      '#disabled' => !$channel
        ->isNew(),
    ];
    $form['channel_entity_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Entity type'),
      '#options' => $this
        ->getEntityTypeOptions(),
      '#empty_value' => '',
      '#default_value' => $channel
        ->get('channel_entity_type'),
      '#required' => TRUE,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxBundleSelect',
        ],
        'effect' => 'fade',
        'method' => 'replace',
        'wrapper' => 'bundle-wrapper',
      ],
    ];

    // Container for the AJAX.
    $form['bundle_wrapper'] = [
      '#type' => 'container',
      // Force an id because otherwise default id is changed when using AJAX.
      '#attributes' => [
        'id' => 'bundle-wrapper',
      ],
    ];
    $this
      ->buildBundleSelect($form, $form_state);
    $this
      ->buildLanguageSelect($form, $form_state);
    $this
      ->buildGroupsTable($form, $form_state);
    $this
      ->buildFiltersTable($form, $form_state);
    $this
      ->buildSearchesTable($form, $form_state);
    $this
      ->buildSortsTable($form, $form_state);
    $authorized_users = $channel
      ->get('authorized_users');
    $form['authorized_users'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Authorized users'),
      '#description' => $this
        ->t('Only users with the %entity_share_server_access_channels permission are listed.', [
        '%entity_share_server_access_channels' => $this
          ->t('Access channels list'),
      ]),
      '#options' => $this
        ->getAuthorizedUsersOptions(),
      '#default_value' => !is_null($authorized_users) ? $authorized_users : [],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $authorized_users = array_filter($form_state
      ->getValue('authorized_users'));
    $channel
      ->set('authorized_users', $authorized_users);

    // Sorts order.
    $channel_sorts = $channel
      ->get('channel_sorts');
    if (is_null($channel_sorts)) {
      $channel_sorts = [];
    }
    $sorts = $form_state
      ->getValue('sort_table');
    if (!is_null($sorts) && is_array($sorts)) {
      foreach ($sorts as $sort_id => $sort) {
        $channel_sorts[$sort_id]['weight'] = $sort['weight'];
      }
    }
    $channel
      ->set('channel_sorts', $channel_sorts);
    $status = $channel
      ->save();
    switch ($status) {
      case SAVED_NEW:
        $this
          ->messenger()
          ->addStatus($this
          ->t('Created the %label Channel.', [
          '%label' => $channel
            ->label(),
        ]));
        break;
      default:
        $this
          ->messenger()
          ->addStatus($this
          ->t('Saved the %label Channel.', [
          '%label' => $channel
            ->label(),
        ]));
    }
    $form_state
      ->setRedirectUrl($channel
      ->toUrl('collection'));
  }

  /**
   * Ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   Subform.
   */
  public static function buildAjaxBundleSelect(array $form, FormStateInterface $form_state) {

    // We just need to return the relevant part of the form here.
    return $form['bundle_wrapper'];
  }

  /**
   * Ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   Subform.
   */
  public static function buildAjaxLanguageSelect(array $form, FormStateInterface $form_state) {

    // We just need to return the relevant part of the form here.
    return $form['bundle_wrapper']['language_wrapper'];
  }

  /**
   * Helper function to generate bundle select.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  protected function buildBundleSelect(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_entity_type = $channel
      ->get('channel_entity_type');
    $selected_entity_type = $form_state
      ->getValue('channel_entity_type');

    // No entity type selected and the channel does not have any.
    if (empty($selected_entity_type) && $channel_entity_type == '') {
      return;
    }
    if (!empty($selected_entity_type)) {
      $entity_type = $selected_entity_type;
    }
    else {
      $entity_type = $channel_entity_type;
    }
    $form['bundle_wrapper']['channel_bundle'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Bundle'),
      '#options' => $this
        ->getBundleOptions($entity_type),
      '#empty_value' => '',
      '#default_value' => $channel
        ->get('channel_bundle'),
      '#required' => TRUE,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxLanguageSelect',
        ],
        'effect' => 'fade',
        'method' => 'replace',
        'wrapper' => 'language-wrapper',
      ],
    ];

    // Container for the AJAX.
    $form['bundle_wrapper']['language_wrapper'] = [
      '#type' => 'container',
      // Force an id because otherwise default id is changed when using AJAX.
      '#attributes' => [
        'id' => 'language-wrapper',
      ],
    ];
  }

  /**
   * Helper function to generate language select.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  protected function buildLanguageSelect(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_entity_type = $channel
      ->get('channel_entity_type');
    $channel_bundle = $channel
      ->get('channel_bundle');
    $selected_entity_type = $form_state
      ->getValue('channel_entity_type');
    $selected_bundle = $form_state
      ->getValue('channel_bundle');

    // No bundle selected and the channel does not have any.
    if (empty($selected_bundle) && $channel_bundle == '') {
      return;
    }
    if (!empty($selected_entity_type) && !empty($selected_bundle)) {
      $entity_type = $selected_entity_type;
      $bundle = $selected_bundle;
    }
    else {
      $entity_type = $channel_entity_type;
      $bundle = $channel_bundle;
    }

    // Check if the bundle is translatable.
    if (isset($this->bundleInfos[$entity_type][$bundle]['translatable']) && $this->bundleInfos[$entity_type][$bundle]['translatable']) {
      $form['bundle_wrapper']['language_wrapper']['channel_langcode'] = [
        '#type' => 'language_select',
        '#title' => $this
          ->t('Language'),
        '#languages' => LanguageInterface::STATE_ALL,
        '#default_value' => $channel
          ->get('channel_langcode'),
      ];
    }
    else {
      $form['bundle_wrapper']['language_wrapper']['channel_langcode'] = [
        '#type' => 'value',
        '#value' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
      ];
    }
  }

  /**
   * Helper function to generate group form elements.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @throws \LogicException
   * @throws \Exception
   */
  protected function buildGroupsTable(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_groups = $channel
      ->get('channel_groups');
    if (is_null($channel_groups)) {
      $channel_groups = [];
    }
    $form['channel_groups'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Groups'),
    ];
    if ($channel
      ->isNew()) {
      $form['channel_groups']['group_message'] = [
        '#markup' => $this
          ->t("It will be possible to add groups after the channel's creation."),
      ];
    }
    else {
      $form['channel_groups']['group_actions'] = [
        '#type' => 'actions',
        '#weight' => -5,
      ];
      $form['channel_groups']['group_actions']['group_add'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Add a new group'),
        '#url' => Url::fromRoute('entity_share_server.group_add_form', [
          'channel' => $channel
            ->id(),
        ]),
        '#attributes' => [
          'class' => [
            'button',
            'button--primary',
          ],
        ],
      ];
      $header = [
        'id' => [
          'data' => $this
            ->t('ID'),
        ],
        'conjunction' => [
          'data' => $this
            ->t('Conjunction'),
        ],
        'memberof' => [
          'data' => $this
            ->t('Parent group'),
        ],
        'operations' => [
          'data' => $this
            ->t('Operations'),
        ],
      ];
      $rows = [];
      foreach ($channel_groups as $group_id => $group) {
        $operations = [
          '#type' => 'dropbutton',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('entity_share_server.group_edit_form', [
                'channel' => $channel
                  ->id(),
                'group' => $group_id,
              ]),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity_share_server.group_delete_form', [
                'channel' => $channel
                  ->id(),
                'group' => $group_id,
              ]),
            ],
          ],
        ];
        $row = [
          'id' => $group_id,
          'conjunction' => $group['conjunction'],
          'memberof' => isset($group['memberof']) ? $group['memberof'] : '',
          'operations' => $this->renderer
            ->render($operations),
        ];
        $rows[] = $row;
      }
      $form['channel_groups']['group_table'] = [
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#empty' => $this
          ->t('There is currently no group for this channel.'),
      ];
    }
  }

  /**
   * Helper function to generate filter form elements.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @throws \LogicException
   * @throws \Exception
   */
  protected function buildFiltersTable(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_filters = $channel
      ->get('channel_filters');
    if (is_null($channel_filters)) {
      $channel_filters = [];
    }
    $form['channel_filters'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Filters'),
    ];
    if ($channel
      ->isNew()) {
      $form['channel_filters']['filter_message'] = [
        '#markup' => $this
          ->t("It will be possible to add filters after the channel's creation."),
      ];
    }
    else {
      $form['channel_filters']['filter_actions'] = [
        '#type' => 'actions',
        '#weight' => -5,
      ];
      $form['channel_filters']['filter_actions']['filter_add'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Add a new filter'),
        '#url' => Url::fromRoute('entity_share_server.filter_add_form', [
          'channel' => $channel
            ->id(),
        ]),
        '#attributes' => [
          'class' => [
            'button',
            'button--primary',
          ],
        ],
      ];
      $header = [
        'id' => [
          'data' => $this
            ->t('ID'),
        ],
        'path' => [
          'data' => $this
            ->t('Path'),
        ],
        'operator' => [
          'data' => $this
            ->t('Operator'),
        ],
        'value' => [
          'data' => $this
            ->t('Value'),
        ],
        'group' => [
          'data' => $this
            ->t('Group'),
        ],
        'operations' => [
          'data' => $this
            ->t('Operations'),
        ],
      ];
      $rows = [];
      foreach ($channel_filters as $filter_id => $filter) {
        $operations = [
          '#type' => 'dropbutton',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('entity_share_server.filter_edit_form', [
                'channel' => $channel
                  ->id(),
                'filter' => $filter_id,
              ]),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity_share_server.filter_delete_form', [
                'channel' => $channel
                  ->id(),
                'filter' => $filter_id,
              ]),
            ],
          ],
        ];
        $row = [
          'id' => $filter_id,
          'path' => $filter['path'],
          'operator' => $filter['operator'],
          'value' => '',
          'filter' => isset($filter['memberof']) ? $filter['memberof'] : '',
          'operations' => $this->renderer
            ->render($operations),
        ];
        if (isset($filter['value'])) {
          $value = [
            '#theme' => 'item_list',
            '#items' => $filter['value'],
          ];
          $row['value'] = $this->renderer
            ->render($value);
        }
        $rows[] = $row;
      }
      $form['channel_filters']['filter_table'] = [
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#empty' => $this
          ->t('There is currently no filter for this channel.'),
      ];
    }
  }

  /**
   * Helper function to generate search form elements.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @throws \LogicException
   * @throws \Exception
   */
  protected function buildSearchesTable(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_searches = $channel
      ->get('channel_searches');
    if (is_null($channel_searches)) {
      $channel_searches = [];
    }
    $form['channel_searches'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Searches'),
    ];

    // Add a warning message.
    $form['channel_searches']['warning_message'] = [
      '#theme' => 'status_messages',
      '#message_list' => [
        'warning' => [
          $this
            ->t('The label of the entity if it exists is automatically searchable. Do not add a search for that.'),
        ],
      ],
    ];
    if ($channel
      ->isNew()) {
      $form['channel_searches']['search_message'] = [
        '#markup' => $this
          ->t("It will be possible to add searches after the channel's creation."),
      ];
    }
    else {
      $form['channel_searches']['search_actions'] = [
        '#type' => 'actions',
        '#weight' => -5,
      ];
      $form['channel_searches']['search_actions']['search_add'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Add a new search'),
        '#url' => Url::fromRoute('entity_share_server.search_add_form', [
          'channel' => $channel
            ->id(),
        ]),
        '#attributes' => [
          'class' => [
            'button',
            'button--primary',
          ],
        ],
      ];
      $header = [
        'id' => [
          'data' => $this
            ->t('ID'),
        ],
        'path' => [
          'data' => $this
            ->t('Path'),
        ],
        'label' => [
          'data' => $this
            ->t('Label'),
        ],
        'operations' => [
          'data' => $this
            ->t('Operations'),
        ],
      ];
      $rows = [];
      foreach ($channel_searches as $search_id => $search) {
        $operations = [
          '#type' => 'dropbutton',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('entity_share_server.search_edit_form', [
                'channel' => $channel
                  ->id(),
                'search' => $search_id,
              ]),
            ],
            'delete' => [
              'title' => $this
                ->t('Delete'),
              'url' => Url::fromRoute('entity_share_server.search_delete_form', [
                'channel' => $channel
                  ->id(),
                'search' => $search_id,
              ]),
            ],
          ],
        ];
        $row = [
          'id' => $search_id,
          'path' => $search['path'],
          'label' => $search['label'],
          'operations' => $this->renderer
            ->render($operations),
        ];
        if (isset($search['value'])) {
          $value = [
            '#theme' => 'item_list',
            '#items' => $search['value'],
          ];
          $row['value'] = $this->renderer
            ->render($value);
        }
        $rows[] = $row;
      }
      $form['channel_searches']['search_table'] = [
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#empty' => $this
          ->t('There is currently no search for this channel.'),
      ];
    }
  }

  /**
   * Helper function to generate sort form elements.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  protected function buildSortsTable(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
    $channel = $this->entity;
    $channel_sorts = $channel
      ->get('channel_sorts');
    if (is_null($channel_sorts)) {
      $channel_sorts = [];
    }
    $form['channel_sorts'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('sorts'),
    ];
    if ($channel
      ->isNew()) {
      $form['channel_sorts']['sort_message'] = [
        '#markup' => $this
          ->t("It will be possible to add sorts after the channel's creation."),
      ];
    }
    else {
      $form['channel_sorts']['sort_actions'] = [
        '#type' => 'actions',
        '#weight' => -5,
      ];
      $form['channel_sorts']['sort_actions']['sort_add'] = [
        '#type' => 'link',
        '#title' => $this
          ->t('Add a new sort'),
        '#url' => Url::fromRoute('entity_share_server.sort_add_form', [
          'channel' => $channel
            ->id(),
        ]),
        '#attributes' => [
          'class' => [
            'button',
            'button--primary',
          ],
        ],
      ];
      $header = [
        'id' => [
          'data' => $this
            ->t('ID'),
        ],
        'path' => [
          'data' => $this
            ->t('Path'),
        ],
        'direction' => [
          'data' => $this
            ->t('Direction'),
        ],
        'weight' => [
          'data' => $this
            ->t('Weight'),
        ],
        'operations' => [
          'data' => $this
            ->t('Operations'),
        ],
      ];
      $form['channel_sorts']['sort_table'] = [
        '#type' => 'table',
        '#header' => $header,
        '#empty' => $this
          ->t('There is currently no sort for this channel.'),
        '#tabledrag' => [
          [
            'action' => 'order',
            'relationship' => 'sibling',
            'group' => 'weight',
          ],
        ],
      ];
      uasort($channel_sorts, [
        SortArray::class,
        'sortByWeightElement',
      ]);
      foreach ($channel_sorts as $sort_id => $sort) {
        $row = [
          '#attributes' => [
            'class' => [
              'draggable',
            ],
          ],
          'id' => [
            '#markup' => $sort_id,
          ],
          'path' => [
            '#markup' => $sort['path'],
          ],
          'direction' => [
            '#markup' => $sort['direction'],
          ],
          'weight' => [
            '#type' => 'weight',
            '#title' => $this
              ->t('Weight'),
            '#title_display' => 'invisible',
            '#default_value' => $sort['weight'],
            '#attributes' => [
              'class' => [
                'weight',
              ],
            ],
          ],
          'operations' => [
            '#type' => 'dropbutton',
            '#links' => [
              'edit' => [
                'title' => $this
                  ->t('Edit'),
                'url' => Url::fromRoute('entity_share_server.sort_edit_form', [
                  'channel' => $channel
                    ->id(),
                  'sort' => $sort_id,
                ]),
              ],
              'delete' => [
                'title' => $this
                  ->t('Delete'),
                'url' => Url::fromRoute('entity_share_server.sort_delete_form', [
                  'channel' => $channel
                    ->id(),
                  'sort' => $sort_id,
                ]),
              ],
            ],
          ],
        ];
        $form['channel_sorts']['sort_table'][$sort_id] = $row;
      }
    }
  }

  /**
   * Helper function to get the entity type options.
   *
   * @return array
   *   An array of options.
   */
  protected function getEntityTypeOptions() {
    $options = [];
    $definitions = $this->entityTypeManager
      ->getDefinitions();
    foreach ($definitions as $entity_type_id => $definition) {

      // Keep only content entity type without user.
      if ($definition
        ->getGroup() != 'content' || $entity_type_id == 'user') {
        continue;
      }

      // Keep only content entity type with UUID (required for JSON API).
      if (!$definition
        ->hasKey('uuid')) {
        continue;
      }
      $options[$entity_type_id] = $definition
        ->getLabel();
    }
    return $options;
  }

  /**
   * Helper function to get the bundle options.
   *
   * @param string $selected_entity_type
   *   The entity type.
   *
   * @return array
   *   An array of options.
   */
  protected function getBundleOptions($selected_entity_type) {
    $options = [];
    foreach ($this->bundleInfos[$selected_entity_type] as $bundle_id => $bundle_info) {
      $options[$bundle_id] = $bundle_info['label'];
    }
    return $options;
  }

  /**
   * Helper function.
   *
   * Get users with permission entity_share_server_access_channels.
   *
   * @return array
   *   An array of options.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  protected function getAuthorizedUsersOptions() {
    $authorized_users = [];
    $authorized_roles = [];
    $users = [];

    // Filter on roles having access to the channel list.

    /** @var \Drupal\user\RoleInterface[] $roles */
    $roles = $this->entityTypeManager
      ->getStorage('user_role')
      ->loadMultiple();
    foreach ($roles as $role) {
      if ($role
        ->hasPermission('entity_share_server_access_channels')) {
        $authorized_roles[] = $role
          ->id();
      }
    }
    if (!empty($authorized_roles)) {
      if (in_array('anonymous', $authorized_roles)) {
        $authorized_users['anonymous'] = $this
          ->t('Anonymous');
      }
      $users = $this->entityTypeManager
        ->getStorage('user')
        ->loadByProperties([
        'roles' => $authorized_roles,
      ]);
    }
    foreach ($users as $user) {
      $authorized_users[$user
        ->uuid()] = $user
        ->label();
    }
    return $authorized_users;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChannelForm::$bundleInfos	protected	property	The bundle infos from the website.
ChannelForm::$renderer	protected	property	The renderer service.
ChannelForm::buildAjaxBundleSelect	public static	function	Ajax callback.
ChannelForm::buildAjaxLanguageSelect	public static	function	Ajax callback.
ChannelForm::buildBundleSelect	protected	function	Helper function to generate bundle select.
ChannelForm::buildFiltersTable	protected	function	Helper function to generate filter form elements.
ChannelForm::buildGroupsTable	protected	function	Helper function to generate group form elements.
ChannelForm::buildLanguageSelect	protected	function	Helper function to generate language select.
ChannelForm::buildSearchesTable	protected	function	Helper function to generate search form elements.
ChannelForm::buildSortsTable	protected	function	Helper function to generate sort form elements.
ChannelForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ChannelForm::form	public	function	Gets the actual form array to be built. Overrides EntityForm::form
ChannelForm::getAuthorizedUsersOptions	protected	function	Helper function.
ChannelForm::getBundleOptions	protected	function	Helper function to get the bundle options.
ChannelForm::getEntityTypeOptions	protected	function	Helper function to get the entity type options.
ChannelForm::save	public	function	Form submission handler for the 'save' action. Overrides EntityForm::save
ChannelForm::__construct	public	function	Constructs a ChannelForm object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actions	protected	function	Returns an array of supported actions for the current entity form.	29
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity	2
EntityForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	10
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::getBaseFormId	public	function	Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId	5
EntityForm::getEntity	public	function	Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm	public	function	This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm	17
EntityForm::__get	public	function
EntityForm::__set	public	function
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class ChannelForm in Entity Share 8.3

Hierarchy

File

Namespace

Members

API Navigation