abstract class SlickFormBase in Slick Carousel 8.2
Same name and namespace in other branches
- 8 slick_ui/src/Form/SlickFormBase.php \Drupal\slick_ui\Form\SlickFormBase
- 7.3 slick_ui/src/Form/SlickFormBase.php \Drupal\slick_ui\Form\SlickFormBase
Provides base form for a slick instance configuration 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\slick_ui\Form\SlickFormBase
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of SlickFormBase
File
- slick_ui/
src/ Form/ SlickFormBase.php, line 12
Namespace
Drupal\slick_ui\FormView source
abstract class SlickFormBase extends EntityForm {
/**
* Defines the nice anme.
*
* @var string
*/
protected static $niceName = 'Slick';
/**
* Defines machine name.
*
* @var string
*/
protected static $machineName = 'slick';
/**
* The slick admin service.
*
* @var \Drupal\slick\Form\SlickAdminInterface
*/
protected $admin;
/**
* The slick manager service.
*
* @var \Drupal\slick\SlickManagerInterface
*/
protected $manager;
/**
* The form elements.
*
* @var array
*/
protected $formElements;
/**
* The JS easing options.
*
* @var array
*/
protected $jsEasingOptions;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
$instance = parent::create($container);
$instance->admin = $container
->get('slick.admin');
$instance->manager = $container
->get('slick.manager');
return $instance;
}
/**
* Returns the slick admin service.
*/
public function admin() {
return $this->admin;
}
/**
* Returns the slick manager service.
*/
public function manager() {
return $this->manager;
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$admin_css = $this->manager
->configLoad('admin_css', 'blazy.settings');
$form['#attributes']['class'][] = 'form--blazy form--slick form--optionset has-tooltip';
// Change page title for the duplicate operation.
if ($this->operation == 'duplicate') {
$form['#title'] = $this
->t('<em>Duplicate %name optionset</em>: @label', [
'%name' => static::$niceName,
'@label' => $this->entity
->label(),
]);
$this->entity = $this->entity
->createDuplicate();
}
// Change page title for the edit operation.
if ($this->operation == 'edit') {
$form['#title'] = $this
->t('<em>Edit %name optionset</em>: @label', [
'%name' => static::$niceName,
'@label' => $this->entity
->label(),
]);
}
// Attach Slick admin library.
if ($admin_css) {
$form['#attached']['library'][] = 'slick_ui/slick.admin.vtabs';
}
return parent::form($form, $form_state);
}
/**
* Overrides Drupal\Core\Entity\EntityFormController::save().
*
* @todo revert #1497268, or use config_update instead.
*/
public function save(array $form, FormStateInterface $form_state) {
$optionset = $this->entity;
// Prevent leading and trailing spaces in slick names.
$optionset
->set('label', trim($optionset
->label()));
$optionset
->set('id', $optionset
->id());
$status = $optionset
->save();
$label = $optionset
->label();
$edit_link = $optionset
->toLink($this
->t('Edit'), 'edit-form')
->toString();
$config_prefix = $optionset
->getEntityType()
->getConfigPrefix();
$message = [
'@config_prefix' => $config_prefix,
'%label' => $label,
];
$notice = [
'@config_prefix' => $config_prefix,
'%label' => $label,
'link' => $edit_link,
];
if ($status == SAVED_UPDATED) {
// If we edited an existing entity.
// @todo #2278383.
$this
->messenger()
->addMessage($this
->t('@config_prefix %label has been updated.', $message));
$this
->logger(static::$machineName)
->notice('@config_prefix %label has been updated.', $notice);
}
else {
// If we created a new entity.
$this
->messenger()
->addMessage($this
->t('@config_prefix %label has been added.', $message));
$this
->logger(static::$machineName)
->notice('@config_prefix %label has been added.', $notice);
}
$form_state
->setRedirectUrl($this->entity
->toUrl('collection'));
}
/**
* List of all easing methods available from jQuery Easing v1.3.
*
* @return array
* An array of available jQuery Easing options as fallback for browsers that
* don't support pure CSS easing.
*/
public function getJsEasingOptions() {
if (!isset($this->jsEasingOptions)) {
$this->jsEasingOptions = [
'linear' => 'Linear',
'swing' => 'Swing',
'easeInQuad' => 'easeInQuad',
'easeOutQuad' => 'easeOutQuad',
'easeInOutQuad' => 'easeInOutQuad',
'easeInCubic' => 'easeInCubic',
'easeOutCubic' => 'easeOutCubic',
'easeInOutCubic' => 'easeInOutCubic',
'easeInQuart' => 'easeInQuart',
'easeOutQuart' => 'easeOutQuart',
'easeInOutQuart' => 'easeInOutQuart',
'easeInQuint' => 'easeInQuint',
'easeOutQuint' => 'easeOutQuint',
'easeInOutQuint' => 'easeInOutQuint',
'easeInSine' => 'easeInSine',
'easeOutSine' => 'easeOutSine',
'easeInOutSine' => 'easeInOutSine',
'easeInExpo' => 'easeInExpo',
'easeOutExpo' => 'easeOutExpo',
'easeInOutExpo' => 'easeInOutExpo',
'easeInCirc' => 'easeInCirc',
'easeOutCirc' => 'easeOutCirc',
'easeInOutCirc' => 'easeInOutCirc',
'easeInElastic' => 'easeInElastic',
'easeOutElastic' => 'easeOutElastic',
'easeInOutElastic' => 'easeInOutElastic',
'easeInBack' => 'easeInBack',
'easeOutBack' => 'easeOutBack',
'easeInOutBack' => 'easeInOutBack',
'easeInBounce' => 'easeInBounce',
'easeOutBounce' => 'easeOutBounce',
'easeInOutBounce' => 'easeInOutBounce',
];
}
return $this->jsEasingOptions;
}
/**
* List of available CSS easing methods.
*
* @param bool $map
* Flag to output the array as is for further processing if TRUE.
*
* @return array
* An array of CSS easings for select options, or all for the mappings.
*
* @see https://github.com/kenwheeler/slick/issues/118
* @see http://matthewlein.com/ceaser/
* @see http://www.w3.org/TR/css3-transitions/
*/
public function getCssEasingOptions($map = FALSE) {
$css_easings = [];
$available_easings = [
// Defaults/ Native.
'ease' => 'ease|ease',
'linear' => 'linear|linear',
'ease-in' => 'ease-in|ease-in',
'ease-out' => 'ease-out|ease-out',
'swing' => 'swing|ease-in-out',
// Penner Equations (approximated).
'easeInQuad' => 'easeInQuad|cubic-bezier(0.550, 0.085, 0.680, 0.530)',
'easeInCubic' => 'easeInCubic|cubic-bezier(0.550, 0.055, 0.675, 0.190)',
'easeInQuart' => 'easeInQuart|cubic-bezier(0.895, 0.030, 0.685, 0.220)',
'easeInQuint' => 'easeInQuint|cubic-bezier(0.755, 0.050, 0.855, 0.060)',
'easeInSine' => 'easeInSine|cubic-bezier(0.470, 0.000, 0.745, 0.715)',
'easeInExpo' => 'easeInExpo|cubic-bezier(0.950, 0.050, 0.795, 0.035)',
'easeInCirc' => 'easeInCirc|cubic-bezier(0.600, 0.040, 0.980, 0.335)',
'easeInBack' => 'easeInBack|cubic-bezier(0.600, -0.280, 0.735, 0.045)',
'easeOutQuad' => 'easeOutQuad|cubic-bezier(0.250, 0.460, 0.450, 0.940)',
'easeOutCubic' => 'easeOutCubic|cubic-bezier(0.215, 0.610, 0.355, 1.000)',
'easeOutQuart' => 'easeOutQuart|cubic-bezier(0.165, 0.840, 0.440, 1.000)',
'easeOutQuint' => 'easeOutQuint|cubic-bezier(0.230, 1.000, 0.320, 1.000)',
'easeOutSine' => 'easeOutSine|cubic-bezier(0.390, 0.575, 0.565, 1.000)',
'easeOutExpo' => 'easeOutExpo|cubic-bezier(0.190, 1.000, 0.220, 1.000)',
'easeOutCirc' => 'easeOutCirc|cubic-bezier(0.075, 0.820, 0.165, 1.000)',
'easeOutBack' => 'easeOutBack|cubic-bezier(0.175, 0.885, 0.320, 1.275)',
'easeInOutQuad' => 'easeInOutQuad|cubic-bezier(0.455, 0.030, 0.515, 0.955)',
'easeInOutCubic' => 'easeInOutCubic|cubic-bezier(0.645, 0.045, 0.355, 1.000)',
'easeInOutQuart' => 'easeInOutQuart|cubic-bezier(0.770, 0.000, 0.175, 1.000)',
'easeInOutQuint' => 'easeInOutQuint|cubic-bezier(0.860, 0.000, 0.070, 1.000)',
'easeInOutSine' => 'easeInOutSine|cubic-bezier(0.445, 0.050, 0.550, 0.950)',
'easeInOutExpo' => 'easeInOutExpo|cubic-bezier(1.000, 0.000, 0.000, 1.000)',
'easeInOutCirc' => 'easeInOutCirc|cubic-bezier(0.785, 0.135, 0.150, 0.860)',
'easeInOutBack' => 'easeInOutBack|cubic-bezier(0.680, -0.550, 0.265, 1.550)',
];
foreach ($available_easings as $key => $easing) {
list($readable_easing, $css_easing) = array_pad(array_map('trim', explode("|", $easing, 2)), 2, NULL);
$css_easings[$key] = $map ? $easing : $readable_easing;
unset($css_easing);
}
return $css_easings;
}
/**
* Maps existing jQuery easing value to equivalent CSS easing methods.
*
* @param string $easing
* The name of the human readable easing.
*
* @return string
* A string of unfriendly bezier equivalent, or NULL.
*/
public function getBezier($easing = NULL) {
$css_easing = '';
if ($easing) {
$easings = $this
->getCssEasingOptions(TRUE);
list($readable_easing, $bezier) = array_pad(array_map('trim', explode("|", $easings[$easing], 2)), 2, NULL);
$css_easing = $bezier;
unset($readable_easing);
}
return $css_easing;
}
}
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 an array of supported actions for the current entity form. | 29 |
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 |
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 |
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 | ||
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:: |
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. | |
SlickFormBase:: |
protected | property | The slick admin service. | |
SlickFormBase:: |
protected | property | The form elements. | |
SlickFormBase:: |
protected | property | The JS easing options. | |
SlickFormBase:: |
protected static | property | Defines machine name. | |
SlickFormBase:: |
protected | property | The slick manager service. | |
SlickFormBase:: |
protected static | property | Defines the nice anme. | |
SlickFormBase:: |
public | function | Returns the slick admin service. | |
SlickFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
SlickFormBase:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
1 |
SlickFormBase:: |
public | function | Maps existing jQuery easing value to equivalent CSS easing methods. | |
SlickFormBase:: |
public | function | List of available CSS easing methods. | |
SlickFormBase:: |
public | function | List of all easing methods available from jQuery Easing v1.3. | |
SlickFormBase:: |
public | function | Returns the slick manager service. | |
SlickFormBase:: |
public | function |
Overrides Drupal\Core\Entity\EntityFormController::save(). Overrides EntityForm:: |
|
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. |