You are here

Home » API reference » Extensible BBCode 4.0.x » TagForm.php

class TagForm in Extensible BBCode 4.0.x

Same name and namespace in other branches
  1. 8.3 src/Form/TagForm.php \Drupal\xbbcode\Form\TagForm

Base form for creating and editing custom tags.

Hierarchy

Expanded class hierarchy of TagForm

File

src/Form/TagForm.php, line 19

Namespace

Drupal\xbbcode\Form
View source 
class TagForm extends TagFormBase {

  /**
   * The tag storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * The tag plugin manager.
   *
   * @var \Drupal\xbbcode\TagPluginManager
   */
  protected $manager;

  /**
   * Constructs a new TagForm.
   *
   * @param \Drupal\Core\Template\TwigEnvironment $twig
   *   The twig service.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The tag storage.
   * @param \Drupal\xbbcode\TagPluginManager $manager
   *   The tag plugin manager.
   */
  public function __construct(TwigEnvironment $twig, EntityStorageInterface $storage, TagPluginManager $manager) {
    parent::__construct($twig);
    $this->storage = $storage;
    $this->manager = $manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : self {
    return new static($container
      ->get('twig'), $container
      ->get('entity_type.manager')
      ->getStorage('xbbcode_tag'), $container
      ->get('plugin.manager.xbbcode'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) : array {
    $form = parent::form($form, $form_state);
    $form['name']['#attached']['library'] = [
      'xbbcode/tag-form',
    ];
    $form['preview']['code'] += [
      '#prefix' => '<div id="ajax-preview">',
      '#suffix' => '</div>',
    ];

    // Update preview if the sample or the template are manually changed.
    // (The sample and the name are kept in sync locally.)
    $form['sample']['#ajax'] = $form['template_code']['#ajax'] = [
      'wrapper' => 'ajax-preview',
      'callback' => [
        $this,
        'ajaxPreview',
      ],
      // Don't refocus into the text field, and only update on change.
      'disable-refocus' => TRUE,
      'event' => 'change',
    ];

    // The preview may need to show error messages on update.
    $form['preview']['#attached']['library'] = [
      'classy/messages',
    ];
    return $form;
  }

  /**
   * Return the code preview for asynchronous rendering.
   *
   * @param array $form
   *   The form array.
   *
   * @return array
   *   The sub-array of the preview field.
   */
  public function ajaxPreview(array $form) : array {
    return $form['preview']['code'];
  }

  /**
   * {@inheritdoc}
   */
  protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) : void {
    parent::copyFormValuesToEntity($entity, $form, $form_state);

    /** @var \Drupal\xbbcode\Entity\TagInterface $entity */
    $name = $entity
      ->getName();

    // Ensure the input is safe for regex patterns, as it is not yet validated.
    if (!preg_match('/^\\w+$/', $name)) {
      return;
    }

    // Reverse replacement of the tag name.
    $expression = '/(\\[\\/?)' . $name . '([\\s\\]=])/';
    $replace = '\\1{{ name }}\\2';
    $sample = preg_replace($expression, $replace, $form_state
      ->getValue('sample'));
    $entity
      ->set('sample', $sample);
  }

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

    /** @var \Drupal\xbbcode\Entity\TagInterface $tag */
    $tag = $this->entity;

    // Set up a mock parser and do a practice run with this tag.
    $called = FALSE;
    $processor = new CallbackTagProcessor(static function () use (&$called) {
      $called = TRUE;
    });
    $parser = new XBBCodeParser([
      $tag
        ->getName() => $processor,
    ]);
    $sample = str_replace('{{ name }}', $tag
      ->getName(), $tag
      ->getSample());
    $tree = $parser
      ->parse($sample);
    try {
      $template = $this->twig
        ->load(EntityTagPlugin::TEMPLATE_PREFIX . $tag
        ->getTemplateCode());
      $processor
        ->setProcess(static function ($tag) use ($template, &$called) {
        $called = TRUE;
        return $template
          ->render([
          'tag' => $tag,
        ]);
      });
    } catch (TwigError $exception) {
      $error = str_replace(EntityTagPlugin::TEMPLATE_PREFIX, '', $exception
        ->getMessage());
      $form_state
        ->setError($form['template_code'], $this
        ->t('The template could not be compiled: @error', [
        '@error' => $error,
      ]));
    }
    try {
      $tree
        ->render();
    } catch (\Throwable $exception) {
      $form_state
        ->setError($form['template_code'], $this
        ->t('An error occurred while rendering the template: @error', [
        '@error' => $exception
          ->getMessage(),
      ]));
    }
    if (!$called) {
      $form_state
        ->setError($form['sample'], $this
        ->t('The sample code should contain a valid example of the tag.'));
    }
  }

  /**
   * Determines if the tag already exists.
   *
   * @param string $tag_id
   *   The tag ID.
   *
   * @return bool
   *   TRUE if the tag exists, FALSE otherwise.
   */
  public function exists(string $tag_id) : bool {
    return (bool) $this->storage
      ->getQuery()
      ->condition('id', $tag_id)
      ->execute();
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Core\Entity\EntityMalformedException
   * @throws \Drupal\Core\Entity\Exception\UndefinedLinkTemplateException
   */
  public function save(array $form, FormStateInterface $form_state) : int {
    $result = parent::save($form, $form_state);
    if ($result === SAVED_NEW) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The BBCode tag %tag has been created.', [
        '%tag' => $this->entity
          ->label(),
      ]));
    }
    elseif ($result === SAVED_UPDATED) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('The BBCode tag %tag has been updated.', [
        '%tag' => $this->entity
          ->label(),
      ]));
    }
    $form_state
      ->setRedirectUrl($this->entity
      ->toUrl('collection'));
    return $result;
  }

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

    // Warn about navigating away from unsaved form.
    if (isset($actions['copy'])) {
      $actions['copy']['#title'] = $this
        ->t('Copy (discard unsaved changes)');
    }
    return $actions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$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::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::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
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.
LabeledFormTrait::addLabelFields public function Add label fields to the form array.
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.
TagForm::$manager protected property The tag plugin manager.
TagForm::$storage protected property The tag storage.
TagForm::actions protected function Returns an array of supported actions for the current entity form. Overrides TagFormBase::actions
TagForm::ajaxPreview public function Return the code preview for asynchronous rendering.
TagForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. Overrides TagFormBase::copyFormValuesToEntity
TagForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TagForm::exists public function Determines if the tag already exists.
TagForm::form public function Gets the actual form array to be built. Overrides TagFormBase::form
TagForm::save public function Overrides EntityForm::save
TagForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
TagForm::__construct public function Constructs a new TagForm. Overrides TagFormBase::__construct
TagFormBase::$twig protected property The twig service.
TagFormBase::getEntity public function Gets the form entity. Overrides LabeledFormTrait::getEntity
TagFormBase::templateError public function Render the code of a broken template with line numbers.