splide-1.0.x-dev/src/Form/SplideAdmin.php
src/Form/SplideAdmin.php
<?php
namespace Drupal\splide\Form;
use Drupal\Component\Utility\Html;
use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Render\Element;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\Url;
use Drupal\blazy\Form\BlazyAdminInterface;
use Drupal\splide\SplideDefault;
use Drupal\splide\SplideManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Provides resusable admin functions, or form elements.
*/
class SplideAdmin implements SplideAdminInterface {
use StringTranslationTrait;
/**
* The entity field manager service.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The blazy admin service.
*
* @var \Drupal\blazy\Form\BlazyAdminInterface
*/
protected $blazyAdmin;
/**
* The splide manager service.
*
* @var \Drupal\splide\SplideManagerInterface
*/
protected $manager;
/**
* Constructs a SplideAdmin object.
*
* @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
* The entity_field.manager service.
* @param \Drupal\blazy\Form\BlazyAdminInterface $blazy_admin
* The blazy admin service.
* @param \Drupal\splide\SplideManagerInterface $manager
* The splide manager service.
*/
public function __construct(
EntityFieldManagerInterface $entity_field_manager,
BlazyAdminInterface $blazy_admin,
SplideManagerInterface $manager,
) {
$this->entityFieldManager = $entity_field_manager;
$this->blazyAdmin = $blazy_admin;
$this->manager = $manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static(
$container->get('entity_field.manager'),
$container->get('blazy.admin.formatter'),
$container->get('splide.manager')
);
}
/**
* Returns the blazy admin formatter.
*/
public function blazyAdmin() {
return $this->blazyAdmin;
}
/**
* Returns the splide manager.
*/
public function manager() {
return $this->manager;
}
/**
* Modifies the main form elements.
*/
public function buildSettingsForm(array &$form, array $definition): void {
$definition['caches'] = $definition['caches'] ?? TRUE;
$definition['namespace'] = 'splide';
$definition['optionsets'] = $definition['optionsets'] ?? $this->getOptionsetsByGroupOptions('main');
$definition['skins'] = $definition['skins'] ?? $this->getSkinsByGroupOptions('main');
$definition['responsive_image'] = $definition['responsive_image'] ?? TRUE;
$definition['grid_required'] = FALSE;
$definition['no_grid_header'] = FALSE;
$definition['slider'] = TRUE;
$definition['grid_header_desc'] = $this->gridHeaderDescription();
foreach (['optionsets', 'skins'] as $key) {
if (isset($definition[$key]['default'])) {
ksort($definition[$key]);
$definition[$key] = ['default' => $definition[$key]['default']] + $definition[$key];
}
}
// @todo remove post blazy:2.17.
if (!empty($definition['thumb_captions'])) {
if ($definition['thumb_captions'] == 'default') {
$definition['thumb_captions'] = [
'alt' => $this->t('Alt'),
'title' => $this->t('Title'),
];
}
}
if (empty($definition['no_layouts'])) {
$definition['layouts'] = isset($definition['layouts']) ? array_merge($this->getLayoutOptions(), $definition['layouts']) : $this->getLayoutOptions();
}
$this->openingForm($form, $definition);
if (!empty($definition['image_style_form']) && !isset($form['image_style'])) {
$this->imageStyleForm($form, $definition);
}
if (!empty($definition['media_switch_form']) && !isset($form['media_switch'])) {
$this->mediaSwitchForm($form, $definition);
}
if (!empty($definition['grid_form']) && !isset($form['grid'])) {
$this->gridForm($form, $definition);
}
if (!empty($definition['fieldable_form']) && !isset($form['image'])) {
$this->fieldableForm($form, $definition);
}
if (!empty($definition['style']) && isset($form['style']['#description'])) {
$form['style']['#description'] .= ' ' . $this->t('CSS3 Columns is best with autoHeight, non-vertical. Will use regular carousel as default style if left empty. Yet, both CSS3 Columns and Grid Foundation are respected as Grid displays when <strong>Grid large</strong> option is provided.');
}
$this->closingForm($form, $definition);
}
/**
* Modifies the opening form elements.
*/
public function openingForm(array &$form, array &$definition): void {
$path = $this->manager->getPath('module', 'splide');
$is_splide_ui = $this->manager->moduleExists('splide_ui');
$is_help = $this->manager->moduleExists('help');
$route_name = ['name' => 'splide_ui'];
$readme = $is_splide_ui && $is_help ? Url::fromRoute('help.page', $route_name)->toString() : Url::fromUri('base:' . $path . '/docs/README.md')->toString();
$readme_field = $is_splide_ui && $is_help ? Url::fromRoute('help.page', $route_name)->toString() : Url::fromUri('base:' . $path . '/docs/FORMATTER.md')->toString();
$arrows = $this->getSkinsByGroupOptions('arrows');
$dots = $this->getSkinsByGroupOptions('dots');
$effects = $definition['_thumbnail_effect'] ?? [];
$defaults = [
'hover' => $this->t('Hoverable'),
'grid' => $this->t('Static grid'),
];
$definition['thumbnail_effect'] = array_merge($defaults, $effects);
$this->blazyAdmin->openingForm($form, $definition);
// @todo $scopes = $definition['scopes'];
if (isset($form['optionset'])) {
$form['optionset']['#title'] = $this->t('Optionset main');
if ($is_splide_ui) {
$route_name = 'entity.splide.collection';
$form['optionset']['#description'] = $this->t('Manage optionsets at <a href=":url" target="_blank">the optionset admin page</a>.', [':url' => Url::fromRoute($route_name)->toString()]);
}
}
if (!empty($definition['nav']) || !empty($definition['thumbnails'])) {
$form['optionset_nav'] = [
'#type' => 'select',
'#title' => $this->t('Optionset nav'),
'#options' => $this->getOptionsetsByGroupOptions('nav'),
'#description' => $this->t('If provided, asNavFor aka thumbnail navigation applies. Leave empty to not use thumbnail navigation.'),
'#weight' => -108,
'#enforced' => TRUE,
];
$form['skin_nav'] = [
'#type' => 'select',
'#title' => $this->t('Skin navigation'),
'#options' => $this->getSkinsByGroupOptions('nav'),
'#description' => $this->t('Thumbnail navigation skin. See main <a href="@url" target="_blank">README</a> for details on Skins. Leave empty to not use thumbnail navigation.', ['@url' => $readme]),
'#weight' => -106,
'#enforced' => TRUE,
];
}
if (count($arrows) > 0 && empty($definition['no_arrows'])) {
$form['skin_arrows'] = [
'#type' => 'select',
'#title' => $this->t('Skin arrows'),
'#options' => $arrows,
'#enforced' => TRUE,
'#description' => $this->t('Check out splide.api.php to add your own skins.'),
'#weight' => -105,
];
}
if (count($dots) > 0 && empty($definition['no_dots'])) {
$form['skin_dots'] = [
'#type' => 'select',
'#title' => $this->t('Skin dots'),
'#options' => $dots,
'#enforced' => TRUE,
'#description' => $this->t('Check out splide.api.php to add your own skins.'),
'#weight' => -105,
];
}
if (!empty($definition['nav_positions']) || !empty($definition['thumb_positions'])) {
$form['navpos'] = [
'#type' => 'select',
'#title' => $this->t('Navigation position'),
'#options' => [
'left' => $this->t('Left'),
'right' => $this->t('Right'),
'top' => $this->t('Top'),
'over-left' => $this->t('Overlay left'),
'over-right' => $this->t('Overlay right'),
'over-top' => $this->t('Overlay top'),
],
'#description' => $this->t('By default thumbnail is positioned at bottom. Hence to change the position of thumbnail. Only reasonable with 1 visible main stage at a time. Except any TOP, the rest requires <code>Direction: ttb</code> for Optionset nav, and a custom CSS height to selector <strong>.splide--nav</strong> to avoid overflowing tall thumbnails, or adjust <strong>perPage</strong> to fit the height. Further theming is required as usual. Overlay is absolutely positioned over the stage rather than sharing the space. See skin <strong>X VTabs</strong> for vertical thumbnail sample.'),
'#states' => [
'visible' => [
'select[name*="[optionset_nav]"]' => ['!value' => ''],
],
],
'#weight' => -99,
'#enforced' => TRUE,
];
}
if ($captions = $definition['thumb_captions'] ?? []) {
$captions += ['title' => $this->t('Image Title')];
$form['nav_caption'] = [
'#type' => 'select',
'#title' => $this->t('Thumbnail caption'),
'#options' => $captions,
'#description' => $this->t('Thumbnail caption maybe just title/ plain text. If Thumbnail image style is not provided, the thumbnail pagers will be just text like regular tabs.'),
'#states' => [
'visible' => [
'select[name*="[optionset_nav]"]' => ['!value' => ''],
],
],
'#weight' => 2,
'#enforced' => TRUE,
];
}
if (isset($form['skin'])) {
$form['skin']['#title'] = $this->t('Skin main');
$form['skin']['#description'] = $this->t('Skins allow various layouts with just CSS. Some options below depend on a skin. However a combination of skins and options may lead to unpredictable layouts, get yourself dirty. E.g.: Skin Split requires any split layout option. Failing to choose the expected layout makes it useless. See <a href=":url" target="_blank">SKINS section at README</a> for details on Skins. Leave empty to DIY. Skins are permanently cached. Clear cache if new skins do not appear. Check out splide.api.php to add your own skins.', [':url' => $readme]);
}
if (isset($form['layout'])) {
$form['layout']['#description'] = $this->t('Requires a skin. The builtin layouts affects the entire slides uniformly. Split half requires any skin Split. See <a href="@url" target="_blank">README</a> under "Slide layout" for more info. Leave empty to DIY.', ['@url' => $readme_field]);
}
$weight = -99;
foreach (Element::children($form) as $key) {
if (!isset($form[$key]['#weight'])) {
$form[$key]['#weight'] = ++$weight;
}
}
}
/**
* Modifies the image formatter form elements.
*/
public function mediaSwitchForm(array &$form, array $definition): void {
$this->blazyAdmin->mediaSwitchForm($form, $definition);
}
/**
* Modifies the image formatter form elements.
*/
public function imageStyleForm(array &$form, array $definition): void {
$definition['thumbnail_style'] = $definition['thumbnail_style'] ?? TRUE;
$definition['ratios'] = $definition['ratios'] ?? TRUE;
if (!isset($form['image_style'])) {
$this->blazyAdmin->imageStyleForm($form, $definition);
}
if (isset($form['thumbnail_style'])) {
$form['thumbnail_style']['#description'] .= '<br><br>' . $this->t('Extra usages: <ol><li>If <em>Optionset thumbnail</em> provided, it is for asNavFor thumbnail navigation.</li><li>For <em>Thumbnail effect</em>.</li><li>Splidebox/ PhotoSwipe zoom in/out thumbnail animation, best with the same aspect ratio.</li><li>Arrows with thumbnails, etc.</li></ol>. <br>If Vanilla enabled and Optionset nav is provided, this will be used as thumbnail style for the Main stage.');
$form['thumbnail_style']['#enforced'] = TRUE;
}
if (isset($form['background'])) {
$form['background']['#description'] .= ' ' . $this->t('Works best with a single visible slide, skins full width/screen.');
}
}
/**
* Modifies re-usable fieldable formatter form elements.
*/
public function fieldableForm(array &$form, array $definition): void {
$this->blazyAdmin->fieldableForm($form, $definition);
if (isset($form['image'])) {
$form['image']['#enforced'] = TRUE;
$description = $form['image']['#description'] ?? '';
$form['image']['#description'] = $this->t('If Vanilla enabled and Optionset nav is provided, this will be used for thumbnail instead. The actual Main stage will be the rendered entity, not this image.<br>') . $description;
}
if (isset($form['thumbnail'])) {
$form['thumbnail']['#enforced'] = TRUE;
$form['thumbnail']['#description'] = $this->t("Needed if any are required/ provided: <ol><li><em>Optionset thumbnail</em>.</li><li><em>Dots thumbnail effect</em>.</li></ol> Maybe the same field as the main image, only different instance and image style. Company logos for thumbnails vs. company offices for the Main stage, author avatars for thumbnails vs. Slideshow for overlays with its Main stage, etc. Leave empty to not use thumbnail pager, or for tabs-like/ text only navigation.");
}
if (isset($form['overlay'])) {
$form['overlay']['#title'] = $this->t('Overlay media/splides');
$form['overlay']['#description'] = $this->t('For audio/video, be sure the display is not image. For nested splides, use the Splide slider formatter for this field. Zebra layout is reasonable for overlay and captions.');
}
}
/**
* Modifies re-usable grid elements across Splide field formatter and Views.
*/
public function gridForm(array &$form, array $definition): void {
if (!isset($form['grid'])) {
$this->blazyAdmin->gridForm($form, $definition);
}
$form['grid']['#description'] = $this->t('The amount of block grid columns for large monitors 64.063em - 90em. <br /><strong>Requires</strong>:<ol><li>Visible items,</li><li>Skin Grid for starter,</li><li>A reasonable amount of contents,</li><li>Optionset with perPage and perMove = 1.</li></ol>This is module feature offering more flexibility. Leave empty to DIY, or to not build grids.');
}
/**
* Modifies the closing ending form elements.
*/
public function closingForm(array &$form, array $definition): void {
if (empty($definition['_views']) && !empty($definition['field_name'])) {
$form['use_theme_field'] = [
'#title' => $this->t('Use field template'),
'#type' => 'checkbox',
'#description' => $this->t('Wrap Splide field output into regular field markup (field.html.twig). Vanilla output otherwise.'),
'#weight' => -106,
'#enforced' => TRUE,
];
}
$form['override'] = [
'#title' => $this->t('Override main optionset'),
'#type' => 'checkbox',
'#description' => $this->t('If checked, the following options will override the main optionset. Useful to re-use one optionset for several different displays.'),
'#weight' => 112,
'#enforced' => TRUE,
];
$form['overridables'] = [
'#type' => 'checkboxes',
'#title' => $this->t('Overridable options'),
'#description' => $this->t("Override the main optionset to re-use one. Anything dictated here will override the current main optionset. Unchecked means FALSE"),
'#options' => $this->getOverridableOptions(),
'#weight' => 113,
'#enforced' => TRUE,
'#states' => [
'visible' => [
':input[name$="[override]"]' => ['checked' => TRUE],
],
],
];
if (!empty($definition['nav_state'])) {
$extras = [];
if (isset($definition['plugin_id']) && $definition['plugin_id'] == 'splide_entityreference') {
// Thumbnail only makes sense for Media entity, or with navigation.
$extras = ['thumbnail_style'];
}
$options = ['image', 'skin_nav', 'thumbnail_effect'];
foreach (array_merge($options, $extras) as $key) {
if (isset($form[$key])) {
$form[$key]['#states']['visible']['select[name*="[optionset_nav]"]'] = ['!value' => ''];
}
}
}
$states = [
'visible' => [
':input[name$="[overridables][pagination]"]' => ['checked' => TRUE],
],
];
if (isset($definition['pagination_texts'])) {
$form['pagination_text'] = [
'#type' => 'select',
'#title' => $this->t('Pagination text'),
'#description' => $this->t("Select a text field that should be used for the pagination labels. Useful for tab-style selection of slides. <b>Note:</b> requires a field of type `text` or `string` on all target bundles configured for the field. Might conflict with `Pagination effect`. Requires extra theming as usual."),
'#options' => (array) $definition['pagination_texts'],
'#empty_option' => $this->t('- None -'),
'#weight' => 115,
'#enforced' => TRUE,
'#states' => $states,
];
}
$form['pagination_pos'] = [
'#type' => 'select',
'#title' => $this->t('Pagination position'),
'#description' => $this->t("Applies a class `is-paginated--[left|right|top|custom]` to customize pagination positioning. Default to `bottom`, and do nothing for all. Requires extra theming as usual."),
'#empty_option' => $this->t('Default'),
'#options' => [
'left' => $this->t('Left'),
'right' => $this->t('Right'),
'top' => $this->t('Top'),
'custom' => $this->t('Custom'),
],
'#weight' => 116,
'#enforced' => TRUE,
'#states' => $states,
];
// It was originally Slick's, specific for pagination thumbnails.
// Bring in dots thumbnail effect normally used by Splide Image formatter.
if (empty($definition['no_thumb_effects'])
&& $effects = $definition['thumbnail_effect'] ?? []) {
$form['thumbnail_effect'] = [
'#type' => 'select',
'#title' => $this->t('Pagination effect'),
'#options' => $effects,
'#empty_option' => $this->t('- None -'),
'#description' => $this->t('Dependent on a Skin, Dots and Thumbnail image options. No asnavfor/ Optionset thumbnail is needed. <ol><li><strong>Hoverable</strong>: Dots pager are kept, and thumbnail will be hidden and only visible on dot mouseover, default to min-width 120px.</li><li><strong>Static grid</strong>: Dots are hidden, and thumbnails are displayed as a static grid acting like dots pager.</li></ol>Alternative to asNavFor aka separate thumbnails as slider.'),
'#weight' => 117,
'#enforced' => TRUE,
'#states' => $states,
];
}
$this->blazyAdmin->closingForm($form, $definition);
}
/**
* {@inheritdoc}
*/
public function getLayoutOptions(): array {
return [
'bottom' => $this->t('Caption bottom'),
'top' => $this->t('Caption top'),
'right' => $this->t('Caption right'),
'left' => $this->t('Caption left'),
'center' => $this->t('Caption center'),
'center-bottom' => $this->t('Caption center bottom'),
'center-top' => $this->t('Caption center top'),
'below' => $this->t('Caption below the slide'),
'stage-right' => $this->t('Caption left, stage right'),
'stage-left' => $this->t('Caption right, stage left'),
'split-right' => $this->t('Caption left, stage right, split half'),
'split-left' => $this->t('Caption right, stage left, split half'),
'stage-zebra' => $this->t('Stage zebra'),
'split-zebra' => $this->t('Split half zebra'),
];
}
/**
* {@inheritdoc}
*/
public function getOptionsetsByGroupOptions($group = ''): array {
$optionsets = $groups = $ungroups = [];
$splides = $this->manager->loadMultiple('splide');
foreach ($splides as $splide) {
$name = Html::escape($splide->label());
$id = $splide->id();
$current_group = $splide->getGroup();
if (!empty($group)) {
if ($current_group) {
if ($current_group != $group) {
continue;
}
$groups[$id] = $name;
}
else {
$ungroups[$id] = $name;
}
}
$optionsets[$id] = $name;
}
return $group ? array_merge($ungroups, $groups) : $optionsets;
}
/**
* {@inheritdoc}
*/
public function getOverridableOptions(): array {
$options = SplideDefault::overridableOptions(TRUE);
$this->manager->moduleHandler()->alter('splide_overridable_options_info', $options);
return $options;
}
/**
* {@inheritdoc}
*/
public function getSkinsByGroupOptions($group = ''): array {
return $this->manager->skinManager()->getSkinsByGroup($group, TRUE);
}
/**
* {@inheritdoc}
*/
public function getSettingsSummary(array $definition = []): array {
return $this->blazyAdmin->getSettingsSummary($definition);
}
/**
* {@inheritdoc}
*/
public function getFieldOptions(
array $target_bundles = [],
array $allowed_field_types = [],
$entity_type_id = 'media',
$target_type = '',
): array {
return $this->blazyAdmin->getFieldOptions($target_bundles, $allowed_field_types, $entity_type_id, $target_type);
}
/**
* {@inheritdoc}
*/
public function getValidFieldOptions(
array $bundles,
string $target_type,
array $valid_field_types = [
'string',
'text',
],
): array {
$storage = $this->manager->getStorage('field_config');
$candidate_fields = [];
// Fix for Views UI not recognizing Media bundles, unlike Formatters.
if (empty($bundles) && $bundle_service = self::service('entity_type.bundle.info')) {
$bundles = $bundle_service->getBundleInfo($target_type);
}
foreach ($bundles as $bundle => $label) {
$candidate_fields[$bundle] = [];
$fields = $this->entityFieldManager->getFieldDefinitions($target_type, $bundle);
if (empty($fields)) {
$fields = $storage->loadByProperties([
'entity_type' => $target_type,
'bundle' => $bundle,
]);
}
foreach ((array) $fields as $field) {
if (is_a($field, 'Drupal\field\Entity\FieldConfig') and in_array($field->getType(), $valid_field_types)) {
$candidate_fields[$bundle][$field->getName()] = $field->getLabel();
}
}
}
$valid_fields = [];
if (count($candidate_fields) === 1) {
$valid_fields = reset($candidate_fields);
}
elseif (count($candidate_fields) > 1) {
$valid_fields = call_user_func_array('array_intersect', array_values($candidate_fields));
}
return $valid_fields;
}
/**
* Modifies re-usable logic, styling and assets across fields and Views.
*/
public function finalizeForm(array &$form, array $definition): void {
$this->blazyAdmin->finalizeForm($form, $definition);
}
/**
* Returns grid header description.
*/
protected function gridHeaderDescription() {
return $this->t('An older alternative to core <strong>Rows</strong> option. Only works if the total items > <strong>Visible slides</strong>. <br />block grid != perPage option, yet both can work in tandem.<br />block grid = Rows option, yet the first is module feature, the later core.');
}
/**
* Returns a wrapper to pass tests, or DI where adding params is troublesome.
*/
private static function service($service) {
return \Drupal::hasService($service) ? \Drupal::service($service) : NULL;
}
}
