You are here

Home » API reference » Opigno calendar event 3.x » CalendarEventTypeForm.php

class CalendarEventTypeForm in Opigno calendar event 3.x

Same name and namespace in other branches
  1. 8 src/Form/CalendarEventTypeForm.php \Drupal\opigno_calendar_event\Form\CalendarEventTypeForm

Form handler for calendar event type forms.

Hierarchy

Expanded class hierarchy of CalendarEventTypeForm

File

src/Form/CalendarEventTypeForm.php, line 17

Namespace

Drupal\opigno_calendar_event\Form
View source 
class CalendarEventTypeForm extends BundleEntityFormBase {
  use CalendarEventExceptionLoggerTrait;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * CalendarEventTypeForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /* @noinspection PhpParamsInspection */
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\opigno_calendar_event\Entity\CalendarEventType $type */
    $type = $this->entity;
    $form['label'] = [
      '#title' => $this
        ->t('Label'),
      '#type' => 'textfield',
      '#default_value' => $type
        ->label(),
      '#description' => $this
        ->t('The human-readable name of this calendar event type.'),
      '#required' => TRUE,
      '#size' => 30,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $type
        ->id(),
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#machine_name' => [
        'exists' => [
          'Drupal\\opigno_calendar_event\\Entity\\CalendarEventType',
          'load',
        ],
        'source' => [
          'label',
        ],
      ],
      '#description' => $this
        ->t('A unique machine-readable name for this calendar event type. It must only contain lowercase letters, numbers, and underscores.'),
    ];
    $form['description'] = [
      '#title' => $this
        ->t('Description'),
      '#type' => 'textarea',
      '#default_value' => $type
        ->get('description'),
      '#description' => $this
        ->t('This text will be displayed on the <em>Add new calendar event</em> page.'),
    ];
    $form['advanced'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $options = $this
      ->getDateFieldTypes();
    $default_value = $type
      ->isNew() ? key(array_reverse($options)) : $type
      ->get('date_field_type');

    /** @var \Drupal\opigno_calendar_event\CalendarEventStorage $storage */
    $storage = $this->entityTypeManager
      ->getStorage(CalendarEventInterface::ENTITY_TYPE_ID);

    // @todo Add a validation constraint for this once config entity validation
    //   is supported. See https://www.drupal.org/project/drupal/issues/1818574.
    $disabled = !$type
      ->isNew() && $storage
      ->hasBundleData($type
      ->id());
    $description = !$disabled ? $this
      ->t('Choose which kind of date this calendar event type will use: Drupal provides the <em>Date</em> and <em>Date range</em> types, contributed modules may define more.') : $this
      ->t('This setting cannot be changed because there is data for this calendar event type.');
    $form['advanced']['date_field_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Date type'),
      '#description' => $description,
      '#options' => $options,
      '#default_value' => $default_value,
      '#disabled' => $disabled,
    ];
    return $this
      ->protectBundleIdElement($form);
  }

  /**
   * Returns a list of available date field types.
   *
   * @return string[]
   *   An associative array of date field type label keyed by type ID.
   */
  protected function getDateFieldTypes() {

    // @todo Leverage the Calendar API to retrieve supported field types, when
    //   one is available.
    $types = [
      'timestamp' => $this
        ->t('Timestamp'),
      'datetime' => $this
        ->t('Date'),
      'daterange' => $this
        ->t('Date range'),
    ];
    if ($this->moduleHandler
      ->moduleExists('date_recur')) {
      $types['date_recur'] = $this
        ->t('Recurring dates');
    }
    return $types;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $id = trim($form_state
      ->getValue('type'));

    // '0' is invalid, since elsewhere we check it using empty().
    if ($id == '0') {
      $form_state
        ->setErrorByName('type', $this
        ->t("Invalid machine-readable name. Enter a name other than %invalid.", [
        '%invalid' => $id,
      ]));
    }
  }

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

    /** @var \Drupal\opigno_calendar_event\Entity\CalendarEventType $type */
    $type = $this->entity;
    try {
      $type
        ->set('type', trim($type
        ->id()));
      $type
        ->set('name', trim($type
        ->label()));
      $status = $type
        ->save();
      $t_args = [
        '%name' => $type
          ->label(),
      ];
      if ($status == SAVED_UPDATED) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('The calendar event type %name has been updated.', $t_args));
      }
      elseif ($status == SAVED_NEW) {
        $this
          ->messenger()
          ->addStatus($this
          ->t('The calendar event %name has been added.', $t_args));
        $context = array_merge($t_args, [
          'link' => $type
            ->toLink('View', 'collection')
            ->toString(),
        ]);
        $this
          ->logger('opigno_calendar_event')
          ->notice('Added calendar event type %name.', $context);
      }
      $form_state
        ->setRedirectUrl($type
        ->toUrl('collection'));
    } catch (EntityStorageException $e) {
      $this
        ->logException($e);
      $this
        ->messenger()
        ->addError($this
        ->t('The calendar event type could not be saved.'));
      $form_state
        ->setRebuild(TRUE);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BundleEntityFormBase::protectBundleIdElement protected function Protects the bundle entity's ID property's form element against changes.
CalendarEventExceptionLoggerTrait::logException protected function Logs an exception.
CalendarEventTypeForm::$entityTypeManager protected property The entity manager. Overrides EntityForm::$entityTypeManager
CalendarEventTypeForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CalendarEventTypeForm::form public function Overrides EntityForm::form
CalendarEventTypeForm::getDateFieldTypes protected function Returns a list of available date field types.
CalendarEventTypeForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
CalendarEventTypeForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
CalendarEventTypeForm::__construct public function CalendarEventTypeForm constructor.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 35
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 3
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
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 3
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
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::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 20
FormBase::$configFactory protected property The config factory. 3
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. 3
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.
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.
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. 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.