abstract class BlazyStylePluginBase in Blazy 7

A base for blazy views integration to have re-usable methods in one place.

This file is not used by Blazy, but for its related-modules to DRY.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \Drupal\blazy\Dejavu\BlazyStylePluginBase uses BlazyStyleBaseTrait, BlazyStyleOptionsTrait, BlazyStylePluginTrait

See also

\Drupal\mason\Plugin\views\style\MasonViews

\Drupal\gridstack\Plugin\views\style\GridStackViews

\Drupal\slick_views\Plugin\views\style\SlickViews

File

src/Dejavu/BlazyStylePluginBase.php, line 17

Namespace

Drupal\blazy\Dejavu

abstract class BlazyStylePluginBase extends views_plugin_style {
  use BlazyStyleBaseTrait;
  use BlazyStyleOptionsTrait;
  use BlazyStylePluginTrait;

  /**
   * The blazy manager service.
   *
   * @var \Drupal\blazy\BlazyManagerInterface
   */
  protected $blazyManager;

  /**
   * Returns the blazy manager.
   */
  public function blazyManager() {
    if (!isset($this->blazyManager)) {
      $this->blazyManager = new BlazyManager();
    }
    return $this->blazyManager;
  }

  /**
   * Returns an individual row/element content.
   */
  public function buildElement(array &$element, $row, $index) {
    $settings =& $element['settings'];
    $item_id = empty($settings['item_id']) ? 'box' : $settings['item_id'];

    // Add main image fields if so configured.
    if (!empty($settings['image'])) {

      // Supports individual grid/box image style either inline IMG, or CSS.
      $image = $this
        ->getImageRenderable($settings, $row, $index);
      $element['item'] = $this
        ->getImageItem($image);
      $element[$item_id] = empty($image['rendered']) ? [] : $image['rendered'];
    }

    // Add caption fields if so configured.
    $element['caption'] = $this
      ->getCaption($index, $settings);

    // Add layout field, may be a list field, or builtin layout options.
    if (!empty($settings['layout'])) {
      $this
        ->getLayout($settings, $index);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlazyStyleBaseTrait::$firstImage	protected	property	The first Blazy formatter found to get data from for lightbox gallery, etc.
BlazyStyleBaseTrait::$htmlSettings	protected	property	The dynamic html settings.
BlazyStyleBaseTrait::buildSettings	protected	function	Provides commons settings for the style plugins.
BlazyStyleBaseTrait::getFieldRenderable	public	function	Returns the renderable array of field containing rendered and raw data.
BlazyStyleBaseTrait::getFirstImage	public	function	Returns the first Blazy formatter found.
BlazyStyleBaseTrait::setHtmlSettings	protected	function	Sets dynamic html settings.
BlazyStyleOptionsTrait::$viewsOptions	protected	property	The Views as options.
BlazyStyleOptionsTrait::getDefinedFieldOptions	public	function	Returns available fields for select options.
BlazyStyleOptionsTrait::getFieldString	public	function	Returns the string values for the expected Title, ET label, List, Term.
BlazyStylePluginBase::$blazyManager	protected	property	The blazy manager service. Overrides BlazyStyleBaseTrait::$blazyManager
BlazyStylePluginBase::blazyManager	public	function	Returns the blazy manager. Overrides BlazyStyleBaseTrait::blazyManager
BlazyStylePluginBase::buildElement	public	function	Returns an individual row/element content.
BlazyStylePluginTrait::getCaption	public	function	Returns the rendered caption fields.
BlazyStylePluginTrait::getFieldRendered	public	function	Returns the rendered field, either string or array.
BlazyStylePluginTrait::getImageItem	public	function	Get the image item to work with out of this formatter.
BlazyStylePluginTrait::getImageRenderable	public	function	Returns the modified renderable image_formatter to support lazyload.
BlazyStylePluginTrait::getLayout	public	function	Returns the rendered layout fields.
BlazyStylePluginTrait::isImageRenderable	public	function	Checks if we can work with this formatter, otherwise no go if flattened.
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::get_row_class	public	function	Return the token replaced row class for the specified row.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::options_form	public	function	Provide a form to edit options for this plugin. Overrides views_plugin::options_form	9
views_plugin_style::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition	8
views_plugin_style::pre_render	public	function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render	public	function	Render the display in this style.	5
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate