Merge branch '3.0'

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / message / quote / AbstractMessageQuoteHandler.class.php

<?php
namespace wcf\system\message\quote;
use wcf\system\cache\runtime\UserProfileRuntimeCache;
use wcf\system\SingletonFactory;
use wcf\system\WCF;

/**
 * Default implementation for quote handlers.
 * 
 * @author	Alexander Ebert
 * @copyright	2001-2018 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\System\Message\Quote
 */
abstract class AbstractMessageQuoteHandler extends SingletonFactory implements IMessageQuoteHandler {
	/**
	 * template name
	 * @var	string
	 */
	public $templateName = 'messageQuoteList';
	
	/**
	 * list of quoted message
	 * @var	QuotedMessage[]
	 */
	public $quotedMessages = [];
	
	/**
	 * @inheritDoc
	 */
	public function render(array $data, $supportPaste = false) {
		$messages = $this->getMessages($data);
		$this->overrideIsFullQuote($messages);
		
		$userIDs = $userProfiles = [];
		foreach ($messages as $message) {
			$userID = $message->getUserID();
			if ($userID) {
				$userIDs[] = $userID;
			}
		}
		
		if (!empty($userIDs)) {
			$userIDs = array_unique($userIDs);
			$userProfiles = UserProfileRuntimeCache::getInstance()->getObjects($userIDs);
		}
		
		WCF::getTPL()->assign([
			'messages' => $messages,
			'supportPaste' => $supportPaste,
			'userProfiles' => $userProfiles
		]);
		
		return WCF::getTPL()->fetch($this->templateName);
	}
	
	/**
	 * @inheritDoc
	 */
	public function renderQuotes(array $data, $render = true, $renderAsString = true) {
		$messages = $this->getMessages($data);
		$this->overrideIsFullQuote($messages);
		
		$renderedQuotes = [];
		foreach ($messages as $message) {
			foreach ($message as $quoteID => $quote) {
				$quotedMessage = $message->getFullQuote($quoteID);
				if ($render && ($renderAsString && $quotedMessage === null)) {
					$renderedQuotes[] = MessageQuoteManager::getInstance()->renderQuote($message->object, $quote, $renderAsString);
				}
				else {
					$renderedQuotes[] = MessageQuoteManager::getInstance()->renderQuote($message->object, ($quotedMessage === null ? $quote : $quotedMessage), $renderAsString);
				}
			}
		}
		
		return $renderedQuotes;
	}
	
	/**
	 * Overrides the full quote flag for given message.
	 * 
	 * @param       QuotedMessage[]         $messages
	 */
	protected function overrideIsFullQuote(array $messages) {
		foreach ($messages as $message) {
			$quoteIDs = $message->getQuoteIDs();
			foreach ($quoteIDs as $quoteID) {
				$message->setOverrideIsFullQuote($quoteID, MessageQuoteManager::getInstance()->isFullQuote($quoteID));
			}
		}
	}
	
	/**
	 * Returns a list of QuotedMessage objects.
	 * 
	 * @param	mixed[][]	$data
	 * @return	QuotedMessage[]
	 */
	abstract protected function getMessages(array $data);
}