FlaggingStorageInterface.php in Flag 8.4
Namespace
Drupal\flag\Entity\StorageFile
src/Entity/Storage/FlaggingStorageInterface.phpView source
<?php
namespace Drupal\flag\Entity\Storage;
use Drupal\Core\Entity\ContentEntityStorageInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Session\AccountInterface;
/**
* Flagging storage.
*/
interface FlaggingStorageInterface extends ContentEntityStorageInterface {
/**
* Loads a list of flags the entity is flagged with for the given account.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to check.
* @param \Drupal\Core\Session\AccountInterface $account
* The user account to check for.
* @param string $session_id
* (optional) The session ID. This must be supplied if $account is the
* anonymous user.
*
* @return string[]
* A list of flag_ids that for which the given entity is flagged, either
* globally or for the given account.
*
* @throws \LogicException
* Thrown when $account is anonymous but no associated session ID is
* specified.
*/
public function loadIsFlagged(EntityInterface $entity, AccountInterface $account, $session_id = NULL);
/**
* Loads a list of flags the entities are flagged with for the given account.
*
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* The entities to check. All entities must be of the same type.
* @param \Drupal\Core\Session\AccountInterface $account
* The user account to check for.
* @param string $session_id
* (optional) The session ID. This must be supplied if $account is the
* anonymous user.
*
* @return string[][]
* A list of flag_ids that for which the given entity is flagged, either
* globally or for the given account. Keyed by the entity IDs.
*
* @throws \LogicException
* Thrown when $account is anonymous but no associated session ID is
* specified.
*/
public function loadIsFlaggedMultiple(array $entities, AccountInterface $account, $session_id = NULL);
}
Interfaces
Name![]() |
Description |
---|---|
FlaggingStorageInterface | Flagging storage. |