You are here

Home » API reference » Entity Clone 8 » EntityCloneSettingsForm.php

class EntityCloneSettingsForm in Entity Clone 8

Provide the settings form for entity clone.

Hierarchy

Expanded class hierarchy of EntityCloneSettingsForm

1 string reference to 'EntityCloneSettingsForm'
entity_clone.routing.yml in ./entity_clone.routing.yml
entity_clone.routing.yml

File

src/Form/EntityCloneSettingsForm.php, line 15

Namespace

Drupal\entity_clone\Form
View source 
class EntityCloneSettingsForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * The entity clone settings manager.
   *
   * @var \Drupal\entity_clone\EntityCloneSettingsManager
   */
  protected $entityCloneSettingsManager;

  /**
   * {@inheritdoc}
   *
   * @var \Drupal\entity_clone\EntityCloneSettingsManager $entity_clone_settings_manager
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityCloneSettingsManager $entity_clone_settings_manager) {
    parent::__construct($config_factory);
    $this->entityCloneSettingsManager = $entity_clone_settings_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return [
      'entity_clone.settings',
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#tree'] = TRUE;
    $form['form_settings'] = [
      '#tree' => TRUE,
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Clone form settings'),
      '#description' => $this
        ->t("\n        For each type of child entity (the entity that's referenced by the entity being\n        cloned), please set your cloning preferences. This will affect the clone form presented to users when they\n        clone entities. Default behaviour for whether or not the child entities should be cloned is specified in\n        the left-most column.  To prevent users from altering behaviour for each type when they're actually cloning\n        (but still allowing them to see what will happen), use the middle column. The right-most column can be used\n        to hide the form options from users completely. This will run the clone operation with the defaults set here\n        (in the left-most column). See the clone form (by cloning an entity) for more information.\n      "),
      '#open' => TRUE,
      '#collapsible' => FALSE,
    ];
    $form['form_settings']['table'] = [
      '#type' => 'table',
      '#header' => [
        'label' => $this
          ->t('Label'),
        'default_value' => $this
          ->t('Checkboxes default value'),
        'disable' => $this
          ->t('Disable checkboxes'),
        'hidden' => $this
          ->t('Hide checkboxes'),
      ],
    ];
    foreach ($this->entityCloneSettingsManager
      ->getContentEntityTypes() as $type_id => $type) {
      $form['form_settings']['table'][$type_id] = [
        'label' => [
          '#type' => 'label',
          '#title' => $this
            ->t('@type', [
            '@type' => $type
              ->getLabel(),
          ]),
        ],
        'default_value' => [
          '#type' => 'checkbox',
          '#default_value' => $this->entityCloneSettingsManager
            ->getDefaultValue($type_id),
        ],
        'disable' => [
          '#type' => 'checkbox',
          '#default_value' => $this->entityCloneSettingsManager
            ->getDisableValue($type_id),
        ],
        'hidden' => [
          '#type' => 'checkbox',
          '#default_value' => $this->entityCloneSettingsManager
            ->getHiddenValue($type_id),
        ],
      ];
    }
    $form['take_ownership'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Take ownership'),
      '#description' => $this
        ->t('Whether the "Take ownership" option should be checked by default on the entity clone form.'),
      '#default_value' => $this->entityCloneSettingsManager
        ->getTakeOwnershipSetting(),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->entityCloneSettingsManager
      ->setFormSettings($form_state
      ->getValue('form_settings'));
    $this->entityCloneSettingsManager
      ->setTakeOwnershipSettings($form_state
      ->getValue('take_ownership'));
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
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
EntityCloneSettingsForm::$entityCloneSettingsManager protected property The entity clone settings manager.
EntityCloneSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
EntityCloneSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
EntityCloneSettingsForm::getEditableConfigNames public function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
EntityCloneSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EntityCloneSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
EntityCloneSettingsForm::__construct public function Overrides ConfigFormBase::__construct
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
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.