class BlazyDefault in Blazy 7

Defines shared plugin default settings for field formatter and Views style.

Hierarchy

• class \Drupal\blazy\BlazyDefault

13 files declare their use of BlazyDefault

blazy.install in ./blazy.install

Installation actions for Blazy.

blazy.runtime.inc in ./blazy.runtime.inc

Provides basic Blazy integration for lazy loading and multi-serving images.

Blazy.test in tests/Blazy.test

blazy.theme.inc in ./blazy.theme.inc

Hooks and preprocess functions for the Blazy module.

BlazyEntityReferenceBase.php in src/Plugin/Field/FieldFormatter/BlazyEntityReferenceBase.php

... See full list

File

src/BlazyDefault.php, line 8

Namespace

Drupal\blazy

class BlazyDefault {

  /**
   * Defines constant for the supported text fields.
   */
  const TEXTS = [
    'text',
    'text_long',
    'text_with_summary',
  ];

  /**
   * Defines constant for the supported text tags.
   */
  const TAGS = [
    'a',
    'em',
    'strong',
    'h2',
    'p',
    'span',
    'ul',
    'ol',
    'li',
  ];

  /**
   * Defines constant pages related to Blazy filter at D7.
   */
  const PAGES = "admin*\nimagebrowser*\nimg_assist*\nimce*\nnode/add/*\nnode/*/edit\nprint/*\nprintpdf/*\nsystem/ajax\nsystem/ajax/*";

  /**
   * The supported $breakpoints.
   *
   * @var array
   */
  private static $breakpoints = [
    'xs',
    'sm',
    'md',
    'lg',
    'xl',
  ];

  /**
   * Returns Blazy specific breakpoints.
   */
  public static function getConstantBreakpoints() {
    return self::$breakpoints;
  }

  /**
   * Returns settings provided by various UI.
   */
  public static function anywhereSettings() {
    return [
      'fx' => '',
      'style' => '',
    ];
  }

  /**
   * Returns basic plugin settings: text, image, file, entities with grids.
   */
  public static function baseSettings() {
    $settings = [
      'cache' => 0,
      'current_view_mode' => 'default',
    ] + self::gridSettings() + self::anywhereSettings();
    $context = [
      'class' => get_called_class(),
    ];
    drupal_alter('blazy_base_settings', $settings, $context);
    return $settings;
  }

  /**
   * Returns optional grid field formatter and Views settings.
   */
  public static function gridSettings() {
    return [
      'grid' => 0,
      'grid_medium' => 0,
      'grid_small' => 0,
    ] + self::anywhereSettings();
  }

  /**
   * Returns cherry-picked settings for field formatters and Views fields.
   */
  public static function cherrySettings() {
    return [
      'box_style' => '',
      'image_style' => '',
      'media_switch' => '',
      'ratio' => '',
      'thumbnail_style' => '',
      '_uri' => '',
    ];
  }

  /**
   * Returns image-related field formatter and Views settings.
   */
  public static function baseImageSettings() {
    return [
      'background' => FALSE,
      'box_caption' => '',
      'box_caption_custom' => '',
      'box_media_style' => '',
      'breakpoints' => [],
      'caption' => [],
      'lazy' => 'blazy',
      'responsive_image_style' => '',
      'sizes' => '',
    ] + self::cherrySettings();
  }

  /**
   * Returns image-related field formatter and Views settings.
   */
  public static function imageSettings() {
    return [
      'icon' => '',
      'layout' => '',
      'view_mode' => '',
    ] + self::baseSettings() + self::baseImageSettings();
  }

  /**
   * Returns Views specific settings.
   */
  public static function viewsSettings() {
    return [
      'class' => '',
      'id' => '',
      'image' => '',
      'link' => '',
      'overlay' => '',
      'title' => '',
      'vanilla' => FALSE,
    ];
  }

  /**
   * Returns fieldable entity formatter and Views settings.
   */
  public static function extendedSettings() {
    return self::viewsSettings() + self::imageSettings();
  }

  /**
   * Returns sensible default options common for Views lacking of UI.
   */
  public static function lazySettings() {
    return [
      'blazy' => TRUE,
      'lazy' => 'blazy',
      'ratio' => 'fluid',
    ];
  }

  /**
   * Returns sensible default options common for entities lacking of UI.
   */
  public static function entitySettings() {
    return [
      'media_switch' => 'media',
      'rendered' => FALSE,
      'view_mode' => 'default',
      '_detached' => TRUE,
    ] + self::lazySettings();
  }

