abstract class BlazyAdminFormatterBase in Blazy 7

Same name and namespace in other branches

8.2 src/Form/BlazyAdminFormatterBase.php \Drupal\blazy\Form\BlazyAdminFormatterBase
8 src/Form/BlazyAdminFormatterBase.php \Drupal\blazy\Form\BlazyAdminFormatterBase

A base for field formatter admin to have re-usable methods in one place.

Hierarchy

class \Drupal\blazy\Form\BlazyAdminBase implements BlazyAdminInterface
- class \Drupal\blazy\Form\BlazyAdminFormatterBase

Expanded class hierarchy of BlazyAdminFormatterBase

File

src/Form/BlazyAdminFormatterBase.php, line 8

Namespace

Drupal\blazy\Form

View source

abstract class BlazyAdminFormatterBase extends BlazyAdminBase {

  /**
   * Returns re-usable image formatter form elements.
   */
  public function imageStyleForm(array &$form, $definition = []) {
    $is_picture = function_exists('picture_get_mapping_options');
    if (empty($definition['no_image_style'])) {
      $form['image_style'] = $this
        ->baseForm($definition)['image_style'];
    }
    if (!empty($definition['thumbnail_style'])) {
      $form['thumbnail_style'] = $this
        ->baseForm($definition)['thumbnail_style'];
    }
    if (!empty($definition['responsive_image']) && $this
      ->manager()
      ->config('responsive_image', FALSE, 'blazy.settings')) {
      $responsive_options = $this
        ->getResponsiveImageOptions();
      $description = t('Not compatible with below breakpoints, aspect ratio, yet. However the image can be replaced by Picture if <strong>Picture</strong> option enabled at Blazy UI. Lazyload is taken care of by Picture, not Blazy. Leave empty to disable.');
      if ($is_picture && empty($responsive_options)) {
        $description = t('<a href="@url" target="_blank">No picture mappings</a> defined.', [
          '@url' => url('admin/config/media/picture'),
        ]);
      }
      $form['responsive_image_style'] = [
        '#type' => 'select',
        '#title' => t('Picture'),
        '#options' => $responsive_options,
        '#description' => $description,
        '#access' => $is_picture,
        '#weight' => -100,
      ];
      if (!empty($definition['background'])) {
        $form['background']['#states'] = $this
          ->getState(static::STATE_RESPONSIVE_IMAGE_STYLE_DISABLED, $definition);
      }
    }
    if (!empty($definition['thumbnail_effect'])) {
      $form['thumbnail_effect'] = [
        '#type' => 'select',
        '#title' => t('Thumbnail effect'),
        '#options' => isset($definition['thumbnail_effect']) ? $definition['thumbnail_effect'] : [],
        '#weight' => -100,
      ];
    }
  }

  /**
   * Return the field formatter settings summary.
   */
  public function getSettingsSummary($definition = []) {
    $summary = [];
    if (empty($definition['settings'])) {
      return $summary;
    }
    $this
      ->getExcludedSettingsSummary($definition);
    $enforced = [
      'optionset',
      'cache',
      'skin',
      'view_mode',
      'override',
      'overridables',
      'style',
      'vanilla',
    ];
    $enforced = isset($definition['enforced']) ? $definition['enforced'] : $enforced;
    $settings = array_filter($definition['settings']);
    $breakpoints = isset($settings['breakpoints']) && is_array($settings['breakpoints']) ? array_filter($settings['breakpoints']) : [];
    foreach ($definition['settings'] as $key => $setting) {
      $title = ucfirst(str_replace('_', ' ', $key));
      $vanilla = !empty($settings['vanilla']);
      if ($key == 'breakpoints') {
        $widths = [];
        if ($breakpoints) {
          foreach ($breakpoints as $breakpoint) {
            if (!empty($breakpoint['width'])) {
              $widths[] = $breakpoint['width'];
            }
          }
        }
        $title = 'Breakpoints';
        $setting = $widths ? implode(', ', $widths) : 'none';
      }
      else {
        if ($vanilla && !in_array($key, $enforced)) {
          continue;
        }
        if ($key == 'override' && empty($setting)) {
          unset($settings['overridables']);
        }
        if (is_bool($setting) && $setting) {
          $setting = 'yes';
        }
        elseif (is_array($setting)) {
          $setting = array_filter($setting);
          if (!empty($setting)) {
            $setting = implode(', ', $setting);
          }
        }
        if ($key == 'cache') {
          $setting = $this
            ->getCacheOptions()[$setting];
        }
      }
      if (empty($setting)) {
        continue;
      }
      if (isset($settings[$key]) && is_string($setting)) {
        $summary[] = t('@title: <strong>@setting</strong>', [
          '@title' => $title,
          '@setting' => $setting,
        ]);
      }
    }
    return implode('<br />', $summary);
  }

  /**
   * Exclude the field formatter settings summary as required.
   */
  public function getExcludedSettingsSummary(array &$definition = []) {
    $settings =& $definition['settings'];
    $excludes = empty($definition['excludes']) ? [] : $definition['excludes'];
    $plugin_id = isset($definition['plugin_id']) ? $definition['plugin_id'] : '';
    $blazy = $plugin_id && strpos($plugin_id, 'blazy') !== FALSE;
    $image_styles = image_style_options(TRUE);
    unset($image_styles['']);
    $excludes['current_view_mode'] = TRUE;
    if ($blazy) {
      $excludes['optionset'] = TRUE;
    }
    if (!empty($settings['responsive_image_style'])) {
      foreach ([
        'ratio',
        'breakpoints',
        'background',
        'sizes',
      ] as $key) {
        $excludes[$key] = TRUE;
      }
    }
    if (empty($settings['grid'])) {
      foreach ([
        'grid',
        'grid_medium',
        'grid_small',
        'visible_items',
      ] as $key) {
        $excludes[$key] = TRUE;
      }
    }

    // Remove exluded settings.
    foreach ($excludes as $key => $value) {
      if (isset($settings[$key])) {
        unset($settings[$key]);
      }
    }
    foreach ($settings as $key => $setting) {
      if ($key == 'style' || $key == 'responsive_image_style' || empty($settings[$key])) {
        continue;
      }
      if (strpos($key, 'style') !== FALSE && isset($image_styles[$settings[$key]])) {
        $settings[$key] = $image_styles[$settings[$key]];
      }
    }
  }

  /**
   * Returns available fields for select options.
   */
  public function getFieldOptions($instance, $field_types, $target_type = 'file', array $bundles = []) {
    $options = [];
    $allowed_bundles = array_filter($this
      ->getBundles($instance, $bundles));

    // Add panelizer support.
    if ($instance['entity_type'] == 'ctools') {
      $bundles = array_filter($bundles);
      foreach ($bundles as $bundle_type => $types) {
        foreach ($types as $type) {
          $instance = field_info_instance($bundle_type, $instance['field_name'], $type);
          $allowed_bundles = $this
            ->getBundles($instance, $bundles);
          $options += $this
            ->getFieldOptionsInternal($allowed_bundles, $target_type, $field_types);
        }
      }
    }
    else {
      $options = $this
        ->getFieldOptionsInternal($allowed_bundles, $target_type, $field_types);
    }
    if (empty($options)) {
      $fields = field_info_fields();
      $bundle_instance = $instance['field_name'];
      foreach ($fields as $name => $field) {
        $infos = field_info_instance($target_type, $name, $bundle_instance);
        if (empty($field_types) && isset($infos['label'])) {
          $options[$name] = $infos['label'];
        }
        else {
          if (in_array($target_type, array_keys($field['bundles'])) && in_array($bundle_instance, $field['bundles'][$target_type]) && in_array($field['type'], $field_types)) {
            $options[$name] = $infos['label'];
          }
        }
      }
    }
    return $options;
  }

  /**
   * Returns the expected bundles.
   */
  private function getBundles($instance, array $bundles = []) {

    // Paragraphs.
    $allowed_bundles = isset($instance['settings']['allowed_bundles']) ? $instance['settings']['allowed_bundles'] : [];

    // File entity.
    if (empty($allowed_bundles)) {
      $allowed_bundles = isset($instance['widget']['settings']['allowed_types']) ? $instance['widget']['settings']['allowed_types'] : [];
    }
    return $allowed_bundles;
  }

