interface CommentStorageInterface in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/comment/src/CommentStorageInterface.php \Drupal\comment\CommentStorageInterface
Defines an interface for comment entity storage classes.
Hierarchy
- interface \Drupal\Core\Entity\EntityStorageInterface
- interface \Drupal\Core\Entity\ContentEntityStorageInterface
- interface \Drupal\comment\CommentStorageInterface
- interface \Drupal\Core\Entity\ContentEntityStorageInterface
Expanded class hierarchy of CommentStorageInterface
All classes that implement CommentStorageInterface
3 files declare their use of CommentStorageInterface
- CommentAdminOverview.php in core/
modules/ comment/ src/ Form/ CommentAdminOverview.php - Contains \Drupal\comment\Form\CommentAdminOverview.
- ConfirmDeleteMultiple.php in core/
modules/ comment/ src/ Form/ ConfirmDeleteMultiple.php - Contains \Drupal\comment\Form\ConfirmDeleteMultiple.
- UnapprovedComments.php in core/
modules/ comment/ src/ Plugin/ Menu/ LocalTask/ UnapprovedComments.php - Contains \Drupal\comment\Plugin\Menu\LocalTask\UnapprovedComments.
File
- core/
modules/ comment/ src/ CommentStorageInterface.php, line 17 - Contains \Drupal\comment\CommentStorageInterface.
Namespace
Drupal\commentView source
interface CommentStorageInterface extends ContentEntityStorageInterface {
/**
* Gets the maximum encoded thread value for the top level comments.
*
* @param \Drupal\comment\CommentInterface $comment
* A comment entity.
*
* @return string
* The maximum encoded thread value among the top level comments of the
* node $comment belongs to.
*/
public function getMaxThread(CommentInterface $comment);
/**
* Gets the maximum encoded thread value for the children of this comment.
*
* @param \Drupal\comment\CommentInterface $comment
* A comment entity.
*
* @return string
* The maximum encoded thread value among all replies of $comment.
*/
public function getMaxThreadPerThread(CommentInterface $comment);
/**
* Calculates the page number for the first new comment.
*
* @param int $total_comments
* The total number of comments that the entity has.
* @param int $new_comments
* The number of new comments that the entity has.
* @param \Drupal\Core\Entity\FieldableEntityInterface $entity
* The entity to which the comments belong.
* @param string $field_name
* The field name on the entity to which comments are attached.
*
* @return array|null
* The page number where first new comment appears. (First page returns 0.)
*/
public function getNewCommentPageNumber($total_comments, $new_comments, FieldableEntityInterface $entity, $field_name);
/**
* Gets the display ordinal or page number for a comment.
*
* @param \Drupal\comment\CommentInterface $comment
* The comment to use as a reference point.
* @param int $comment_mode
* The comment display mode: CommentManagerInterface::COMMENT_MODE_FLAT or
* CommentManagerInterface::COMMENT_MODE_THREADED.
* @param int $divisor
* Defaults to 1, which returns the display ordinal for a comment. If the
* number of comments per page is provided, the returned value will be the
* page number. (The return value will be divided by $divisor.)
*
* @return int
* The display ordinal or page number for the comment. It is 0-based, so
* will represent the number of items before the given comment/page.
*/
public function getDisplayOrdinal(CommentInterface $comment, $comment_mode, $divisor = 1);
/**
* Gets the comment ids of the passed comment entities' children.
*
* @param \Drupal\comment\CommentInterface[] $comments
* An array of comment entities keyed by their ids.
* @return array
* The entity ids of the passed comment entities' children as an array.
*/
public function getChildCids(array $comments);
/**
* Retrieves comments for a thread, sorted in an order suitable for display.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose comment(s) needs rendering.
* @param string $field_name
* The field_name whose comment(s) needs rendering.
* @param int $mode
* The comment display mode: CommentManagerInterface::COMMENT_MODE_FLAT or
* CommentManagerInterface::COMMENT_MODE_THREADED.
* @param int $comments_per_page
* (optional) The amount of comments to display per page.
* Defaults to 0, which means show all comments.
* @param int $pager_id
* (optional) Pager id to use in case of multiple pagers on the one page.
* Defaults to 0; is only used when $comments_per_page is greater than zero.
*
* @return array
* Ordered array of comment objects, keyed by comment id.
*/
public function loadThread(EntityInterface $entity, $field_name, $mode, $comments_per_page = 0, $pager_id = 0);
/**
* Returns the number of unapproved comments.
*
* @return int
* The number of unapproved comments.
*/
public function getUnapprovedCount();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommentStorageInterface:: |
public | function | Gets the comment ids of the passed comment entities' children. | 1 |
CommentStorageInterface:: |
public | function | Gets the display ordinal or page number for a comment. | 1 |
CommentStorageInterface:: |
public | function | Gets the maximum encoded thread value for the top level comments. | 1 |
CommentStorageInterface:: |
public | function | Gets the maximum encoded thread value for the children of this comment. | 1 |
CommentStorageInterface:: |
public | function | Calculates the page number for the first new comment. | 1 |
CommentStorageInterface:: |
public | function | Returns the number of unapproved comments. | 1 |
CommentStorageInterface:: |
public | function | Retrieves comments for a thread, sorted in an order suitable for display. | 1 |
ContentEntityStorageInterface:: |
public | function | Constructs a new entity translation object, without permanently saving it. | 2 |
EntityStorageInterface:: |
public | function | Constructs a new entity object, without permanently saving it. | 1 |
EntityStorageInterface:: |
public | function | Deletes permanently saved entities. | 1 |
EntityStorageInterface:: |
public | function | Delete a specific entity revision. | 3 |
EntityStorageInterface:: |
constant | Load the most recent version of an entity's field data. | ||
EntityStorageInterface:: |
constant | Load the version of an entity's field data specified in the entity. | ||
EntityStorageInterface:: |
public | function | Gets an aggregated query instance. | 1 |
EntityStorageInterface:: |
public | function | Gets the entity type definition. | 1 |
EntityStorageInterface:: |
public | function | Gets the entity type ID. | 1 |
EntityStorageInterface:: |
public | function | Gets an entity query instance. | 1 |
EntityStorageInterface:: |
public | function | Loads one entity. | 1 |
EntityStorageInterface:: |
public | function | Load entities by their property values. | 1 |
EntityStorageInterface:: |
public | function | Loads one or more entities. | 1 |
EntityStorageInterface:: |
public | function | Load a specific entity revision. | 3 |
EntityStorageInterface:: |
public | function | Loads an unchanged entity from the database. | 1 |
EntityStorageInterface:: |
public | function | Resets the internal, static entity cache. | 1 |
EntityStorageInterface:: |
public | function | Saves the entity permanently. | 1 |