class OverviewForm in Linkit 8.4

Same name in this branch

8.4 src/Form/Attribute/OverviewForm.php \Drupal\linkit\Form\Attribute\OverviewForm
8.4 src/Form/Matcher/OverviewForm.php \Drupal\linkit\Form\Matcher\OverviewForm

Provides an overview form for attribute on a profile.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\linkit\Form\Attribute\OverviewForm

Expanded class hierarchy of OverviewForm

1 string reference to 'OverviewForm'

linkit.routing.yml in ./linkit.routing.yml: linkit.routing.yml

File

src/Form/Attribute/OverviewForm.php, line 21: Contains \Drupal\linkit\Form\Attribute\OverviewForm.

Namespace

Drupal\linkit\Form\Attribute

View source

class OverviewForm extends FormBase {

  /**
   * The profiles to which the attributes are applied to.
   *
   * @var \Drupal\linkit\ProfileInterface
   */
  private $linkitProfile;

  /**
   * The attribute manager.
   *
   * @var \Drupal\linkit\AttributeManager
   */
  protected $manager;

  /**
   * Constructs a new OverviewForm.
   *
   * @param \Drupal\linkit\AttributeManager $manager
   *   The attribute manager.
   */
  public function __construct(AttributeManager $manager) {
    $this->manager = $manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.linkit.attribute'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return "linkit_attribute_overview_form";
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ProfileInterface $linkit_profile = NULL) {
    $this->linkitProfile = $linkit_profile;
    $form['plugins'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Attribute'),
        $this
          ->t('Description'),
        $this
          ->t('Weight'),
        $this
          ->t('Operations'),
      ],
      '#empty' => $this
        ->t('No attributes added.'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'plugin-order-weight',
        ],
      ],
    ];
    foreach ($this->linkitProfile
      ->getAttributes() as $plugin) {
      $key = $plugin
        ->getPluginId();
      $form['plugins'][$key]['#attributes']['class'][] = 'draggable';
      $form['plugins'][$key]['#weight'] = $plugin
        ->getWeight();
      $form['plugins'][$key]['label'] = [
        '#plain_text' => (string) $plugin
          ->getLabel(),
      ];
      $form['plugins'][$key]['description'] = [
        '#plain_text' => (string) $plugin
          ->getDescription(),
      ];
      $form['plugins'][$key]['weight'] = [
        '#type' => 'weight',
        '#title' => t('Weight for @title', [
          '@title' => (string) $plugin
            ->getLabel(),
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $plugin
          ->getWeight(),
        '#attributes' => [
          'class' => [
            'plugin-order-weight',
          ],
        ],
      ];
      $form['plugins'][$key]['operations'] = [
        '#type' => 'operations',
        '#links' => [],
      ];
      $is_configurable = $plugin instanceof ConfigurableAttributeInterface;
      if ($is_configurable) {
        $form['plugins'][$key]['operations']['#links']['edit'] = [
          'title' => t('Edit'),
          'url' => Url::fromRoute('linkit.attribute.edit', [
            'linkit_profile' => $this->linkitProfile
              ->id(),
            'plugin_instance_id' => $key,
          ]),
        ];
      }
      $form['plugins'][$key]['operations']['#links']['delete'] = [
        'title' => t('Delete'),
        'url' => Url::fromRoute('linkit.attribute.delete', [
          'linkit_profile' => $this->linkitProfile
            ->id(),
          'plugin_instance_id' => $key,
        ]),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    foreach ($form_state
      ->getValue('plugins') as $id => $plugin_data) {
      if ($this->linkitProfile
        ->getAttributes()
        ->has($id)) {
        $this->linkitProfile
          ->getAttribute($id)
          ->setWeight($plugin_data['weight']);
      }
    }
    $this->linkitProfile
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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.
OverviewForm::$linkitProfile	private	property	The profiles to which the attributes are applied to.
OverviewForm::$manager	protected	property	The attribute manager.
OverviewForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
OverviewForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
OverviewForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OverviewForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
OverviewForm::__construct	public	function	Constructs a new OverviewForm.
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 OverviewForm in Linkit 8.4

Hierarchy

File

Namespace

Members

API Navigation