You are here

public function JuiceboxGallery::getOptions in Juicebox HTML5 Responsive Image Galleries 8.2

Same name and namespace in other branches
  1. 8.3 src/JuiceboxGallery.php \Drupal\juicebox\JuiceboxGallery::getOptions()

Getter method for the gallery options.

Parameters

bool $filtered: If TRUE any output processing that is specified in the settings will be applied to the returned data (matching the processing that would happen upon rendering the XML). If FALSE the image data is returned in a raw format that matches what was input directly via addOption().

Return value

array Returns an array of options set on the gallery.

Overrides JuiceboxGalleryInterface::getOptions

2 calls to JuiceboxGallery::getOptions()
JuiceboxGallery::getJavascriptVars in src/JuiceboxGallery.php
Get the variables needed to instantiate a new JS Juicebox.
JuiceboxGallery::renderXml in src/JuiceboxGallery.php
Render the XML for Juicebox gallery once images and options are added.

File

src/JuiceboxGallery.php, line 187

Class

JuiceboxGallery
Class to generate the script and markup for a Juicebox gallery.

Namespace

Drupal\juicebox

Code

public function getOptions($filtered = FALSE) {
  $options = $this->options;

  // If we are not returning the raw input data we need to apply any output
  // processing that may be specified in the object configuration.
  if ($filtered) {
    $options = !empty($this->settings['process_attributes']) ? $this
      ->processAttributes($options) : $options;
  }
  return $options;
}