You are here

Home » API reference » Blazy 8.2 » BlazyAdminExtended.php

class BlazyAdminExtended in Blazy 8.2

Same name and namespace in other branches
  1. 8 src/Dejavu/BlazyAdminExtended.php \Drupal\blazy\Dejavu\BlazyAdminExtended

Provides re-usable admin functions, or form elements.

Hierarchy

Expanded class hierarchy of BlazyAdminExtended

1 file declares its use of BlazyAdminExtended
BlazyAdminExtendedUnitTest.php in tests/src/Unit/Form/BlazyAdminExtendedUnitTest.php
1 string reference to 'BlazyAdminExtended'
blazy.services.yml in ./blazy.services.yml
blazy.services.yml
1 service uses BlazyAdminExtended
blazy.admin.extended in ./blazy.services.yml
Drupal\blazy\Dejavu\BlazyAdminExtended

File

src/Dejavu/BlazyAdminExtended.php, line 11

Namespace

Drupal\blazy\Dejavu
View source 
class BlazyAdminExtended extends BlazyAdminFormatterBase implements BlazyAdminInterface {

  /**
   * Returns shared form elements across field formatter and Views.
   */
  public function openingForm(array &$form, &$definition = []) {
    $namespace = isset($definition['namespace']) ? $definition['namespace'] : 'blazy';
    if (!empty($definition['vanilla'])) {
      $form['vanilla'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Vanilla @namespace', [
          '@namespace' => $namespace,
        ]),
        '#description' => $this
          ->t('<strong>Check</strong>:<ul><li>To render individual item as is as without extra logic.</li><li>To disable 99% @module features, and most of the mentioned options here, such as layouts, et al.</li><li>When the @module features can not satisfy the need.</li><li>Things may be broken! You are on your own.</li></ul><strong>Uncheck</strong>:<ul><li>To get consistent markups and its advanced features -- relevant for the provided options as @module needs to know what to style/work with.</li></ul>', [
          '@module' => $namespace,
        ]),
        '#weight' => -109,
        '#enforced' => TRUE,
        '#attributes' => [
          'class' => [
            'form-checkbox--vanilla',
          ],
        ],
        '#wrapper_attributes' => [
          'class' => [
            'form-item--full',
            'form-item--tooltip-bottom',
          ],
        ],
      ];
    }
    if (!empty($definition['optionsets']) && $namespace != 'blazy') {
      $form['optionset'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Optionset'),
        '#options' => $definition['optionsets'],
        '#enforced' => TRUE,
        '#description' => $this
          ->t('Enable the optionset UI module to manage the optionsets.'),
        '#weight' => -108,
      ];
    }
    parent::openingForm($form, $definition);
  }

  /**
   * Returns re-usable fieldable formatter form elements.
   */
  public function fieldableForm(array &$form, $definition = []) {
    if (isset($definition['images'])) {
      $form['image'] = $this
        ->baseForm($definition)['image'];
    }
    if (isset($definition['thumbnails'])) {
      $form['thumbnail'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Thumbnail image'),
        '#options' => is_array($definition['thumbnails']) ? $definition['thumbnails'] : [],
        '#description' => $this
          ->t('Leave empty to not use thumbnail pager.'),
      ];
    }
    if (isset($definition['overlays'])) {
      $form['overlay'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Overlay media'),
        '#options' => is_array($definition['overlays']) ? $definition['overlays'] : [],
        '#description' => $this
          ->t('Overlay is displayed over the main stage.'),
      ];
    }
    if (isset($definition['titles'])) {

      // Ensures to not override Views content/ entity title, just formatters.
      if (!empty($definition['images']) && empty($definition['_views'])) {
        $definition['titles']['title'] = $this
          ->t('Image Title');
      }
      $form['title'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Title'),
        '#options' => is_array($definition['titles']) ? $definition['titles'] : [],
        '#description' => $this
          ->t('If provided, it will be wrapped with H2. Also supported the basic non-field Image title'),
      ];
    }
    if (isset($definition['links'])) {
      $form['link'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Link'),
        '#options' => is_array($definition['links']) ? $definition['links'] : [],
        '#description' => $this
          ->t('Link to content: Read more, View Case Study, etc.'),
      ];
    }
    if (isset($definition['classes'])) {
      $form['class'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Item class'),
        '#options' => is_array($definition['classes']) ? $definition['classes'] : [],
        '#description' => $this
          ->t('If provided, individual item will have this class, e.g.: to have different background with transparent images. Be sure its formatter is Key or Label. Accepted field types: list text, string (e.g.: node title), term/entity reference label.'),
        '#weight' => 6,
      ];
    }
    if (!empty($definition['id'])) {
      $form['id'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('@namespace ID', [
          '@namespace' => $definition['namespace'],
        ]),
        '#size' => 40,
        '#maxlength' => 255,
        '#field_prefix' => '#',
        '#enforced' => TRUE,
        '#description' => $this
          ->t("<b>(Deprecated)</b>. Do not use this! Leave it empty, this option will be removed at future versions. It brings trouble than useful. <br>Old description: Manually define the container ID. <em>This ID is used for the cache identifier, so be sure it is unique</em>. Leave empty to have a guaranteed unique ID managed by the module, or if you see similar views while should be different."),
        '#weight' => 94,
      ];
    }
    if (isset($form['caption'])) {
      $form['caption']['#description'] = $this
        ->t('Enable any of the following fields as captions. These fields are treated and wrapped as captions.');
    }
    if (empty($definition['id'])) {
      if (isset($form['caption'])) {
        $form['caption']['#description'] .= ' ' . $this
          ->t('Be sure to make them visible at their relevant Manage display.');
      }
    }
    else {
      if (isset($form['overlay'])) {
        $form['overlay']['#description'] .= ' ' . $this
          ->t('Be sure to CHECK "Use field template" under its formatter if using Slick field formatter.');
      }
    }
  }

  /**
   * Returns shared ending form elements across field formatter and Views.
   */
  public function closingForm(array &$form, $definition = []) {
    if (!empty($definition['caches'])) {
      $form['cache'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Cache'),
        '#options' => $this
          ->getCacheOptions(),
        '#weight' => 98,
        '#enforced' => TRUE,
        '#description' => $this
          ->t('Ditch all the logic to cached bare HTML. <ol><li><strong>Permanent</strong>: cached contents will persist (be displayed) till the next cron runs.</li><li><strong>Any number</strong>: expired by the selected expiration time, and fresh contents are fetched till the next cache rebuilt.</li></ol>A working cron job is required to clear stale cache. At any rate, cached contents will be refreshed regardless of the expiration time after the cron hits. <br />Leave it empty to disable caching.<br /><strong>Warning!</strong> Be sure no useless/ sensitive data such as Edit links as they are rendered as is regardless permissions. No permissions are changed, just ugly. Only enable it when all is done, otherwise cached options will be displayed while changing them.'),
      ];
      if (!empty($definition['_views'])) {
        $form['cache']['#description'] .= ' ' . $this
          ->t('Also disable Views cache (<strong>Advanced &gt; Caching</strong>) temporarily _only if trouble to see updated settings.');
      }
    }
    parent::closingForm($form, $definition);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlazyAdminBase::$blazyManager protected property The blazy manager service.
BlazyAdminBase::$dateFormatter protected property The date formatter service.
BlazyAdminBase::$entityDisplayRepository protected property The entity type manager service.
BlazyAdminBase::$typedConfig protected property The typed config manager service.
BlazyAdminBase::baseForm public function Returns simple form elements common for Views field, EB widget, formatters.
BlazyAdminBase::blazyManager public function Returns the blazy manager.
BlazyAdminBase::breakpointsForm public function Deprecated method to remove.
BlazyAdminBase::create public static function
BlazyAdminBase::finalizeForm public function Returns re-usable logic, styling and assets across fields and Views.
BlazyAdminBase::getCacheOptions public function Returns time in interval for select options.
BlazyAdminBase::getEntityAsOptions public function Returns available entities for select options.
BlazyAdminBase::getEntityDisplayRepository public function Returns the entity display repository.
BlazyAdminBase::getLightboxCaptionOptions public function Returns available lightbox captions for select options.
BlazyAdminBase::getOptionsetOptions public function Returns available optionsets for select options.
BlazyAdminBase::getResponsiveImageOptions public function Returns Responsive image for select options.
BlazyAdminBase::getState protected function Get one of the pre-defined states used in this form.
BlazyAdminBase::getTypedConfig public function Returns the typed config.
BlazyAdminBase::getViewModeOptions public function Returns available view modes for select options.
BlazyAdminBase::gridForm public function Returns re-usable grid elements across field formatter and Views.
BlazyAdminBase::mediaSwitchForm public function Returns re-usable media switch form elements.
BlazyAdminBase::STATE_IFRAME_ENABLED constant A state that represents the media switch iframe is enabled.
BlazyAdminBase::STATE_IMAGE_RENDERED_ENABLED constant A state that represents the image rendered switch is enabled.
BlazyAdminBase::STATE_LIGHTBOX_CUSTOM constant A state that represents the custom lightbox caption is enabled.
BlazyAdminBase::STATE_LIGHTBOX_ENABLED constant A state that represents the media switch lightbox is enabled.
BlazyAdminBase::STATE_RESPONSIVE_IMAGE_STYLE_DISABLED constant A state that represents the responsive image style is disabled.
BlazyAdminBase::STATE_THUMBNAIL_STYLE_ENABLED constant A state that represents the thumbnail style is enabled.
BlazyAdminBase::__construct public function Constructs a BlazyAdminBase object.
BlazyAdminExtended::closingForm public function Returns shared ending form elements across field formatter and Views. Overrides BlazyAdminBase::closingForm
BlazyAdminExtended::fieldableForm public function Returns re-usable fieldable formatter form elements.
BlazyAdminExtended::openingForm public function Returns shared form elements across field formatter and Views. Overrides BlazyAdminBase::openingForm
BlazyAdminFormatterBase::basicImageForm public function Defines re-usable basic form elements.
BlazyAdminFormatterBase::getExcludedFieldOptions public function Declutters options from less relevant options, specific to captions.
BlazyAdminFormatterBase::getExcludedSettingsSummary public function Exclude the field formatter settings summary as required.
BlazyAdminFormatterBase::getFieldOptions public function Returns available fields for select options.
BlazyAdminFormatterBase::getSettingsSummary public function Return the field formatter settings summary.
BlazyAdminFormatterBase::imageStyleForm public function Returns re-usable image formatter form elements.
BlazyAdminFormatterBase::settingsSummary Deprecated public function Return the field formatter settings summary.
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.