  /**
   * Helper function to get list of supported field base on field_types.
   */
  private function getFieldOptionsInternal($allowed_bundles, $target_type, $field_types) {
    $options = [];
    foreach ($allowed_bundles as $bundle_name => $bundle) {
      if ($bundle !== -1) {
        $fields = field_info_instances($target_type, $bundle_name);
        foreach ($fields as $name => $field) {
          if (in_array($name, $this
            ->getExcludedFieldOptions())) {
            continue;
          }
          $info = field_info_field($name);
          if (empty($field_types)) {
            $options[$name] = $field['label'];
          }
          else {
            if (in_array($target_type, array_keys($info['bundles'])) && in_array($info['type'], $field_types)) {
              $options[$name] = $field['label'];
            }
          }
        }
      }
    }
    return $options;
  }

  /**
   * Declutters options from less relevant options.
   */
  public function getExcludedFieldOptions() {
    $excludes = 'field_document_size field_id field_media_in_library field_mime_type field_source field_tweet_author field_tweet_id field_tweet_url field_media_video_embed_field field_instagram_shortcode field_instagram_url';
    $excludes = explode(' ', $excludes);
    $excludes = array_combine($excludes, $excludes);
    drupal_alter('blazy_excluded_field_options', $excludes);
    return $excludes;
  }

  /**
   * Returns Picture for select options.
   */
  public function getResponsiveImageOptions() {
    if (function_exists('picture_get_mapping_options')) {
      return picture_get_mapping_options();
    }
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyAdminBase::$manager	protected	property	The blazy manager service.
BlazyAdminBase::$viewModeOptions	protected	property	The available view modes.
BlazyAdminBase::baseForm	public	function	Returns simple form elements common for Views field, EB widget, formatters.
BlazyAdminBase::breakpointElements	public	function	Defines re-usable breakpoints form.
BlazyAdminBase::breakpointsForm	public	function	Defines re-usable breakpoints form.
BlazyAdminBase::closingForm	public	function	Returns shared ending form elements across field formatter and Views.	1
BlazyAdminBase::finalizeForm	public	function	Returns re-usable logic, styling and assets across fields and Views.
BlazyAdminBase::getBundlePath	protected	function	Helper function for getting correct bundle for manage field/display path.
BlazyAdminBase::getCacheOptions	public	function	Returns time in interval for select options.
BlazyAdminBase::getOptionsetOptions	public	function	Returns available optionsets for select options.
BlazyAdminBase::getState	protected	function	Get one of the pre-defined states used in this form.
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::manager	public	function	Returns the blazy manager.
BlazyAdminBase::mediaSwitchForm	public	function	Returns re-usable media switch form elements.
BlazyAdminBase::openingForm	public	function	Returns shared form elements across field formatter and Views.	1
BlazyAdminBase::showAltTitleFieldHint	protected	function	If the image field doesn't have the Title field enabled, tell the user.
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 BlazyAdmin instance.
BlazyAdminFormatterBase::getBundles	private	function	Returns the expected bundles.
BlazyAdminFormatterBase::getExcludedFieldOptions	public	function	Declutters options from less relevant options.
BlazyAdminFormatterBase::getExcludedSettingsSummary	public	function	Exclude the field formatter settings summary as required.
BlazyAdminFormatterBase::getFieldOptions	public	function	Returns available fields for select options.
BlazyAdminFormatterBase::getFieldOptionsInternal	private	function	Helper function to get list of supported field base on field_types.
BlazyAdminFormatterBase::getResponsiveImageOptions	public	function	Returns Picture for select options.
BlazyAdminFormatterBase::getSettingsSummary	public	function	Return the field formatter settings summary.
BlazyAdminFormatterBase::imageStyleForm	public	function	Returns re-usable image formatter form elements.

You are here

abstract class BlazyAdminFormatterBase in Blazy 7

Hierarchy

File

Namespace

Members

API Navigation