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

Getter method for the gallery options.

Parameters

boolean $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 includes/JuiceboxGallery.inc

Get the variables needed to instantiate a new JS Juicebox. These values can be used as direct constructor inputs for a new juicebox object.

JuiceboxGallery::renderXml in includes/JuiceboxGallery.inc

Render the XML for a Juicebox gallery once images and options have been added.

File

includes/JuiceboxGallery.inc, line 172

A php-only set of methods to create the script and markup components of a Juicebox gallery.

Class

JuiceboxGallery

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

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;
}