class FilterBaseForm in Entity Share 8
Same name and namespace in other branches
- 8.3 modules/entity_share_server/src/Form/FilterBaseForm.php \Drupal\entity_share_server\Form\FilterBaseForm
- 8.2 modules/entity_share_server/src/Form/FilterBaseForm.php \Drupal\entity_share_server\Form\FilterBaseForm
Class FilterBaseForm.
@package Drupal\entity_share_server\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\entity_share_server\Form\FilterBaseForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of FilterBaseForm
File
- modules/
entity_share_server/ src/ Form/ FilterBaseForm.php, line 13
Namespace
Drupal\entity_share_server\FormView source
class FilterBaseForm extends EntityForm {
/**
* {@inheritdoc}
*/
protected function actions(array $form, FormStateInterface $form_state) {
$actions = parent::actions($form, $form_state);
unset($actions['delete']);
return $actions;
}
/**
* Helper function to get the conjunction options.
*
* @return array
* An array of options.
*/
protected function getGroupOptions() {
/** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
$channel = $this->entity;
$channel_groups = $channel
->get('channel_groups');
if (is_null($channel_groups)) {
$channel_groups = [];
}
$member_options = array_keys($channel_groups);
return array_combine($member_options, $member_options);
}
/**
* Ajax callback.
*
* @param array $form
* The form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*
* @return array
* Subform.
*/
public static function buildAjaxValueElement(array $form, FormStateInterface $form_state) {
// We just need to return the relevant part of the form here.
return $form['value_wrapper'];
}
/**
* Ajax callback for both ajax-enabled buttons.
*
* Selects and returns the fieldset with the names in it.
*
* @param array $form
* The form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*
* @return array
* Subform.
*/
public function addRemoveCallback(array &$form, FormStateInterface $form_state) {
return $form['value_wrapper'];
}
/**
* Submit handler for the "add a value" button.
*
* Increments the max counter and causes a rebuild.
*
* @param array $form
* The form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*/
public function addOneValue(array &$form, FormStateInterface $form_state) {
$number_of_values = $form_state
->get('number_of_values');
$number_of_values++;
$form_state
->set('number_of_values', $number_of_values);
$form_state
->setRebuild();
}
/**
* Submit handler for the "remove a value" button.
*
* Decrements the max counter and causes a form rebuild.
*
* @param array $form
* The form array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state object.
*/
public function removeOneValue(array &$form, FormStateInterface $form_state) {
$number_of_values = $form_state
->get('number_of_values');
if ($number_of_values > 1) {
$number_of_values--;
$form_state
->set('number_of_values', $number_of_values);
}
$form_state
->setRebuild();
}
/**
* Check to see if a filter already exists with the specified name.
*
* @param string $name
* The machine name to check for.
*
* @return bool
* True if it already exists.
*/
public function filterExists($name) {
/** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
$channel = $this->entity;
$channel_filters = $channel
->get('channel_filters');
if (is_null($channel_filters)) {
return FALSE;
}
if (isset($channel_filters[$name])) {
return TRUE;
}
else {
return FALSE;
}
}
/**
* Retrieves the filter that is being edited.
*
* @return string
* The filter id.
*/
protected function getFilterId() {
if (!isset($this->filterId)) {
$this->filterId = $this
->getRequest()->attributes
->get('filter');
}
return $this->filterId;
}
/**
* Check if the filter exists.
*
* @return bool
* True if the filter exists. FALSE otherwise.
*/
protected function filterIdExists() {
/** @var \Drupal\entity_share_server\Entity\ChannelInterface $channel */
$channel = $this->entity;
$channel_filters = $channel
->get('channel_filters');
$filter_id = $this
->getFilterId();
$filter_exists = FALSE;
if (isset($channel_filters[$filter_id])) {
$filter_exists = TRUE;
}
return $filter_exists;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity being used by this form. | 7 |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
2 |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function | Gets the actual form array to be built. | 30 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityFormInterface:: |
41 |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides FormInterface:: |
17 |
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FilterBaseForm:: |
protected | function |
Returns an array of supported actions for the current entity form. Overrides EntityForm:: |
2 |
FilterBaseForm:: |
public | function | Submit handler for the "add a value" button. | |
FilterBaseForm:: |
public | function | Ajax callback for both ajax-enabled buttons. | |
FilterBaseForm:: |
public static | function | Ajax callback. | |
FilterBaseForm:: |
public | function | Check to see if a filter already exists with the specified name. | |
FilterBaseForm:: |
protected | function | Check if the filter exists. | |
FilterBaseForm:: |
protected | function | Retrieves the filter that is being edited. | |
FilterBaseForm:: |
protected | function | Helper function to get the conjunction options. | |
FilterBaseForm:: |
public | function | Submit handler for the "remove a value" button. | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |