You are here

Home » API reference » Apigee API Catalog 8 » ApiDocSettingsForm.php

class ApiDocSettingsForm in Apigee API Catalog 8

Class ApiDocSettingsForm.

Settings for the ApiDoc entity type.

Hierarchy

Expanded class hierarchy of ApiDocSettingsForm

1 file declares its use of ApiDocSettingsForm
ApiDoc.php in src/Entity/ApiDoc.php

File

src/Entity/Form/ApiDocSettingsForm.php, line 33

Namespace

Drupal\apigee_api_catalog\Entity\Form
View source 
class ApiDocSettingsForm extends FormBase {
  public const CONFIG_NAME = 'apigee_api_catalog.apidoc.config';

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

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $entity_type = $this->entityTypeManager
      ->getStorage('apidoc')
      ->getEntityType();
    $config = $this
      ->configFactory()
      ->getEditable(static::CONFIG_NAME);
    $options = $form_state
      ->getValue('options');
    $config
      ->set('default_revision', (bool) $options['new_revision'])
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('@type settings have been updated.', [
      '@type' => $entity_type
        ->getLabel(),
    ]));
  }

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

    /* @var \Drupal\apigee_api_catalog\Entity\ApiDoc $entity */
    $entity = $this->entityTypeManager
      ->getStorage('apidoc')
      ->create();
    $form['apigee_api_catalog_settings']['#markup'] = $this
      ->t('Settings for Apigee API catalog. Manage field settings using the tabs above.');
    $form['additional_settings'] = [
      '#type' => 'vertical_tabs',
    ];
    $form['workflow'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Publishing options'),
      '#group' => 'additional_settings',
    ];
    $workflow_options = [
      'new_revision' => $entity
        ->shouldCreateNewRevision(),
    ];

    // Prepare workflow options to be used for 'checkboxes' form element.
    $workflow_options_keys = array_keys(array_filter($workflow_options));
    $workflow_options = array_combine($workflow_options_keys, $workflow_options_keys);
    $form['workflow']['options'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Default options'),
      '#default_value' => $workflow_options,
      '#options' => [
        'new_revision' => $this
          ->t('Create new revision'),
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ApiDocSettingsForm::$entityTypeManager protected property The entity type manager.
ApiDocSettingsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ApiDocSettingsForm::CONFIG_NAME public constant
ApiDocSettingsForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ApiDocSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ApiDocSettingsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ApiDocSettingsForm::__construct public function
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.
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.