engine/classes/ElggComment.php

Rama 7.x · réplica de lectura del repositorio original.

<?php
/**
 * \ElggComment
 *
 * @property int $level       depth of the comment (default 1 = top level)
 * @property int $parent_guid direct parent of the comment
 * @property int $thread_guid reference to the top comment
 *
 * @since 1.9.0
 */
class ElggComment extends \ElggObject {
	
	/**
	 * Set subtype to comment
	 *
	 * @return void
	 */
	protected function initializeAttributes() {
		parent::initializeAttributes();

		$this->attributes['subtype'] = 'comment';
		
		$this->level = 1;
	}
	
	/**
	 * {@inheritdoc}
	 */
	protected function persistentDelete(bool $recursive = true): bool {
		$result = parent::persistentDelete($recursive);
		
		if ($result) {
			$this->deleteThreadedComments($recursive, true);
		}
		
		return $result;
	}
	
	/**
	 * {@inheritdoc}
	 */
	protected function trash(bool $recursive = true): bool {
		$result = parent::trash($recursive);
		
		if ($result) {
			$this->deleteThreadedComments($recursive, false);
		}
		
		return $result;
	}
	
	/**
	 * {@inheritdoc}
	 */
	public function restore(bool $recursive = true): bool {
		$result = parent::restore($recursive);
		
		if ($result) {
			// restore threaded comments
			elgg_call(ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES, function() use ($recursive) {
				/* @var $children \ElggBatch */
				$children = elgg_get_entities([
					'type' => 'object',
					'subtype' => 'comment',
					'limit' => false,
					'batch' => true,
					'metadata_name_value_pairs' => [
						'name' => 'parent_guid',
						'value' => $this->guid,
					],
				]);
				
				/* @var $child \ElggComment */
				foreach ($children as $child) {
					$child->restore($recursive);
				}
			});
		}
		
		return $result;
	}
	
	/**
	 * Delete threaded child comments on this comment
	 *
	 * @param bool $recursive  recursive delete contained entities
	 * @param bool $persistent persistently remove the threaded comments
	 *
	 * @return void
	 * @since 6.0
	 */
	protected function deleteThreadedComments(bool $recursive, bool $persistent): void {
		elgg_call(ELGG_IGNORE_ACCESS | ELGG_SHOW_DISABLED_ENTITIES | ELGG_SHOW_DELETED_ENTITIES, function() use ($recursive, $persistent) {
			/* @var $children \ElggBatch */
			$children = elgg_get_entities([
				'type' => 'object',
				'subtype' => 'comment',
				'limit' => false,
				'batch' => true,
				'batch_inc_offset' => !$persistent,
				'metadata_name_value_pairs' => [
					'name' => 'parent_guid',
					'value' => $this->guid,
				],
			]);
			
			/* @var $child \ElggComment */
			foreach ($children as $child) {
				if (!$child->delete($recursive, $persistent) && $persistent) {
					$children->reportFailure();
				}
			}
		});
	}
	
	/**
	 * {@inheritDoc}
	 */
	public function canComment(int $user_guid = 0): bool {
		if ($this->getLevel() >= (int) elgg_get_config('comments_max_depth')) {
			return false;
		}
		
		$container = $this->getContainerEntity();
		if (!$container instanceof ElggEntity) {
			return false;
		}
		
		return $container->canComment($user_guid);
	}
	
	/**
	 * Is this comment created by the same owner as the content of the item being commented on
	 *
	 * @return bool
	 * @since 4.1
	 */
	public function isCreatedByContentOwner(): bool {
		return elgg_call(ELGG_IGNORE_ACCESS, function() {
			$container = $this->getContainerEntity();
			if (!$container instanceof ElggEntity) {
				return false;
			}
			
			return $container->owner_guid === $this->owner_guid;
		});
	}
	
	/**
	 * Get the depth level of the comment
	 *
	 * @return int 1: toplevel, 2: first level, etc
	 * @since 4.1
	 */
	public function getLevel(): int {
		return isset($this->level) ? (int) $this->level : 1;
	}
	
	/**
	 * Return the thread GUID this comment is a part of
	 *
	 * @return int
	 * @since 4.1
	 */
	public function getThreadGUID(): int {
		if (isset($this->thread_guid)) {
			return (int) $this->thread_guid;
		}
		
		return $this->guid;
	}
	
	/**
	 * Return the thread (top-level) comment
	 *
	 * @return \ElggComment
	 * @since 4.1
	 */
	public function getThreadEntity(): ?\ElggComment {
		$entity = get_entity($this->getThreadGUID());
		return $entity instanceof \ElggComment ? $entity : null;
	}
}