class RoyalSliderOptionSetEntity in RoyalSlider Integration 8

Defines a RoyalSliderOptionSet configuration entity class.

Plugin annotation


@ConfigEntityType(
  id = "royalslider_optionset",
  label = @Translation("RoyalSlider OptionSet"),
  handlers = {
    "list_builder" = "Drupal\royalslider\RoyalSliderOptionSetListBuilder",
    "form" = {
      "default" = "Drupal\royalslider\Form\RoyalSliderOptionSetForm",
      "add" = "Drupal\royalslider\Form\RoyalSliderOptionSetForm",
      "edit" = "Drupal\royalslider\Form\RoyalSliderOptionSetForm",
      "delete" = "Drupal\royalslider\Form\RoyalSliderOptionSetDeleteForm"
    }
  },
  config_prefix = "royalslider_optionset",
  admin_permission = "administer site configuration",
  entity_keys = {
    "id" = "id",
    "label" = "name"
  },
  links = {
    "collection" = "entity.royalslider_optionset.collection",
    "edit-form" = "entity.royalslider_optionset.edit_form",
    "delete-form" = "entity.royalslider_optionset.delete_form"
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\royalslider\Entity\RoyalSliderOptionSetEntity implements RoyalSliderOptionSetInterface

Expanded class hierarchy of RoyalSliderOptionSetEntity

1 file declares its use of RoyalSliderOptionSetEntity

OptionSetConfigSchemaTest.php in src/Tests/OptionSetConfigSchemaTest.php: Contains \Drupal\royalslider\Tests\OptionSetConfigSchemaTest.

File

src/Entity/RoyalSliderOptionSetEntity.php, line 40: Contains \Drupal\royalslider\Entity\RoyalSliderOptionSetEntity.

Namespace

Drupal\royalslider\Entity

View source

class RoyalSliderOptionSetEntity extends ConfigEntityBase implements RoyalSliderOptionSetInterface {

  /**
   * The ID of the rs optionset.
   *
   * @var string
   */
  public $id;

  /**
   * The rs optionset name.
   *
   * @var string
   */
  public $name;

  /**
   * The following options are the general options for the slider.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#options
   */

  /**
   * Automatically updates slider height based on base width.
   *
   * @var bool
   */
  public $auto_scale_slider = FALSE;

  /**
   * Base slider width.
   * Slider will autocalculate the ratio based on these values.
   *
   * @var int
   */
  public $auto_scale_slider_width = 800;

  /**
   * Base slider height.
   *
   * @var int
   */
  public $auto_scale_slider_height = 400;

  /**
   * Scale mode for images.
   *
   * @var string
   */
  public $image_scale_mode = 'fit-if-smaller';

  /**
   * Aligns image to center of slide.
   *
   * @var bool
   */
  public $image_align_center = TRUE;

  /**
   * Distance between image and edge of slide (doesn't work with 'fill' scale mode).
   *
   * @var int
   */
  public $image_scale_padding = 4;

  /**
   * Navigation type, can be 'bullets', 'thumbnails', 'tabs' or 'none'
   *
   * @var string
   */
  public $control_navigation = 'bullets';

  /**
   * Direction arrows navigation.
   *
   * @var bool
   */
  public $arrows_nav = TRUE;

  /**
   * Auto hide arrows.
   *
   * @var bool
   */
  public $arrows_nav_auto_hide = TRUE;

  /**
   * Hides arrows completely on touch devices.
   *
   * @var bool
   */
  public $arrows_nav_auto_hide_on_touch = FALSE;

  /**
   * Adds base width to all images for better-looking loading.
   *
   * @var int
   */
  public $img_width = NULL;

  /**
   * Adds base height to all images for better-looking loading.
   *
   * @var int
   */
  public $img_height = NULL;

  /**
   * Spacing between slides in pixels.
   *
   * @var int
   */
  public $slides_spacing = 8;

  /**
   * Start slide index.
   *
   * @var int
   */
  public $start_slide_id = 0;

  /**
   * Makes slider to go from last slide to first.
   *
   * @var bool
   */
  public $loop = FALSE;

  /**
   * Makes slider to go from last slide to first with rewind. Overrides prev option.
   *
   * @var bool
   */
  public $loop_rewind = FALSE;

  /**
   * Randomizes all slides at start.
   *
   * @var bool
   */
  public $randomize_slides = FALSE;

  /**
   * Number of slides to preload on sides.
   *
   * @var int
   */
  public $num_images_to_preload = 4;

  /**
   * Enables spinning preloader.
   *
   * @var bool
   */
  public $use_preloader = TRUE;

  /**
   * Slides orientation: can be 'vertical' or 'horizontal'.
   *
   * @var string
   */
  public $slides_orientation = 'horizontal';

  /**
   * Transition type: 'move' or 'fade'.
   *
   * @var string
   */
  public $transition_type = 'move';

  /**
   * Slider transition speed, in ms.
   *
   * @var int
   */
  public $transition_speed = 600;

  /**
   * Easing function for simple transition.
   *
   * @var string
   */
  public $ease_in_out = 'easeInOutSine';

  /**
   * Easing function of animation after ending of the swipe gesture.
   *
   * @var string
   */
  public $ease_out = 'easeOutSine';

  /**
   * If set to TRUE adds arrows and fullscreen button inside rsOverflow container,
   * otherwise inside root slider container.
   *
   * @var bool
   */
  public $controls_inside = TRUE;

  /**
   * Navigates forward by clicking on slide.
   *
   * @var bool
   */
  public $navigate_by_click = TRUE;

  /**
   * Mouse drag navigation over slider.
   *
   * @var bool
   */
  public $slider_drag = TRUE;

  /**
   * Touch navigation of slider.
   *
   * @var bool
   */
  public $slider_touch = TRUE;

  /**
   * Navigate slider with keyboard left and right arrows.
   *
   * @var bool
   */
  public $keyboard_nav_enabled = FALSE;

  /**
   * Fades in slide after it's loaded.
   *
   * @var bool
   */
  public $fadein_loaded_slide = TRUE;

  /**
   * Allows usage of CSS3 transitions.
   *
   * @var bool
   */
  public $allow_css3 = TRUE;

  /**
   * Adds global caption element to slider.
   *
   * @var bool
   */
  public $global_caption = FALSE;

  /**
   * Adds rsActiveSlide class to current slide before transition.
   *
   * @var bool
   */
  public $add_active_class = FALSE;

  /**
   * Minimum distance in pixels to show next slide while dragging.
   *
   * @var int
   */
  public $min_slide_offset = 10;

  /**
   * Scales and animates height based on current slide.
   *
   * @var bool
   */
  public $auto_height = FALSE;

  /**
   * Overrides HTML of slides,
   * used for creating of slides from HTML that is not attached to DOM.
   *
   * @var string
   */
  public $slides = NULL;

  /**
   * The following options are part of the 'Thumbnails & tabs' settings.
   *
   * The properties are prefixed with thumbs.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#thumbnails
   */

  /**
   * Thumbnails mouse drag.
   *
   * @var bool
   */
  public $thumbs_drag = TRUE;

  /**
   * Thumbnails touch.
   *
   * @var bool
   */
  public $thumbs_touch = TRUE;

  /**
   * Thumbnail orientation: 'horizontal' or 'vertical'.
   *
   * @var string
   */
  public $thumbs_orientation = 'horizontal';

  /**
   * Thumbnails arrows.
   *
   * @var bool
   */
  public $thumbs_arrows = TRUE;

  /**
   * Spacing between thumbs.
   *
   * @var int
   */
  public $thumbs_spacing = 4;

  /**
   * Auto hide thumbnails arrows on hover.
   *
   * @var bool
   */
  public $thumbs_arrows_auto_hide = FALSE;

  /**
   * Automatically centers container with thumbs if there are small number of items.
   *
   * @var bool
   */
  public $thumbs_auto_center = TRUE;

  /**
   * Thumbnails transition speed.
   *
   * @var int
   */
  public $thumbs_transition_speed = 600;

  /**
   * Reduces size of main viewport area by thumbnails width or height,
   * use it when you set 100% width to slider.
   *
   * @var bool
   */
  public $thumbs_fit_in_viewport = TRUE;

  /**
   * Margin that equals thumbs spacing for first and last item.
   *
   * @var bool
   */
  public $thumbs_first_margin = TRUE;

  /**
   * Replaces default thumbnail arrow.
   * Variable accepts jQuery element $('This is left arrow') that will be used as arrow.
   * You have to add it to DOM manually.
   *
   * @var string
   */
  public $thumbs_arrow_left = NULL;

  /**
   * Replaces default thumbnail arrow.
   * Variable accepts jQuery element $('This is right arrow') that will be used as arrow.
   * You have to add it to DOM manually.
   *
   * @var string
   */
  public $thumbs_arrow_right = NULL;

  /**
   * Adds span element with class thumbIco to every thumbnail.
   *
   * @var bool
   */
  public $thumbs_append_span = FALSE;

  /**
   * The following options are part of the 'Fullscreen' settings.
   *
   * The properties are prefixed with fullscreen_.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#fullscreen
   */

  /**
   * Fullscreen functions enabled.
   *
   * @var bool
   */
  public $fullscreen_enabled = FALSE;

  /**
   * Force keyboard arrows nav in fullscreen.
   *
   * @var bool
   */
  public $fullscreen_keyboard_nav = TRUE;

  /**
   * Fullscreen button at top right.
   *
   * @var bool
   */
  public $fullscreen_button_fs = TRUE;

  /**
   * Native browser fullscreen.
   *
   * @var bool
   */
  public $fullscreen_native_fs = FALSE;

  /**
   * The following options are part of the 'Deep linking' settings.
   *
   * The properties are prefixed with deep_linking.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#deeplinking
   */

  /**
   * Linking to slides by appending #SLIDE_INDEX to url.
   *
   * @var bool
   */
  public $deep_linking_enabled = FALSE;

  /**
   * Automatically change URL after transition and listen for hash change.
   *
   * @var bool
   */
  public $deep_linking_change = FALSE;

  /**
   * Prefix that will be added to hash.
   *
   * @var string
   */
  public $deep_linking_prefix = '';

  /**
   * The following options are part of the 'Autoplay' settings.
   *
   * The properties are prefixed with autplay.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#autoplay
   */

  /**
   * Enable autoplay or not.
   *
   * @var bool
   */
  public $autoplay_enabled = FALSE;

  /**
   * Stop autoplay at first user action.
   *
   * @var bool
   */
  public $autoplay_stop_at_action = TRUE;

  /**
   * Pause autoplay on hover.
   *
   * @var bool
   */
  public $autoplay_pause_on_hover = TRUE;

  /**
   * Delay between items in ms.
   *
   * @var int
   */
  public $autoplay_delay = 3000;

  /**
   * The following options are part of the 'Video' settings.
   *
   * The properties are prefixed with video.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#video
   */

  /**
   * Auto hide arrows when video is playing.
   *
   * @var bool
   */
  public $video_auto_hide_arrows = TRUE;

  /**
   * Auto hide navigation when video is playing.
   *
   * @var bool
   */
  public $video_auto_hide_control_nav = FALSE;

  /**
   * Auto hide animated blocks when video is playing.
   *
   * @var bool
   */
  public $video_auto_hide_blocks = FALSE;

  /**
   * Youtube embed code. %id% is replaced by video id.
   *
   * @var string
   */
  public $video_youtube_code = '<iframe src="http://www.youtube.com/embed/%id%?rel=1&autoplay=1&showinfo=0" frameborder="no"></iframe>';

  /**
   * Vimeo embed code. %id% is replaced by video id.
   *
   * @var string
   */
  public $video_vimeo_code = '<iframe src="http://player.vimeo.com/video/%id%?byline=0&amp;portrait=0&amp;autoplay=1" frameborder="no" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>';

  /**
   * The following options are part of the 'Animated blocks' settings.
   *
   * The properties are prefixed with animated.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#animated-blocks
   */

  /**
   * Adds a fade effect when transitioning between slides.
   *
   * @var bool
   */
  public $animated_fade_effect = TRUE;

  /**
   * Move effect direction. Can be 'left', 'right', 'top', 'bottom' or 'none'.
   *
   * @var string
   */
  public $animated_move_effect = 'top';

  /**
   * Distance for move effect in pixels.
   *
   * @var int
   */
  public $animated_move_offset = 20;

  /**
   * Transition speed of block, in ms.
   *
   * @var int
   */
  public $animated_speed = 400;

  /**
   * Easing function of block animation.
   *
   * @var string
   */
  public $animated_easing = 'easeOutSine';

  /**
   * Delay between each block show up, in ms.
   *
   * @var int
   */
  public $animated_delay = 200;

  /**
   * The following options are part of the 'Visible-nearby' settings.
   *
   * The properties are prefixed with visible_nearby_.
   *
   * @see http://dimsemenov.com/plugins/royal-slider/documentation/#visible-nearby
   */

  /**
   * Enable visible-nearby.
   *
   * @var bool
   */
  public $visible_nearby_enabled = TRUE;

  /**
   * Ratio that determines area of center image.
   *
   * @var float
   */
  public $visible_nearby_center_area = 0.6;

  /**
   * Alignment of center image, if you set it to false center image will be aligned to left.
   *
   * @var bool
   */
  public $visible_nearby_center = TRUE;

  /**
   * Used for responsive design.
   * Changes centerArea value to breakpointCenterArea when width of slider is
   * less then value in this option. Set to 0 to disable. Should be number.
   *
   * @var int
   */
  public $visible_nearby_breakpoint = 0;

  /**
   * Same as centerArea option, just for breakpoint.
   *
   * @var float
   */
  public $visible_nearby_breakpoint_center_area = 0.8;

  /**
   * Build the javascript array from an optionset.
   */
  public function buildJsOptionSet() {
    $js_array = [
      'autoScaleSlider' => $this->auto_scale_slider,
      'autoScaleSliderWidth' => $this->auto_scale_slider_width,
      'autoScaleSliderHeight' => $this->auto_scale_slider_height,
      'loop' => $this->loop,
    ];

    // Remove the values that are set to the default value.
    foreach ($js_array as $key => $value) {
      if ($this
        ->getOptionDefault($key) == $value) {
        unset($js_array[$key]);
      }
    }
    return $js_array;
  }
  private function getOptionDefault($key) {
    $defaults = [
      // General.
      'manuallyInit' => (bool) FALSE,
      'loop' => (bool) FALSE,
      'loopRewind' => (bool) FALSE,
      'randomizeSlides' => (bool) FALSE,
      'usePreloader' => (bool) TRUE,
      'numImagesToPreload' => 4,
      'slidesOrientation' => 'horizontal',
      'globalCaption' => FALSE,
      // Full Screen.
      'fullscreen' => array(
        'enabled' => FALSE,
        'keyboardNav' => TRUE,
        'buttonFS' => TRUE,
        'nativeFS' => FALSE,
      ),
      // Navigation.
      'controlNavigation' => 'bullets',
      'controlsInside' => TRUE,
      'sliderDrag' => TRUE,
      'sliderTouch' => TRUE,
      'keyboardNavEnabled' => FALSE,
      'navigateByClick' => TRUE,
      'arrowsNav' => TRUE,
      'arrowsNavAutoHide' => TRUE,
      'arrowsNavHideOnTouch' => FALSE,
      // Thumbnails.
      'thumbs' => array(
        'drag' => TRUE,
        'touch' => TRUE,
        'orientation' => 'horizontal',
        'arrows' => TRUE,
        'spacing' => 4,
        'arrowsAutoHide' => FALSE,
        'autoCenter' => TRUE,
        'transitionSpeed' => 600,
        'fitInViewport' => TRUE,
        'firstMargin' => TRUE,
        'arrowLeft' => NULL,
        'arrowRight' => NULL,
        'appendSpan' => FALSE,
      ),
      // Transitions.
      'transitionType' => 'move',
      'transitionSpeed' => 600,
      'easeInOut' => 'easeInOutSine',
      'easeOut' => 'easeOutSine',
      'allowCSS3' => TRUE,
      // Note: that since only 3 easing methods are available
      // in CSS3 by default with RoyalSlider and we'd have to implement the rest
      // ourselves, it's probably best to set this to FALSE in most Option Sets.
      // However, in order to maintain compatibility with the RoyalSlider API
      // we're leaving this be.
      'addActiveClass' => FALSE,
      'fadeinLoadedSlide' => TRUE,
      // Dimensions.
      'autoScaleSlider' => FALSE,
      'autoScaleSliderWidth' => 800,
      'autoScaleSliderHeight' => 400,
      'autoHeight' => FALSE,
      'imageScaleMode' => 'fit-if-smaller',
      'imageScalePadding' => 4,
      'imageAlignCenter' => TRUE,
      'imgWidth' => NULL,
      'imgHeight' => NULL,
      'slidesSpacing' => 8,
      // Autoplay
      'autoplay' => array(
        'enabled' => FALSE,
        'stopAtAction' => TRUE,
        'pauseOnHover' => TRUE,
        'delay' => 300,
      ),
      // Visible Nearby
      'visibleNearby' => array(
        'enabled' => TRUE,
        'centerArea' => 0.6,
        'center' => TRUE,
        'navigateByCenterClick' => TRUE,
        'breakpoint' => 0,
        'breakpointCenterArea' => 0.8,
      ),
      // Deep linking
      'deeplinking' => array(
        'enabled' => FALSE,
        'change' => FALSE,
        'prefix' => '',
      ),
      // Video
      'video' => array(
        'autoHideArrows' => TRUE,
        'autoHideControlNav' => FALSE,
        'autoHideBlocks' => FALSE,
        'youTubeCode' => '<iframe src="http://www.youtube.com/embed/%id%?rel=1&autoplay=1&showinfo=0" frameborder="no"></iframe>',
        'vimeoCode' => '<iframe src="http://player.vimeo.com/video/%id%?byline=0&amp;portrait=0&amp;autoplay=1" frameborder="no" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>',
      ),
      // Drupal-specific.
      'drupalAutoSetSliderDimensions' => FALSE,
      'drupalAutoSetImageDimensions' => TRUE,
    ];
    return $defaults[$key];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	4
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	13
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
RoyalSliderOptionSetEntity::$add_active_class	public	property	Adds rsActiveSlide class to current slide before transition.
RoyalSliderOptionSetEntity::$allow_css3	public	property	Allows usage of CSS3 transitions.
RoyalSliderOptionSetEntity::$animated_delay	public	property	Delay between each block show up, in ms.
RoyalSliderOptionSetEntity::$animated_easing	public	property	Easing function of block animation.
RoyalSliderOptionSetEntity::$animated_fade_effect	public	property	Adds a fade effect when transitioning between slides.
RoyalSliderOptionSetEntity::$animated_move_effect	public	property	Move effect direction. Can be 'left', 'right', 'top', 'bottom' or 'none'.
RoyalSliderOptionSetEntity::$animated_move_offset	public	property	Distance for move effect in pixels.
RoyalSliderOptionSetEntity::$animated_speed	public	property	Transition speed of block, in ms.
RoyalSliderOptionSetEntity::$arrows_nav	public	property	Direction arrows navigation.
RoyalSliderOptionSetEntity::$arrows_nav_auto_hide	public	property	Auto hide arrows.
RoyalSliderOptionSetEntity::$arrows_nav_auto_hide_on_touch	public	property	Hides arrows completely on touch devices.
RoyalSliderOptionSetEntity::$autoplay_delay	public	property	Delay between items in ms.
RoyalSliderOptionSetEntity::$autoplay_enabled	public	property	Enable autoplay or not.
RoyalSliderOptionSetEntity::$autoplay_pause_on_hover	public	property	Pause autoplay on hover.
RoyalSliderOptionSetEntity::$autoplay_stop_at_action	public	property	Stop autoplay at first user action.
RoyalSliderOptionSetEntity::$auto_height	public	property	Scales and animates height based on current slide.
RoyalSliderOptionSetEntity::$auto_scale_slider	public	property	Automatically updates slider height based on base width.
RoyalSliderOptionSetEntity::$auto_scale_slider_height	public	property	Base slider height.
RoyalSliderOptionSetEntity::$auto_scale_slider_width	public	property	Base slider width. Slider will autocalculate the ratio based on these values.
RoyalSliderOptionSetEntity::$controls_inside	public	property	If set to TRUE adds arrows and fullscreen button inside rsOverflow container, otherwise inside root slider container.
RoyalSliderOptionSetEntity::$control_navigation	public	property	Navigation type, can be 'bullets', 'thumbnails', 'tabs' or 'none'
RoyalSliderOptionSetEntity::$deep_linking_change	public	property	Automatically change URL after transition and listen for hash change.
RoyalSliderOptionSetEntity::$deep_linking_enabled	public	property	Linking to slides by appending #SLIDE_INDEX to url.
RoyalSliderOptionSetEntity::$deep_linking_prefix	public	property	Prefix that will be added to hash.
RoyalSliderOptionSetEntity::$ease_in_out	public	property	Easing function for simple transition.
RoyalSliderOptionSetEntity::$ease_out	public	property	Easing function of animation after ending of the swipe gesture.
RoyalSliderOptionSetEntity::$fadein_loaded_slide	public	property	Fades in slide after it's loaded.
RoyalSliderOptionSetEntity::$fullscreen_button_fs	public	property	Fullscreen button at top right.
RoyalSliderOptionSetEntity::$fullscreen_enabled	public	property	Fullscreen functions enabled.
RoyalSliderOptionSetEntity::$fullscreen_keyboard_nav	public	property	Force keyboard arrows nav in fullscreen.
RoyalSliderOptionSetEntity::$fullscreen_native_fs	public	property	Native browser fullscreen.
RoyalSliderOptionSetEntity::$global_caption	public	property	Adds global caption element to slider.
RoyalSliderOptionSetEntity::$id	public	property	The ID of the rs optionset.
RoyalSliderOptionSetEntity::$image_align_center	public	property	Aligns image to center of slide.
RoyalSliderOptionSetEntity::$image_scale_mode	public	property	Scale mode for images.
RoyalSliderOptionSetEntity::$image_scale_padding	public	property	Distance between image and edge of slide (doesn't work with 'fill' scale mode).
RoyalSliderOptionSetEntity::$img_height	public	property	Adds base height to all images for better-looking loading.
RoyalSliderOptionSetEntity::$img_width	public	property	Adds base width to all images for better-looking loading.
RoyalSliderOptionSetEntity::$keyboard_nav_enabled	public	property	Navigate slider with keyboard left and right arrows.
RoyalSliderOptionSetEntity::$loop	public	property	Makes slider to go from last slide to first.
RoyalSliderOptionSetEntity::$loop_rewind	public	property	Makes slider to go from last slide to first with rewind. Overrides prev option.
RoyalSliderOptionSetEntity::$min_slide_offset	public	property	Minimum distance in pixels to show next slide while dragging.
RoyalSliderOptionSetEntity::$name	public	property	The rs optionset name.
RoyalSliderOptionSetEntity::$navigate_by_click	public	property	Navigates forward by clicking on slide.
RoyalSliderOptionSetEntity::$num_images_to_preload	public	property	Number of slides to preload on sides.
RoyalSliderOptionSetEntity::$randomize_slides	public	property	Randomizes all slides at start.
RoyalSliderOptionSetEntity::$slider_drag	public	property	Mouse drag navigation over slider.
RoyalSliderOptionSetEntity::$slider_touch	public	property	Touch navigation of slider.
RoyalSliderOptionSetEntity::$slides	public	property	Overrides HTML of slides, used for creating of slides from HTML that is not attached to DOM.
RoyalSliderOptionSetEntity::$slides_orientation	public	property	Slides orientation: can be 'vertical' or 'horizontal'.
RoyalSliderOptionSetEntity::$slides_spacing	public	property	Spacing between slides in pixels.
RoyalSliderOptionSetEntity::$start_slide_id	public	property	Start slide index.
RoyalSliderOptionSetEntity::$thumbs_append_span	public	property	Adds span element with class thumbIco to every thumbnail.
RoyalSliderOptionSetEntity::$thumbs_arrows	public	property	Thumbnails arrows.
RoyalSliderOptionSetEntity::$thumbs_arrows_auto_hide	public	property	Auto hide thumbnails arrows on hover.
RoyalSliderOptionSetEntity::$thumbs_arrow_left	public	property	Replaces default thumbnail arrow. Variable accepts jQuery element $('This is left arrow') that will be used as arrow. You have to add it to DOM manually.
RoyalSliderOptionSetEntity::$thumbs_arrow_right	public	property	Replaces default thumbnail arrow. Variable accepts jQuery element $('This is right arrow') that will be used as arrow. You have to add it to DOM manually.
RoyalSliderOptionSetEntity::$thumbs_auto_center	public	property	Automatically centers container with thumbs if there are small number of items.
RoyalSliderOptionSetEntity::$thumbs_drag	public	property	Thumbnails mouse drag.
RoyalSliderOptionSetEntity::$thumbs_first_margin	public	property	Margin that equals thumbs spacing for first and last item.
RoyalSliderOptionSetEntity::$thumbs_fit_in_viewport	public	property	Reduces size of main viewport area by thumbnails width or height, use it when you set 100% width to slider.
RoyalSliderOptionSetEntity::$thumbs_orientation	public	property	Thumbnail orientation: 'horizontal' or 'vertical'.
RoyalSliderOptionSetEntity::$thumbs_spacing	public	property	Spacing between thumbs.
RoyalSliderOptionSetEntity::$thumbs_touch	public	property	Thumbnails touch.
RoyalSliderOptionSetEntity::$thumbs_transition_speed	public	property	Thumbnails transition speed.
RoyalSliderOptionSetEntity::$transition_speed	public	property	Slider transition speed, in ms.
RoyalSliderOptionSetEntity::$transition_type	public	property	Transition type: 'move' or 'fade'.
RoyalSliderOptionSetEntity::$use_preloader	public	property	Enables spinning preloader.
RoyalSliderOptionSetEntity::$video_auto_hide_arrows	public	property	Auto hide arrows when video is playing.
RoyalSliderOptionSetEntity::$video_auto_hide_blocks	public	property	Auto hide animated blocks when video is playing.
RoyalSliderOptionSetEntity::$video_auto_hide_control_nav	public	property	Auto hide navigation when video is playing.
RoyalSliderOptionSetEntity::$video_vimeo_code	public	property	Vimeo embed code. %id% is replaced by video id.
RoyalSliderOptionSetEntity::$video_youtube_code	public	property	Youtube embed code. %id% is replaced by video id.
RoyalSliderOptionSetEntity::$visible_nearby_breakpoint	public	property	Used for responsive design. Changes centerArea value to breakpointCenterArea when width of slider is less then value in this option. Set to 0 to disable. Should be number.
RoyalSliderOptionSetEntity::$visible_nearby_breakpoint_center_area	public	property	Same as centerArea option, just for breakpoint.
RoyalSliderOptionSetEntity::$visible_nearby_center	public	property	Alignment of center image, if you set it to false center image will be aligned to left.
RoyalSliderOptionSetEntity::$visible_nearby_center_area	public	property	Ratio that determines area of center image.
RoyalSliderOptionSetEntity::$visible_nearby_enabled	public	property	Enable visible-nearby.
RoyalSliderOptionSetEntity::buildJsOptionSet	public	function	Build the javascript array from an optionset.
RoyalSliderOptionSetEntity::getOptionDefault	private	function
RoyalSliderOptionSetInterface::buildJsOptionset	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class RoyalSliderOptionSetEntity in RoyalSlider Integration 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation