SystemBrandingOffCanvasForm
class SystemBrandingOffCanvasForm extends PluginFormBase implements ContainerInjectionInterface (View source)
| internal |
The settings_tray form handler for the SystemBrandingBlock.
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Properties
| protected BlockPluginInterface | $plugin | The block plugin. |
|
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected ConfigFactoryInterface | $configFactory | The config factory. |
|
| protected AccountInterface | $currentUser | The current user. |
Methods
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
SystemBrandingOffCanvasForm constructor.
Instantiates a new instance of this class.
Details
setPlugin(PluginInspectionInterface $plugin)
Sets the plugin for this object.
validateConfigurationForm(array $form, FormStateInterface $form_state)
Form validation handler.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__construct(ConfigFactoryInterface $config_factory, AccountInterface $current_user)
SystemBrandingOffCanvasForm constructor.
static
create(ContainerInterface $container)
Instantiates a new instance of this class.
This is a factory method that returns a new instance of this class. The factory should pass any needed dependencies into the constructor of this class, but not the container itself. Every call to this method must return a new instance of this class; that is, it may not implement a singleton.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
submitConfigurationForm(array $form, FormStateInterface $form_state)
Form submission handler.