class AddToCalForm in Add to Cal 8

Class AddToCalForm

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\addtocal\Form\AddToCalForm

Expanded class hierarchy of AddToCalForm

1 file declares its use of AddToCalForm

AddtocalView.php in src/Plugin/Field/FieldFormatter/AddtocalView.php

File

src/Form/AddToCalForm.php, line 13

Namespace

Drupal\addtocal\Form

View source

class AddToCalForm extends FormBase {

  /**
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $entity;

  /**
   * @var array
   */
  protected $settings;

  /**
   * @var int
   */
  protected $delta;

  /**
   * AddToCalForm constructor.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   * @param $settings
   * @param $delta
   */
  public function __construct(EntityInterface $entity, $settings, $delta) {
    $this->entity = $entity;
    $this->settings = $settings;
    $this->delta = $delta;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    $form_id = 'addtocal_' . $this->entity
      ->bundle() . '_' . $this->settings['field_name'] . '_' . $this->entity
      ->id();
    return $form_id;
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   * @param null $entity
   * @param null $settings
   * @return array
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Need both entity and settings to do anything of note
    if (!is_object($this->entity) || empty($this->settings)) {
      return $form;
    }

    // Always open in new tab
    $form['#attributes']['target'] = '_blank';

    // CSS / JS Libraries
    $form['#attributes']['class'][] = 'addtocal-form';
    $form['#attached']['library'][] = 'addtocal/addtocal';

    // Pass through to submit
    $form['entity'] = [
      '#type' => 'value',
      '#value' => $this->entity,
    ];
    $form['settings'] = [
      '#type' => 'value',
      '#value' => $this->settings,
    ];
    $form['delta'] = [
      '#type' => 'value',
      '#value' => $this->delta,
    ];

    // Unique element based on field
    $entity_type = $this->entity
      ->bundle();
    $field_name = $this->settings['field_name'];
    $element_id = 'addtocal-' . $entity_type . '-' . $field_name . '-' . $this->entity
      ->id() . '--' . $this->delta;

    // Wrap the form output for easier styling
    $form['addtocal_container'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'addtocal-container',
        ],
      ],
    ];
    $form['addtocal_container']['addtocal_btn'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'addtocal',
        ],
      ],
      '#id' => $element_id,
      '#markup' => $this
        ->t('Add to Calendar'),
    ];

    // @TODO: make selection options part of the field config
    $form['addtocal_container']['type'] = [
      '#type' => 'radios',
      '#options' => [
        'generic' => $this
          ->t('iCal / Outlook'),
        'google' => $this
          ->t('Google'),
        'yahoo' => $this
          ->t('Yahoo!'),
      ],
      '#attributes' => [
        'class' => [
          'addtocal-menu',
        ],
        'onclick' => 'this.form.submit();',
      ],
      '#id' => $element_id . '-menu',
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
      '#attributes' => [
        'class' => [
          'addtocal-submit',
        ],
      ],
    ];
    return $form;
  }

  /**
   * @param array $form
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $entity = $values['entity'];
    $settings = $values['settings'];
    $delta = $values['delta'];
    $type = $values['type'];

    /** @var AddToCalTypeManager $manager */
    $manager = \Drupal::service('plugin.manager.addtocal.type');
    $instance = $manager
      ->createInstance($type);

    // Process the plugin submit
    $instance
      ->downloadSubmit($entity, $settings, $delta, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddToCalForm::$delta	protected	property
AddToCalForm::$entity	protected	property
AddToCalForm::$settings	protected	property
AddToCalForm::buildForm	public	function	Overrides FormInterface::buildForm
AddToCalForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddToCalForm::submitForm	public	function	Overrides FormInterface::submitForm
AddToCalForm::__construct	public	function	AddToCalForm constructor.
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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 AddToCalForm in Add to Cal 8

Hierarchy

File

Namespace

Members

API Navigation