nextcloud/lib/public/comments/icomment.php

217 lines
4.0 KiB
PHP
Raw Normal View History

2015-11-10 19:44:26 +03:00
<?php
namespace OCP\Comments;
/**
* Interface IComment
*
2015-12-03 19:20:40 +03:00
* This class represents a comment
2015-11-10 19:44:26 +03:00
*
* @package OCP\Comments
* @since 9.0.0
*/
interface IComment {
/**
* returns the ID of the comment
*
* It may return an empty string, if the comment was not stored.
* It is expected that the concrete Comment implementation gives an ID
* by itself (e.g. after saving).
*
* @return string
* @since 9.0.0
*/
public function getId();
/**
* sets the ID of the comment and returns itself
*
* It is only allowed to set the ID only, if the current id is an empty
* string (which means it is not stored in a database, storage or whatever
* the concrete implementation does), or vice versa. Changing a given ID is
* not permitted and must result in an IllegalIDChangeException.
*
* @param string $id
* @return IComment
* @throws IllegalIDChangeException
* @since 9.0.0
*/
public function setId($id);
/**
* returns the parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getParentId();
/**
* sets the parent ID and returns itself
* @param string $parentId
* @return IComment
* @since 9.0.0
*/
public function setParentId($parentId);
/**
* returns the topmost parent ID of the comment
*
* @return string
* @since 9.0.0
*/
public function getTopmostParentId();
/**
* sets the topmost parent ID and returns itself
*
* @param string $id
* @return IComment
* @since 9.0.0
*/
public function setTopmostParentId($id);
2015-11-10 19:44:26 +03:00
/**
* returns the number of children
*
* @return int
* @since 9.0.0
*/
public function getChildrenCount();
/**
* sets the number of children
*
* @param int $count
* @return IComment
* @since 9.0.0
*/
public function setChildrenCount($count);
2015-11-10 19:44:26 +03:00
/**
* returns the message of the comment
*
* @return string
* @since 9.0.0
*/
public function getMessage();
/**
* sets the message of the comment and returns itself
*
* @param string $message
* @return IComment
* @since 9.0.0
*/
public function setMessage($message);
/**
* returns the verb of the comment
*
* @return string
* @since 9.0.0
*/
public function getVerb();
/**
* sets the verb of the comment, e.g. 'comment' or 'like'
*
* @param string $verb
* @return IComment
* @since 9.0.0
*/
public function setVerb($verb);
/**
* returns the actor type
*
* @return string
* @since 9.0.0
*/
public function getActorType();
/**
* returns the actor ID
*
* @return string
* @since 9.0.0
*/
public function getActorId();
/**
* sets (overwrites) the actor type and id
*
* @param string $actorType e.g. 'user'
* @param string $actorId e.g. 'zombie234'
* @return IComment
* @since 9.0.0
*/
public function setActor($actorType, $actorId);
/**
* returns the creation date of the comment.
2015-11-10 19:44:26 +03:00
*
* If not explicitly set, it shall default to the time of initialization.
2015-11-10 19:44:26 +03:00
*
* @return \DateTime
* @since 9.0.0
*/
public function getCreationDateTime();
2015-11-10 19:44:26 +03:00
/**
* sets the creation date of the comment and returns itself
2015-11-10 19:44:26 +03:00
*
* @param \DateTime $dateTime
2015-11-10 19:44:26 +03:00
* @return IComment
* @since 9.0.0
*/
public function setCreationDateTime(\DateTime $dateTime);
2015-11-10 19:44:26 +03:00
/**
* returns the date of the most recent child
2015-11-10 19:44:26 +03:00
*
* @return \DateTime
* @since 9.0.0
*/
public function getLatestChildDateTime();
/**
* sets the date of the most recent child
*
* @param \DateTime $dateTime
* @return IComment
2015-11-10 19:44:26 +03:00
* @since 9.0.0
*/
public function setLatestChildDateTime(\DateTime $dateTime);
2015-11-10 19:44:26 +03:00
/**
* returns the object type the comment is attached to
*
* @return string
* @since 9.0.0
*/
public function getObjectType();
/**
* returns the object id the comment is attached to
*
* @return string
* @since 9.0.0
*/
public function getObjectId();
/**
* sets (overwrites) the object of the comment
*
* @param string $objectType e.g. 'file'
* @param string $objectId e.g. '16435'
* @return IComment
* @since 9.0.0
*/
public function setObject($objectType, $objectId);
}