You are here

Home » API reference » Structured Data (JSON+LD Rich Snippets) 8 » PageJsonForm.php

class PageJsonForm in Structured Data (JSON+LD Rich Snippets) 8

Class PageJsonForm.

@package Drupal\structured_data\Form

Hierarchy

Expanded class hierarchy of PageJsonForm

1 string reference to 'PageJsonForm'
structured_data.routing.yml in ./structured_data.routing.yml
structured_data.routing.yml

File

src/Form/PageJsonForm.php, line 15

Namespace

Drupal\structured_data\Form
View source 
class PageJsonForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'structured_data_page_json_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $entity = $this
      ->getEntity();
    $form['route_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Route Name'),
      '#required' => TRUE,
      '#default_value' => $entity->route_name,
    ];
    $form['url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Url'),
      '#required' => FALSE,
      '#default_value' => $entity->url,
    ];
    $form['bundle'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Bundle'),
      '#required' => FALSE,
      '#default_value' => $entity->bundle === Helper::EMPTY_BUNDLE ? '' : $entity->bundle,
    ];
    $form['entity_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Entity Id'),
      '#required' => FALSE,
      '#default_value' => $entity->entity_id == '0' ? '' : $entity->entity_id,
    ];
    $form['json'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Json'),
      '#required' => FALSE,
      '#default_value' => $entity->json,
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $entity = [
      'route_name' => $form_state
        ->getValue('route_name'),
      'url' => $form_state
        ->getValue('url'),
      'bundle' => $form_state
        ->getValue('bundle'),
      'entity_id' => $form_state
        ->getValue('entity_id'),
      'json' => $form_state
        ->getValue('json'),
      'updated_by' => $this
        ->currentUser()
        ->id(),
      'updated_time' => time(),
    ];
    Helper::updatePageJson($entity);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Page Json updated successfully.'));
    if (!empty($entity['url'])) {
      $url = Url::fromUri('internal:' . $entity['url']);
      $form_state
        ->setRedirectUrl($url);
    }
  }

  /**
   * Get entity details from current route.
   *
   * @return mixed|\stdClass
   *   Entity details.
   */
  private function getEntity() {
    $route_name = $this
      ->getRouteMatch()
      ->getParameter('sd_route_name');
    $url = $this
      ->getRouteMatch()
      ->getParameter('sd_url');
    $bundle = $this
      ->getRouteMatch()
      ->getParameter('sd_bundle');
    $entity_id = $this
      ->getRouteMatch()
      ->getParameter('sd_entity_id');
    $url = str_replace('|', '/', $url);
    $url = base64_decode($url);
    $entity = Helper::getPageJson([
      'route_name' => $route_name,
      'url' => $url,
      'bundle' => $bundle,
      'entity_id' => $entity_id,
    ]);
    if (empty($entity)) {
      $entity = new \stdClass();
      $entity->route_name = $route_name;
      $entity->url = $url;
      $entity->bundle = $bundle;
      $entity->entity_id = $entity_id;
      $entity->json = '';
    }
    return $entity;
  }

}

Members

Namesort descending 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::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.
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.
PageJsonForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PageJsonForm::getEntity private function Get entity details from current route.
PageJsonForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PageJsonForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PageJsonForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.