interface SlickInterface in Slick Carousel 8
Same name and namespace in other branches
- 8.2 src/Entity/SlickInterface.php \Drupal\slick\Entity\SlickInterface
- 7.3 src/Entity/SlickInterface.php \Drupal\slick\Entity\SlickInterface
Provides an interface defining a Slick entity.
Hierarchy
- interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
- interface \Drupal\slick\Entity\SlickInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
Expanded class hierarchy of SlickInterface
All classes that implement SlickInterface
File
- src/
Entity/ SlickInterface.php, line 10
Namespace
Drupal\slick\EntityView source
interface SlickInterface extends ConfigEntityInterface {
/**
* Returns the number of breakpoints.
*
* @return int
* The number of the provided breakpoints.
*/
public function getBreakpoints();
/**
* Returns the Slick skin.
*
* @return string
* The name of the Slick skin.
*/
public function getSkin();
/**
* Returns the Slick options by group, or property.
*
* @param string $group
* The name of setting group: settings, responsives.
* @param string $property
* The name of specific property: prevArrow, nexArrow.
*
* @return mixed|array|null
* Available options by $group, $property, all, or NULL.
*/
public function getOptions($group = NULL, $property = NULL);
/**
* Returns the array of slick settings.
*
* @return array
* The array of settings.
*/
public function getSettings();
/**
* Sets the array of slick settings.
*
* @param array $settings
* The new array of settings.
*
* @return $this
* The class instance that this method is called on.
*/
public function setSettings(array $settings = []);
/**
* Returns the value of a slick setting.
*
* @param string $setting_name
* The setting name.
*
* @return mixed
* The setting value.
*/
public function getSetting($setting_name);
/**
* Sets the value of a slick setting.
*
* @param string $setting_name
* The setting name.
* @param string $value
* The setting value.
*
* @return $this
* The class instance that this method is called on.
*/
public function setSetting($setting_name, $value);
/**
* Returns available slick default options under group 'settings'.
*
* @param string $group
* The name of group: settings, responsives.
*
* @return array
* The default settings under options.
*/
public static function defaultSettings($group = 'settings');
/**
* Returns the group this optioset instance belongs to for easy selections.
*
* @return string
* The name of the optionset group.
*/
public function getGroup();
/**
* Returns whether to optimize the stored options, or not.
*
* @return bool
* If true, the stored options will be cleaned out from defaults.
*/
public function optimized();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 9 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 27 |
ConfigEntityInterface:: |
public | function | Calculates dependencies and stores them in the dependency property. | 2 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Gets the configuration dependencies. | 2 |
ConfigEntityInterface:: |
public | function | Gets whether on not the data is trusted. | 2 |
ConfigEntityInterface:: |
public | function | Checks whether this entity is installable. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether this entity is being changed during the uninstall process. | 2 |
ConfigEntityInterface:: |
public | function | Informs the entity that entities it depends on will be deleted. | 2 |
ConfigEntityInterface:: |
public | function | Sets the value of a property. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
ConfigEntityInterface:: |
public | function | Sets that the data should be trusted. | 2 |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 2 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 2 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 2 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity type definition. | 2 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface:: |
public | function | Gets the original ID. | 2 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface:: |
public | function | Gets the identifier. | 2 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 2 |
EntityInterface:: |
public | function | Gets the label of the entity. | 2 |
EntityInterface:: |
public | function | Gets the language of the entity. | 2 |
EntityInterface:: |
public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface:: |
public static | function | Loads an entity. | 2 |
EntityInterface:: |
public static | function | Loads one or more entities. | 2 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 3 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 2 |
EntityInterface:: |
public | function | Sets the original ID. | 2 |
EntityInterface:: |
public | function | Gets an array of all property values. | 3 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface:: |
public | function | Gets the public URL for this entity. | 2 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 2 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
SlickInterface:: |
public static | function | Returns available slick default options under group 'settings'. | 1 |
SlickInterface:: |
public | function | Returns the number of breakpoints. | 1 |
SlickInterface:: |
public | function | Returns the group this optioset instance belongs to for easy selections. | 1 |
SlickInterface:: |
public | function | Returns the Slick options by group, or property. | 1 |
SlickInterface:: |
public | function | Returns the value of a slick setting. | 1 |
SlickInterface:: |
public | function | Returns the array of slick settings. | 1 |
SlickInterface:: |
public | function | Returns the Slick skin. | 1 |
SlickInterface:: |
public | function | Returns whether to optimize the stored options, or not. | 1 |
SlickInterface:: |
public | function | Sets the value of a slick setting. | 1 |
SlickInterface:: |
public | function | Sets the array of slick settings. | 1 |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | 1 |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | 1 |
ThirdPartySettingsInterface:: |
public | function | Gets the list of third parties that store information. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Gets all third-party settings of a given module. | 5 |
ThirdPartySettingsInterface:: |
public | function | Sets the value of a third-party setting. | 5 |
ThirdPartySettingsInterface:: |
public | function | Unsets a third-party setting. | 5 |