interface PhotosImageInterface in Album Photos 6.0.x
Same name and namespace in other branches
- 8.5 src/PhotosImageInterface.php \Drupal\photos\PhotosImageInterface
Provides an interface defining a photos image entity.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface; interface \Drupal\Core\Entity\RevisionLogInterface; interface \Drupal\Core\Entity\EntityPublishedInterface
- interface \Drupal\photos\PhotosImageInterface
Expanded class hierarchy of PhotosImageInterface
All classes that implement PhotosImageInterface
3 files declare their use of PhotosImageInterface
- photos.module in ./
photos.module - Implementation of photos.module.
- PhotosEditController.php in src/
Controller/ PhotosEditController.php - PhotosImage.php in src/
Entity/ PhotosImage.php
File
- src/
PhotosImageInterface.php, line 14
Namespace
Drupal\photosView source
interface PhotosImageInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, RevisionLogInterface, EntityPublishedInterface {
/**
* Denotes that the image is not published.
*/
const NOT_PUBLISHED = 0;
/**
* Denotes that the image is published.
*/
const PUBLISHED = 1;
/**
* Gets the image file ids.
*
* @return array
* The image file ids.
*/
public function getFids();
/**
* Gets the image title.
*
* @return string
* Title of the image.
*/
public function getTitle();
/**
* Sets the image title.
*
* @param string $title
* The image title.
*
* @return $this
* The called image entity.
*/
public function setTitle($title);
/**
* Gets the image description.
*
* @return string
* The image description.
*/
public function getDescription();
/**
* Sets the image description.
*
* @param string $description
* The image description.
*
* @return $this
* The called image entity.
*/
public function setDescription($description);
/**
* Gets the text format name for the image description.
*
* @return string
* The text format name.
*/
public function getFormat();
/**
* Sets the text format name for the image description.
*
* @param string $format
* The text format name.
*
* @return $this
* The called image entity.
*/
public function setFormat($format);
/**
* Gets the image album id.
*
* @return int
* The image album id.
*/
public function getAlbumId();
/**
* Sets the image album id.
*
* @param int $albumId
* The image album id.
*
* @return $this
* The called image entity.
*/
public function setAlbumId($albumId);
/**
* Gets the album url.
*
* @return \Drupal\Core\Url
* The album url.
*/
public function getAlbumUrl();
/**
* Gets the image weight.
*
* @return int
* Weight of the image for custom sort order.
*/
public function getWeight();
/**
* Sets the image weight for custom sorting.
*
* @param int $weight
* The image weight.
*
* @return $this
* The called image entity.
*/
public function setWeight($weight);
/**
* Gets the image creation timestamp.
*
* @return int
* Creation timestamp of the image.
*/
public function getCreatedTime();
/**
* Sets the image creation timestamp.
*
* @param int $timestamp
* The image creation timestamp.
*
* @return $this
* The called image entity.
*/
public function setCreatedTime($timestamp);
/**
* Gets the page for this image.
*
* @param int $id
* The pager id: album_id or uid.
* @param string $type
* The type of pager: album_id or uid.
*
* @return array
* The photos image pager data or render array.
*/
public function getPager($id, $type);
/**
* Gets the image revision creation timestamp.
*
* @return int
* The UNIX timestamp of when this revision was created.
*/
public function getRevisionCreationTime();
/**
* Sets the image revision creation timestamp.
*
* @param int $timestamp
* The UNIX timestamp of when this revision was created.
*
* @return $this
* The called image entity.
*/
public function setRevisionCreationTime($timestamp);
}
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 |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
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 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 | 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 entity UUID (Universally Unique Identifier). | 2 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user ID. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user ID. | 1 |
EntityPublishedInterface:: |
public | function | Returns whether or not the entity is published. | |
EntityPublishedInterface:: |
public | function | Sets the entity as published. | |
EntityPublishedInterface:: |
public | function | Sets the entity as unpublished. | |
FieldableEntityInterface:: |
public static | function | Provides base field definitions for an entity type. | 2 |
FieldableEntityInterface:: |
public static | function | Provides field definitions for a specific bundle. | 2 |
FieldableEntityInterface:: |
public | function | Gets a field item list. | 1 |
FieldableEntityInterface:: |
public | function | Gets the definition of a contained field. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field definitions of all contained fields. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of all field item lists. | 1 |
FieldableEntityInterface:: |
public | function | Gets an array of field item lists for translatable fields. | 1 |
FieldableEntityInterface:: |
public | function | Determines whether the entity has a field with the given name. | 1 |
FieldableEntityInterface:: |
public | function | Checks whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function | Reacts to changes to a field. | 1 |
FieldableEntityInterface:: |
public | function | Sets a field value. | 1 |
FieldableEntityInterface:: |
public | function | Sets whether entity validation is required before saving the entity. | 1 |
FieldableEntityInterface:: |
public | function |
Gets an array of all field values. Overrides EntityInterface:: |
|
FieldableEntityInterface:: |
public | function | Validates the currently set values. | 1 |
PhotosImageInterface:: |
public | function | Gets the image album id. | 1 |
PhotosImageInterface:: |
public | function | Gets the album url. | 1 |
PhotosImageInterface:: |
public | function | Gets the image creation timestamp. | 1 |
PhotosImageInterface:: |
public | function | Gets the image description. | 1 |
PhotosImageInterface:: |
public | function | Gets the image file ids. | 1 |
PhotosImageInterface:: |
public | function | Gets the text format name for the image description. | 1 |
PhotosImageInterface:: |
public | function | Gets the page for this image. | 1 |
PhotosImageInterface:: |
public | function |
Gets the image revision creation timestamp. Overrides RevisionLogInterface:: |
|
PhotosImageInterface:: |
public | function | Gets the image title. | 1 |
PhotosImageInterface:: |
public | function | Gets the image weight. | 1 |
PhotosImageInterface:: |
constant | Denotes that the image is not published. | ||
PhotosImageInterface:: |
constant | Denotes that the image is published. | ||
PhotosImageInterface:: |
public | function | Sets the image album id. | 1 |
PhotosImageInterface:: |
public | function | Sets the image creation timestamp. | 1 |
PhotosImageInterface:: |
public | function | Sets the image description. | 1 |
PhotosImageInterface:: |
public | function | Sets the text format name for the image description. | 1 |
PhotosImageInterface:: |
public | function |
Sets the image revision creation timestamp. Overrides RevisionLogInterface:: |
|
PhotosImageInterface:: |
public | function | Sets the image title. | 1 |
PhotosImageInterface:: |
public | function | Sets the image weight for custom sorting. | 1 |
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 |
RevisionableInterface:: |
public | function | Gets the loaded Revision ID of the entity. | 1 |
RevisionableInterface:: |
public | function | Gets the revision identifier of the entity. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the default revision. | 1 |
RevisionableInterface:: |
public | function | Checks if this entity is the latest revision. | 1 |
RevisionableInterface:: |
public | function | Determines whether a new revision should be created on save. | 1 |
RevisionableInterface:: |
public | function | Acts on a revision before it gets saved. | 1 |
RevisionableInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 1 |
RevisionableInterface:: |
public | function | Updates the loaded Revision ID with the revision ID. | 1 |
RevisionableInterface:: |
public | function | Checks whether the entity object was a default revision when it was saved. | 1 |
RevisionLogInterface:: |
public | function | Returns the entity revision log message. | |
RevisionLogInterface:: |
public | function | Gets the entity revision author. | |
RevisionLogInterface:: |
public | function | Gets the entity revision author ID. | |
RevisionLogInterface:: |
public | function | Sets the entity revision log message. | |
RevisionLogInterface:: |
public | function | Sets the entity revision author. | |
RevisionLogInterface:: |
public | function | Sets the entity revision author by ID. | |
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 |
TranslatableInterface:: |
public | function | Adds a new translation to the translatable object. | 1 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 1 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 1 |
TranslatableInterface:: |
public | function | Returns the translatable object referring to the original language. | 1 |
TranslatableInterface:: |
public | function | Checks there is a translation for the given language code. | 1 |
TranslatableInterface:: |
public | function | Determines if the current translation of the entity has unsaved changes. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is the default one. | 1 |
TranslatableInterface:: |
public | function | Checks whether the translation is new. | 1 |
TranslatableInterface:: |
public | function | Returns the translation support status. | 1 |
TranslatableInterface:: |
public | function | Removes the translation identified by the given language code. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if untranslatable fields should affect only the default translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether this is the latest revision affecting this translation. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks whether the current translation is affected by the current revision. | 1 |
TranslatableRevisionableInterface:: |
public | function | Checks if the revision translation affected flag value has been enforced. | 1 |
TranslatableRevisionableInterface:: |
public | function | Marks the current revision translation as affected. | 1 |
TranslatableRevisionableInterface:: |
public | function | Enforces the revision translation affected flag value. | 1 |