class PublishContentSettings in Publish Content 8

Class PublishContentSettings.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\publishcontent\Form\PublishContentSettings

Expanded class hierarchy of PublishContentSettings

2 string references to 'PublishContentSettings'

publishcontent.routing.yml in ./publishcontent.routing.yml: publishcontent.routing.yml
publishcontent.routing.yml in ./publishcontent.routing.yml: publishcontent.routing.yml

File

src/Form/PublishContentSettings.php, line 14

Namespace

Drupal\publishcontent\Form

View source

class PublishContentSettings extends ConfigFormBase {

  /**
   * Cache invalidator service.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidator
   */
  protected $cacheInvalidator;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheTagsInvalidator $cache_invalidator) {
    parent::__construct($config_factory);
    $this->cacheInvalidator = $cache_invalidator;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('publishcontent.settings');
    $form['ui'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('User interface preferences'),
      '#description' => $this
        ->t('Configure how users interact with the publish and unpublish toggle.'),
    ];
    $form['ui_localtask'] = [
      '#type' => 'checkbox',
      '#group' => 'ui',
      '#title' => $this
        ->t('Publish and unpublish via local task'),
      '#default_value' => $config
        ->get('ui_localtask'),
      '#description' => $this
        ->t('A Publish/Unpublish link will appear alongside the node’s View and Edit links for users who have appropriate permissions.'),
    ];
    $form['ui_checkbox'] = [
      '#type' => 'checkbox',
      '#group' => 'ui',
      '#title' => $this
        ->t('Publish and unpublish via checkbox'),
      '#default_value' => $config
        ->get('ui_checkbox'),
      '#description' => $this
        ->t('A checkbox will appear near the bottom of node edit forms for users who have permission to publish/unpublish. Users who do not have permission will see the checkbox but will not be able to change its value.'),
    ];
    $form['accountability'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this
        ->t('Accountability preferences'),
      '#description' => $this
        ->t('Configure what kind of trace the publish and unpublish toggle will leave in the system.'),
    ];
    $form['create_revision'] = [
      '#type' => 'checkbox',
      '#group' => 'accountability',
      '#title' => $this
        ->t('Create new revision when publising/unpublishing a node'),
      '#default_value' => $config
        ->get('create_revision'),
      '#description' => $this
        ->t('Unpublishing or publishing a node will create a new revision automatically.'),
    ];
    $form['create_log_entry'] = [
      '#type' => 'checkbox',
      '#group' => 'accountability',
      '#title' => $this
        ->t('Create a log entry when publishing or unpublishing a node'),
      '#default_value' => $config
        ->get('create_log_entry'),
      '#description' => $this
        ->t('Make Drupal log all publishing and unpublishing actions, to be able to see when and by whom the action was executed.'),
    ];
    $form['publish_text_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Publish button value'),
      '#default_value' => $config
        ->get('publish_text_value'),
      '#description' => $this
        ->t('Set the text value for publishing content types. Default is set to Publish'),
      '#required' => TRUE,
    ];
    $form['unpublish_text_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Un-publish button value'),
      '#default_value' => $config
        ->get('unpublish_text_value'),
      '#description' => $this
        ->t('Set the text value for un-publishing content types. Default is set to Unpublish'),
      '#required' => TRUE,
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('publishcontent.settings');
    $config
      ->set('ui_localtask', $form_state
      ->getValue('ui_localtask'));
    $config
      ->set('ui_checkbox', $form_state
      ->getValue('ui_checkbox'));
    $config
      ->set('create_revision', $form_state
      ->getValue('create_revision'));
    $config
      ->set('create_log_entry', $form_state
      ->getValue('create_log_entry'));
    $config
      ->set('publish_text_value', $form_state
      ->getValue('publish_text_value'));
    $config
      ->set('unpublish_text_value', $form_state
      ->getValue('unpublish_text_value'));
    $config
      ->save();
    $this->cacheInvalidator
      ->invalidateTags([
      'local_task',
    ]);
    return parent::submitForm($form, $form_state);
  }

}

Members

Name	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
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.
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.
PublishContentSettings::$cacheInvalidator	protected	property	Cache invalidator service.
PublishContentSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
PublishContentSettings::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
PublishContentSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PublishContentSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PublishContentSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
PublishContentSettings::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
PublishContentSettings::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.

You are here

class PublishContentSettings in Publish Content 8

Hierarchy

File

Namespace

Members

API Navigation