  /**
   * Returns shared global form settings which should be consumed at formatters.
   */
  public static function uiSettings() {
    return [
      'one_pixel' => TRUE,
      'native' => TRUE,
      'placeholder' => '',
      'responsive_image' => FALSE,
    ] + self::anywhereSettings();
  }

  /**
   * Returns sensible default container settings to shutup notices when lacking.
   */
  public static function htmlSettings() {
    return [
      'blazy_data' => [],
      'lightbox' => FALSE,
      'namespace' => 'blazy',
      'id' => '',
    ] + self::imageSettings() + self::uiSettings();
  }

  /**
   * Returns sensible default html settings to shutup notices when lacking.
   */
  public static function itemSettings() {
    return [
      'content_url' => '',
      'delta' => 0,
      'embed_url' => '',
      'entity_type_id' => '',
      'icon' => '',
      'image_url' => '',
      'item_id' => 'blazy',
      'lazy_attribute' => 'src',
      'lazy_class' => 'b-lazy',
      'padding_bottom' => '',
      'picture' => FALSE,
      'player' => FALSE,
      'scheme' => '',
      'type' => 'image',
      'uri' => '',
      'use_data_uri' => FALSE,
      'thumbnail_uri' => '',
      'use_field' => FALSE,
      'use_image' => TRUE,
      'use_loading' => TRUE,
      'use_media' => FALSE,
      'height' => NULL,
      'width' => NULL,
    ] + self::htmlSettings();
  }

  /**
   * Returns blazy theme properties.
   */
  public static function themeProperties() {
    return [
      'attributes',
      'captions',
      'iframe',
      'item',
      'postscript',
      'settings',
      'url',
    ];
  }

  /**
   * Returns blazy theme attributes.
   */
  public static function themeAttributes() {
    return [
      'caption',
      'item',
      'media',
      'url',
      'wrapper',
    ];
  }

  /**
   * Returns blazy UI settings for typecasting, done via config schema at D8.
   */
  public static function formSettings() {
    return [
      'admin_css' => TRUE,
      'unbreakpoints' => FALSE,
      'visibility' => 0,
      'pages' => static::PAGES,
      'extras' => [],
      'blazy' => [
        'loadInvisible' => FALSE,
        'offset' => 100,
        'saveViewportOffsetDelay' => 50,
        'validateDelay' => 25,
        'container' => '',
      ],
      'io' => [
        'enabled' => FALSE,
        'unblazy' => FALSE,
        'disconnect' => FALSE,
        'rootMargin' => '0px',
        'threshold' => '0',
      ],
      'filters' => [
        'column' => TRUE,
        'grid' => TRUE,
        'media_switch' => '',
        'use_data_uri' => FALSE,
      ],
    ] + self::uiSettings();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyDefault::$breakpoints	private static	property	The supported $breakpoints.
BlazyDefault::anywhereSettings	public static	function	Returns settings provided by various UI.
BlazyDefault::baseImageSettings	public static	function	Returns image-related field formatter and Views settings.
BlazyDefault::baseSettings	public static	function	Returns basic plugin settings: text, image, file, entities with grids.
BlazyDefault::cherrySettings	public static	function	Returns cherry-picked settings for field formatters and Views fields.
BlazyDefault::entitySettings	public static	function	Returns sensible default options common for entities lacking of UI.
BlazyDefault::extendedSettings	public static	function	Returns fieldable entity formatter and Views settings.
BlazyDefault::formSettings	public static	function	Returns blazy UI settings for typecasting, done via config schema at D8.
BlazyDefault::getConstantBreakpoints	public static	function	Returns Blazy specific breakpoints.
BlazyDefault::gridSettings	public static	function	Returns optional grid field formatter and Views settings.
BlazyDefault::htmlSettings	public static	function	Returns sensible default container settings to shutup notices when lacking.
BlazyDefault::imageSettings	public static	function	Returns image-related field formatter and Views settings.
BlazyDefault::itemSettings	public static	function	Returns sensible default html settings to shutup notices when lacking.
BlazyDefault::lazySettings	public static	function	Returns sensible default options common for Views lacking of UI.
BlazyDefault::PAGES		constant	Defines constant pages related to Blazy filter at D7.
BlazyDefault::TAGS		constant	Defines constant for the supported text tags.
BlazyDefault::TEXTS		constant	Defines constant for the supported text fields.
BlazyDefault::themeAttributes	public static	function	Returns blazy theme attributes.
BlazyDefault::themeProperties	public static	function	Returns blazy theme properties.
BlazyDefault::uiSettings	public static	function	Returns shared global form settings which should be consumed at formatters.
BlazyDefault::viewsSettings	public static	function	Returns Views specific settings.