You are here

interface FileMetadataManagerInterface in File metadata manager 8

Same name and namespace in other branches
  1. 8.2 src/FileMetadataManagerInterface.php \Drupal\file_mdm\FileMetadataManagerInterface

Provides an interface for file metadata manager objects.

Hierarchy

Expanded class hierarchy of FileMetadataManagerInterface

All classes that implement FileMetadataManagerInterface

File

src/FileMetadataManagerInterface.php, line 8

Namespace

Drupal\file_mdm
View source
interface FileMetadataManagerInterface {

  /**
   * Determines if the URI is currently in use by the manager.
   *
   * @param string $uri
   *   The URI to a file.
   *
   * @return bool
   *   TRUE if the URI is in use, FALSE otherwise.
   */
  public function has($uri);

  /**
   * Returns a FileMetadata object for the URI, creating it if necessary.
   *
   * @param string $uri
   *   The URI to a file.
   *
   * @return \Drupal\file_mdm\FileMetadataInterface|null
   *   The FileMetadata object for the specified URI.
   */
  public function uri($uri);

  /**
   * Deletes the all the cached metadata for the URI.
   *
   * @param string $uri
   *   The URI to a file.
   *
   * @return bool
   *   TRUE if the cached metadata was removed, FALSE in case of error.
   */
  public function deleteCachedMetadata($uri);

  /**
   * Releases the FileMetadata object for the URI.
   *
   * @param string $uri
   *   The URI to a file.
   *
   * @return bool
   *   TRUE if the FileMetadata for the URI was removed from the manager,
   *   FALSE otherwise.
   */
  public function release($uri);

  /**
   * Returns the count of FileMetadata objects currently in use.
   *
   * @return int
   *   The number of FileMetadata objects currently in use.
   */
  public function count();

}

Members

Namesort descending Modifiers Type Description Overrides
FileMetadataManagerInterface::count public function Returns the count of FileMetadata objects currently in use. 1
FileMetadataManagerInterface::deleteCachedMetadata public function Deletes the all the cached metadata for the URI. 1
FileMetadataManagerInterface::has public function Determines if the URI is currently in use by the manager. 1
FileMetadataManagerInterface::release public function Releases the FileMetadata object for the URI. 1
FileMetadataManagerInterface::uri public function Returns a FileMetadata object for the URI, creating it if necessary. 1