nextcloud / server

apps/comments/lib/Activity/Provider.php

Indentation +241 added lines, -241 removed lines

@@ -36,245 +36,245 @@
 
 class Provider implements IProvider {
 
-	/** @var IFactory */
-	protected $languageFactory;
-
-	/** @var IL10N */
-	protected $l;
-
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var ICommentsManager */
-	protected $commentsManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IManager */
-	protected $activityManager;
-
-	/** @var string[] */
-	protected $displayNames = [];
-
-	/**
-	 * @param IFactory $languageFactory
-	 * @param IURLGenerator $url
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IManager $activityManager
-	 */
-	public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
-		$this->languageFactory = $languageFactory;
-		$this->url = $url;
-		$this->commentsManager = $commentsManager;
-		$this->userManager = $userManager;
-		$this->activityManager = $activityManager;
-	}
-
-	/**
-	 * @param string $language
-	 * @param IEvent $event
-	 * @param IEvent|null $previousEvent
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 * @since 11.0.0
-	 */
-	public function parse($language, IEvent $event, IEvent $previousEvent = null) {
-		if ($event->getApp() !== 'comments') {
-			throw new \InvalidArgumentException();
-		}
-
-		$this->l = $this->languageFactory->get('comments', $language);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			$this->parseMessage($event);
-			if ($this->activityManager->getRequirePNG()) {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
-			} else {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
-			}
-
-			if ($this->activityManager->isFormattingFilteredObject()) {
-				try {
-					return $this->parseShortVersion($event);
-				} catch (\InvalidArgumentException $e) {
-					// Ignore and simply use the long version...
-				}
-			}
-
-			return $this->parseLongVersion($event);
-		} else {
-			throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseShortVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented'))
-					->setRichSubject($this->l->t('You commented'), []);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
-					->setRichSubject($this->l->t('{author} commented'), [
-						'author' => $author,
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseLongVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented on %1$s', [
-						$subjectParameters['filePath'],
-					]))
-					->setRichSubject($this->l->t('You commented on {file}'), [
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
-						$author['name'],
-						$subjectParameters['filePath'],
-					]))
-					->setRichSubject($this->l->t('{author} commented on {file}'), [
-						'author' => $author,
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	protected function getSubjectParameters(IEvent $event) {
-		$subjectParameters = $event->getSubjectParameters();
-		if (isset($subjectParameters['fileId'])) {
-			return $subjectParameters;
-		}
-
-		// Fix subjects from 12.0.3 and older
-		//
-		// Do NOT Remove unless necessary
-		// Removing this will break parsing of activities that were created on
-		// Nextcloud 12, so we should keep this as long as it's acceptable.
-		// Otherwise if people upgrade over multiple releases in a short period,
-		// they will get the dead entries in their stream.
-		return [
-			'actor' => $subjectParameters[0],
-			'fileId' => (int) $event->getObjectId(),
-			'filePath' => trim($subjectParameters[1], '/'),
-		];
-	}
-
-	/**
-	 * @param IEvent $event
-	 */
-	protected function parseMessage(IEvent $event) {
-		$messageParameters = $event->getMessageParameters();
-		if (empty($messageParameters)) {
-			// Email
-			return;
-		}
-
-		$commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
-
-		try {
-			$comment = $this->commentsManager->get((string) $commentId);
-			$message = $comment->getMessage();
-			$message = str_replace("\n", '<br />', str_replace(['<', '>'], ['&lt;', '&gt;'], $message));
-
-			$mentionCount = 1;
-			$mentions = [];
-			foreach ($comment->getMentions() as $mention) {
-				if ($mention['type'] !== 'user') {
-					continue;
-				}
-
-				$pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
-				if (strpos($mention['id'], ' ') !== false) {
-					$pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
-				}
-
-				$message = preg_replace(
-					$pattern,
-					//'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
-					'${1}' . '{mention' . $mentionCount . '}' . '${3}',
-					$message
-				);
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
-				$mentionCount++;
-			}
-
-			$event->setParsedMessage($comment->getMessage())
-				->setRichMessage($message, $mentions);
-		} catch (NotFoundException $e) {
-		}
-	}
-
-	/**
-	 * @param int $id
-	 * @param string $path
-	 * @return array
-	 */
-	protected function generateFileParameter($id, $path) {
-		return [
-			'type' => 'file',
-			'id' => $id,
-			'name' => basename($path),
-			'path' => $path,
-			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return array
-	 */
-	protected function generateUserParameter($uid) {
-		if (!isset($this->displayNames[$uid])) {
-			$this->displayNames[$uid] = $this->getDisplayName($uid);
-		}
-
-		return [
-			'type' => 'user',
-			'id' => $uid,
-			'name' => $this->displayNames[$uid],
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function getDisplayName($uid) {
-		$user = $this->userManager->get($uid);
-		if ($user instanceof IUser) {
-			return $user->getDisplayName();
-		} else {
-			return $uid;
-		}
-	}
+    /** @var IFactory */
+    protected $languageFactory;
+
+    /** @var IL10N */
+    protected $l;
+
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var ICommentsManager */
+    protected $commentsManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IManager */
+    protected $activityManager;
+
+    /** @var string[] */
+    protected $displayNames = [];
+
+    /**
+     * @param IFactory $languageFactory
+     * @param IURLGenerator $url
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IManager $activityManager
+     */
+    public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
+        $this->languageFactory = $languageFactory;
+        $this->url = $url;
+        $this->commentsManager = $commentsManager;
+        $this->userManager = $userManager;
+        $this->activityManager = $activityManager;
+    }
+
+    /**
+     * @param string $language
+     * @param IEvent $event
+     * @param IEvent|null $previousEvent
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     * @since 11.0.0
+     */
+    public function parse($language, IEvent $event, IEvent $previousEvent = null) {
+        if ($event->getApp() !== 'comments') {
+            throw new \InvalidArgumentException();
+        }
+
+        $this->l = $this->languageFactory->get('comments', $language);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            $this->parseMessage($event);
+            if ($this->activityManager->getRequirePNG()) {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
+            } else {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
+            }
+
+            if ($this->activityManager->isFormattingFilteredObject()) {
+                try {
+                    return $this->parseShortVersion($event);
+                } catch (\InvalidArgumentException $e) {
+                    // Ignore and simply use the long version...
+                }
+            }
+
+            return $this->parseLongVersion($event);
+        } else {
+            throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseShortVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented'))
+                    ->setRichSubject($this->l->t('You commented'), []);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
+                    ->setRichSubject($this->l->t('{author} commented'), [
+                        'author' => $author,
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseLongVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented on %1$s', [
+                        $subjectParameters['filePath'],
+                    ]))
+                    ->setRichSubject($this->l->t('You commented on {file}'), [
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
+                        $author['name'],
+                        $subjectParameters['filePath'],
+                    ]))
+                    ->setRichSubject($this->l->t('{author} commented on {file}'), [
+                        'author' => $author,
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    protected function getSubjectParameters(IEvent $event) {
+        $subjectParameters = $event->getSubjectParameters();
+        if (isset($subjectParameters['fileId'])) {
+            return $subjectParameters;
+        }
+
+        // Fix subjects from 12.0.3 and older
+        //
+        // Do NOT Remove unless necessary
+        // Removing this will break parsing of activities that were created on
+        // Nextcloud 12, so we should keep this as long as it's acceptable.
+        // Otherwise if people upgrade over multiple releases in a short period,
+        // they will get the dead entries in their stream.
+        return [
+            'actor' => $subjectParameters[0],
+            'fileId' => (int) $event->getObjectId(),
+            'filePath' => trim($subjectParameters[1], '/'),
+        ];
+    }
+
+    /**
+     * @param IEvent $event
+     */
+    protected function parseMessage(IEvent $event) {
+        $messageParameters = $event->getMessageParameters();
+        if (empty($messageParameters)) {
+            // Email
+            return;
+        }
+
+        $commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
+
+        try {
+            $comment = $this->commentsManager->get((string) $commentId);
+            $message = $comment->getMessage();
+            $message = str_replace("\n", '<br />', str_replace(['<', '>'], ['&lt;', '&gt;'], $message));
+
+            $mentionCount = 1;
+            $mentions = [];
+            foreach ($comment->getMentions() as $mention) {
+                if ($mention['type'] !== 'user') {
+                    continue;
+                }
+
+                $pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
+                if (strpos($mention['id'], ' ') !== false) {
+                    $pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
+                }
+
+                $message = preg_replace(
+                    $pattern,
+                    //'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
+                    '${1}' . '{mention' . $mentionCount . '}' . '${3}',
+                    $message
+                );
+                $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+                $mentionCount++;
+            }
+
+            $event->setParsedMessage($comment->getMessage())
+                ->setRichMessage($message, $mentions);
+        } catch (NotFoundException $e) {
+        }
+    }
+
+    /**
+     * @param int $id
+     * @param string $path
+     * @return array
+     */
+    protected function generateFileParameter($id, $path) {
+        return [
+            'type' => 'file',
+            'id' => $id,
+            'name' => basename($path),
+            'path' => $path,
+            'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return array
+     */
+    protected function generateUserParameter($uid) {
+        if (!isset($this->displayNames[$uid])) {
+            $this->displayNames[$uid] = $this->getDisplayName($uid);
+        }
+
+        return [
+            'type' => 'user',
+            'id' => $uid,
+            'name' => $this->displayNames[$uid],
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return string
+     */
+    protected function getDisplayName($uid) {
+        $user = $this->userManager->get($uid);
+        if ($user instanceof IUser) {
+            return $user->getDisplayName();
+        } else {
+            return $uid;
+        }
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -213,18 +213,18 @@
 					continue;
 				}
 
-				$pattern = '/(^|\s)(' . '@' . $mention['id'] . ')(\b)/';
+				$pattern = '/(^|\s)('.'@'.$mention['id'].')(\b)/';
 				if (strpos($mention['id'], ' ') !== false) {
-					$pattern = '/(^|\s)(' . '@"' . $mention['id'] . '"' . ')(\b)?/';
+					$pattern = '/(^|\s)('.'@"'.$mention['id'].'"'.')(\b)?/';
 				}
 
 				$message = preg_replace(
 					$pattern,
 					//'${1}' . $this->regexSafeUser($mention['id'], $displayName) . '${3}',
-					'${1}' . '{mention' . $mentionCount . '}' . '${3}',
+					'${1}'.'{mention'.$mentionCount.'}'.'${3}',
 					$message
 				);
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+				$mentions['mention'.$mentionCount] = $this->generateUserParameter($mention['id']);
 				$mentionCount++;
 			}
 

lib/private/Comments/Comment.php

Indentation +385 added lines, -385 removed lines

@@ -30,389 +30,389 @@
 
 class Comment implements IComment {
 
-	protected $data = [
-		'id'              => '',
-		'parentId'        => '0',
-		'topmostParentId' => '0',
-		'childrenCount'   => '0',
-		'message'         => '',
-		'verb'            => '',
-		'actorType'       => '',
-		'actorId'         => '',
-		'objectType'      => '',
-		'objectId'        => '',
-		'creationDT'      => null,
-		'latestChildDT'   => null,
-	];
-
-	/**
-	 * Comment constructor.
-	 *
-	 * @param array $data	optional, array with keys according to column names from
-	 * 						the comments database scheme
-	 */
-	public function __construct(array $data = null) {
-		if(is_array($data)) {
-			$this->fromArray($data);
-		}
-	}
-
-	/**
-	 * 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() {
-		return $this->data['id'];
-	}
-
-	/**
-	 * 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) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-
-		$id = trim($id);
-		if($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
-			$this->data['id'] = $id;
-			return $this;
-		}
-
-		throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
-	}
-
-	/**
-	 * returns the parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParentId() {
-		return $this->data['parentId'];
-	}
-
-	/**
-	 * sets the parent ID and returns itself
-	 *
-	 * @param string $parentId
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setParentId($parentId) {
-		if(!is_string($parentId)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['parentId'] = trim($parentId);
-		return $this;
-	}
-
-	/**
-	 * returns the topmost parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTopmostParentId() {
-		return $this->data['topmostParentId'];
-	}
-
-
-	/**
-	 * sets the topmost parent ID and returns itself
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setTopmostParentId($id) {
-		if(!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['topmostParentId'] = trim($id);
-		return $this;
-	}
-
-	/**
-	 * returns the number of children
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getChildrenCount() {
-		return $this->data['childrenCount'];
-	}
-
-	/**
-	 * sets the number of children
-	 *
-	 * @param int $count
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setChildrenCount($count) {
-		if(!is_int($count)) {
-			throw new \InvalidArgumentException('Integer expected.');
-		}
-		$this->data['childrenCount'] = $count;
-		return $this;
-	}
-
-	/**
-	 * returns the message of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage() {
-		return $this->data['message'];
-	}
-
-	/**
-	 * sets the message of the comment and returns itself
-	 *
-	 * @param string $message
-	 * @return IComment
-	 * @throws MessageTooLongException
-	 * @since 9.0.0
-	 */
-	public function setMessage($message) {
-		if(!is_string($message)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$message = trim($message);
-		if(mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
-			throw new MessageTooLongException('Comment message must not exceed ' . IComment::MAX_MESSAGE_LENGTH . ' characters');
-		}
-		$this->data['message'] = $message;
-		return $this;
-	}
-
-	/**
-	 * returns an array containing mentions that are included in the comment
-	 *
-	 * @return array each mention provides a 'type' and an 'id', see example below
-	 * @since 11.0.0
-	 *
-	 * The return array looks like:
-	 * [
-	 *   [
-	 *     'type' => 'user',
-	 *     'id' => 'citizen4'
-	 *   ],
-	 *   [
-	 *     'type' => 'group',
-	 *     'id' => 'media'
-	 *   ],
-	 *   …
-	 * ]
-	 *
-	 */
-	public function getMentions() {
-		$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
-		if(!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
-			return [];
-		}
-		$uids = array_unique($mentions[0]);
-		$result = [];
-		foreach ($uids as $uid) {
-			$result[] = ['type' => 'user', 'id' => trim(substr($uid, 1), '"')];
-		}
-		return $result;
-	}
-
-	/**
-	 * returns the verb of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getVerb() {
-		return $this->data['verb'];
-	}
-
-	/**
-	 * sets the verb of the comment, e.g. 'comment' or 'like'
-	 *
-	 * @param string $verb
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setVerb($verb) {
-		if(!is_string($verb) || !trim($verb)) {
-			throw new \InvalidArgumentException('Non-empty String expected.');
-		}
-		$this->data['verb'] = trim($verb);
-		return $this;
-	}
-
-	/**
-	 * returns the actor type
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorType() {
-		return $this->data['actorType'];
-	}
-
-	/**
-	 * returns the actor ID
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorId() {
-		return $this->data['actorId'];
-	}
-
-	/**
-	 * sets (overwrites) the actor type and id
-	 *
-	 * @param string $actorType e.g. 'users'
-	 * @param string $actorId e.g. 'zombie234'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setActor($actorType, $actorId) {
-		if(
-		       !is_string($actorType) || !trim($actorType)
-		    || !is_string($actorId)   || !trim($actorId)
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['actorType'] = trim($actorType);
-		$this->data['actorId']   = trim($actorId);
-		return $this;
-	}
-
-	/**
-	 * returns the creation date of the comment.
-	 *
-	 * If not explicitly set, it shall default to the time of initialization.
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getCreationDateTime() {
-		return $this->data['creationDT'];
-	}
-
-	/**
-	 * sets the creation date of the comment and returns itself
-	 *
-	 * @param \DateTime $timestamp
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setCreationDateTime(\DateTime $timestamp) {
-		$this->data['creationDT'] = $timestamp;
-		return $this;
-	}
-
-	/**
-	 * returns the DateTime of the most recent child, if set, otherwise null
-	 *
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getLatestChildDateTime() {
-		return $this->data['latestChildDT'];
-	}
-
-	/**
-	 * sets the date of the most recent child
-	 *
-	 * @param \DateTime $dateTime
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setLatestChildDateTime(\DateTime $dateTime = null) {
-		$this->data['latestChildDT'] = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * returns the object type the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType() {
-		return $this->data['objectType'];
-	}
-
-	/**
-	 * returns the object id the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId() {
-		return $this->data['objectId'];
-	}
-
-	/**
-	 * sets (overwrites) the object of the comment
-	 *
-	 * @param string $objectType e.g. 'files'
-	 * @param string $objectId e.g. '16435'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setObject($objectType, $objectId) {
-		if(
-		       !is_string($objectType) || !trim($objectType)
-		    || !is_string($objectId)   || !trim($objectId)
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['objectType'] = trim($objectType);
-		$this->data['objectId']   = trim($objectId);
-		return $this;
-	}
-
-	/**
-	 * sets the comment data based on an array with keys as taken from the
-	 * database.
-	 *
-	 * @param array $data
-	 * @return IComment
-	 */
-	protected function fromArray($data) {
-		foreach(array_keys($data) as $key) {
-			// translate DB keys to internal setter names
-			$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
-			$setter = str_replace('Timestamp', 'DateTime', $setter);
-
-			if(method_exists($this, $setter)) {
-				$this->$setter($data[$key]);
-			}
-		}
-
-		foreach(['actor', 'object'] as $role) {
-			if(isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
-				$setter = 'set' . ucfirst($role);
-				$this->$setter($data[$role . '_type'], $data[$role . '_id']);
-			}
-		}
-
-		return $this;
-	}
+    protected $data = [
+        'id'              => '',
+        'parentId'        => '0',
+        'topmostParentId' => '0',
+        'childrenCount'   => '0',
+        'message'         => '',
+        'verb'            => '',
+        'actorType'       => '',
+        'actorId'         => '',
+        'objectType'      => '',
+        'objectId'        => '',
+        'creationDT'      => null,
+        'latestChildDT'   => null,
+    ];
+
+    /**
+     * Comment constructor.
+     *
+     * @param array $data	optional, array with keys according to column names from
+     * 						the comments database scheme
+     */
+    public function __construct(array $data = null) {
+        if(is_array($data)) {
+            $this->fromArray($data);
+        }
+    }
+
+    /**
+     * 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() {
+        return $this->data['id'];
+    }
+
+    /**
+     * 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) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+
+        $id = trim($id);
+        if($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
+            $this->data['id'] = $id;
+            return $this;
+        }
+
+        throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
+    }
+
+    /**
+     * returns the parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParentId() {
+        return $this->data['parentId'];
+    }
+
+    /**
+     * sets the parent ID and returns itself
+     *
+     * @param string $parentId
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setParentId($parentId) {
+        if(!is_string($parentId)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['parentId'] = trim($parentId);
+        return $this;
+    }
+
+    /**
+     * returns the topmost parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTopmostParentId() {
+        return $this->data['topmostParentId'];
+    }
+
+
+    /**
+     * sets the topmost parent ID and returns itself
+     *
+     * @param string $id
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setTopmostParentId($id) {
+        if(!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['topmostParentId'] = trim($id);
+        return $this;
+    }
+
+    /**
+     * returns the number of children
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getChildrenCount() {
+        return $this->data['childrenCount'];
+    }
+
+    /**
+     * sets the number of children
+     *
+     * @param int $count
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setChildrenCount($count) {
+        if(!is_int($count)) {
+            throw new \InvalidArgumentException('Integer expected.');
+        }
+        $this->data['childrenCount'] = $count;
+        return $this;
+    }
+
+    /**
+     * returns the message of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage() {
+        return $this->data['message'];
+    }
+
+    /**
+     * sets the message of the comment and returns itself
+     *
+     * @param string $message
+     * @return IComment
+     * @throws MessageTooLongException
+     * @since 9.0.0
+     */
+    public function setMessage($message) {
+        if(!is_string($message)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $message = trim($message);
+        if(mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
+            throw new MessageTooLongException('Comment message must not exceed ' . IComment::MAX_MESSAGE_LENGTH . ' characters');
+        }
+        $this->data['message'] = $message;
+        return $this;
+    }
+
+    /**
+     * returns an array containing mentions that are included in the comment
+     *
+     * @return array each mention provides a 'type' and an 'id', see example below
+     * @since 11.0.0
+     *
+     * The return array looks like:
+     * [
+     *   [
+     *     'type' => 'user',
+     *     'id' => 'citizen4'
+     *   ],
+     *   [
+     *     'type' => 'group',
+     *     'id' => 'media'
+     *   ],
+     *   …
+     * ]
+     *
+     */
+    public function getMentions() {
+        $ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
+        if(!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
+            return [];
+        }
+        $uids = array_unique($mentions[0]);
+        $result = [];
+        foreach ($uids as $uid) {
+            $result[] = ['type' => 'user', 'id' => trim(substr($uid, 1), '"')];
+        }
+        return $result;
+    }
+
+    /**
+     * returns the verb of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getVerb() {
+        return $this->data['verb'];
+    }
+
+    /**
+     * sets the verb of the comment, e.g. 'comment' or 'like'
+     *
+     * @param string $verb
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setVerb($verb) {
+        if(!is_string($verb) || !trim($verb)) {
+            throw new \InvalidArgumentException('Non-empty String expected.');
+        }
+        $this->data['verb'] = trim($verb);
+        return $this;
+    }
+
+    /**
+     * returns the actor type
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorType() {
+        return $this->data['actorType'];
+    }
+
+    /**
+     * returns the actor ID
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorId() {
+        return $this->data['actorId'];
+    }
+
+    /**
+     * sets (overwrites) the actor type and id
+     *
+     * @param string $actorType e.g. 'users'
+     * @param string $actorId e.g. 'zombie234'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setActor($actorType, $actorId) {
+        if(
+                !is_string($actorType) || !trim($actorType)
+            || !is_string($actorId)   || !trim($actorId)
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['actorType'] = trim($actorType);
+        $this->data['actorId']   = trim($actorId);
+        return $this;
+    }
+
+    /**
+     * returns the creation date of the comment.
+     *
+     * If not explicitly set, it shall default to the time of initialization.
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getCreationDateTime() {
+        return $this->data['creationDT'];
+    }
+
+    /**
+     * sets the creation date of the comment and returns itself
+     *
+     * @param \DateTime $timestamp
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setCreationDateTime(\DateTime $timestamp) {
+        $this->data['creationDT'] = $timestamp;
+        return $this;
+    }
+
+    /**
+     * returns the DateTime of the most recent child, if set, otherwise null
+     *
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getLatestChildDateTime() {
+        return $this->data['latestChildDT'];
+    }
+
+    /**
+     * sets the date of the most recent child
+     *
+     * @param \DateTime $dateTime
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setLatestChildDateTime(\DateTime $dateTime = null) {
+        $this->data['latestChildDT'] = $dateTime;
+        return $this;
+    }
+
+    /**
+     * returns the object type the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType() {
+        return $this->data['objectType'];
+    }
+
+    /**
+     * returns the object id the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId() {
+        return $this->data['objectId'];
+    }
+
+    /**
+     * sets (overwrites) the object of the comment
+     *
+     * @param string $objectType e.g. 'files'
+     * @param string $objectId e.g. '16435'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setObject($objectType, $objectId) {
+        if(
+                !is_string($objectType) || !trim($objectType)
+            || !is_string($objectId)   || !trim($objectId)
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['objectType'] = trim($objectType);
+        $this->data['objectId']   = trim($objectId);
+        return $this;
+    }
+
+    /**
+     * sets the comment data based on an array with keys as taken from the
+     * database.
+     *
+     * @param array $data
+     * @return IComment
+     */
+    protected function fromArray($data) {
+        foreach(array_keys($data) as $key) {
+            // translate DB keys to internal setter names
+            $setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
+            $setter = str_replace('Timestamp', 'DateTime', $setter);
+
+            if(method_exists($this, $setter)) {
+                $this->$setter($data[$key]);
+            }
+        }
+
+        foreach(['actor', 'object'] as $role) {
+            if(isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
+                $setter = 'set' . ucfirst($role);
+                $this->$setter($data[$role . '_type'], $data[$role . '_id']);
+            }
+        }
+
+        return $this;
+    }
 }

Spacing +22 added lines, -22 removed lines

@@ -52,7 +52,7 @@ 
 	 * 						the comments database scheme
 	 */
 	public function __construct(array $data = null) {
-		if(is_array($data)) {
+		if (is_array($data)) {
 			$this->fromArray($data);
 		}
 	}
@@ -85,12 +85,12 @@ 
 	 * @since 9.0.0
 	 */
 	public function setId($id) {
-		if(!is_string($id)) {
+		if (!is_string($id)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
 
 		$id = trim($id);
-		if($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
+		if ($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
 			$this->data['id'] = $id;
 			return $this;
 		}
@@ -116,7 +116,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function setParentId($parentId) {
-		if(!is_string($parentId)) {
+		if (!is_string($parentId)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
 		$this->data['parentId'] = trim($parentId);
@@ -142,7 +142,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function setTopmostParentId($id) {
-		if(!is_string($id)) {
+		if (!is_string($id)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
 		$this->data['topmostParentId'] = trim($id);
@@ -167,7 +167,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function setChildrenCount($count) {
-		if(!is_int($count)) {
+		if (!is_int($count)) {
 			throw new \InvalidArgumentException('Integer expected.');
 		}
 		$this->data['childrenCount'] = $count;
@@ -193,12 +193,12 @@ 
 	 * @since 9.0.0
 	 */
 	public function setMessage($message) {
-		if(!is_string($message)) {
+		if (!is_string($message)) {
 			throw new \InvalidArgumentException('String expected.');
 		}
 		$message = trim($message);
-		if(mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
-			throw new MessageTooLongException('Comment message must not exceed ' . IComment::MAX_MESSAGE_LENGTH . ' characters');
+		if (mb_strlen($message, 'UTF-8') > IComment::MAX_MESSAGE_LENGTH) {
+			throw new MessageTooLongException('Comment message must not exceed '.IComment::MAX_MESSAGE_LENGTH.' characters');
 		}
 		$this->data['message'] = $message;
 		return $this;
@@ -226,7 +226,7 @@ 
 	 */
 	public function getMentions() {
 		$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
-		if(!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
+		if (!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
 			return [];
 		}
 		$uids = array_unique($mentions[0]);
@@ -255,7 +255,7 @@ 
 	 * @since 9.0.0
 	 */
 	public function setVerb($verb) {
-		if(!is_string($verb) || !trim($verb)) {
+		if (!is_string($verb) || !trim($verb)) {
 			throw new \InvalidArgumentException('Non-empty String expected.');
 		}
 		$this->data['verb'] = trim($verb);
@@ -291,9 +291,9 @@ 
 	 * @since 9.0.0
 	 */
 	public function setActor($actorType, $actorId) {
-		if(
+		if (
 		       !is_string($actorType) || !trim($actorType)
-		    || !is_string($actorId)   || !trim($actorId)
+		    || !is_string($actorId) || !trim($actorId)
 		) {
 			throw new \InvalidArgumentException('String expected.');
 		}
@@ -377,9 +377,9 @@ 
 	 * @since 9.0.0
 	 */
 	public function setObject($objectType, $objectId) {
-		if(
+		if (
 		       !is_string($objectType) || !trim($objectType)
-		    || !is_string($objectId)   || !trim($objectId)
+		    || !is_string($objectId) || !trim($objectId)
 		) {
 			throw new \InvalidArgumentException('String expected.');
 		}
@@ -396,20 +396,20 @@ 
 	 * @return IComment
 	 */
 	protected function fromArray($data) {
-		foreach(array_keys($data) as $key) {
+		foreach (array_keys($data) as $key) {
 			// translate DB keys to internal setter names
-			$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
+			$setter = 'set'.implode('', array_map('ucfirst', explode('_', $key)));
 			$setter = str_replace('Timestamp', 'DateTime', $setter);
 
-			if(method_exists($this, $setter)) {
+			if (method_exists($this, $setter)) {
 				$this->$setter($data[$key]);
 			}
 		}
 
-		foreach(['actor', 'object'] as $role) {
-			if(isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
-				$setter = 'set' . ucfirst($role);
-				$this->$setter($data[$role . '_type'], $data[$role . '_id']);
+		foreach (['actor', 'object'] as $role) {
+			if (isset($data[$role.'_type']) && isset($data[$role.'_id'])) {
+				$setter = 'set'.ucfirst($role);
+				$this->$setter($data[$role.'_type'], $data[$role.'_id']);
 			}
 		}