<?php

namespace XF\Entity;

use XF\Mvc\Entity\Entity;
use XF\Mvc\Entity\Structure;
use XF\Phrase;

/**
 * COLUMNS
 * @property int|null $moderator_log_id
 * @property int $log_date
 * @property int $user_id
 * @property string $ip_address
 * @property string $content_type
 * @property int $content_id
 * @property int $content_user_id
 * @property string $content_username
 * @property string $content_title_
 * @property string $content_url
 * @property string $discussion_content_type
 * @property int $discussion_content_id
 * @property string $action
 * @property array $action_params
 *
 * GETTERS
 * @property string $content_title
 * @property-read Phrase|string $action_text
 *
 * RELATIONS
 * @property-read User|null $User
 * @property-read User|null $ContentUser
 */
class ModeratorLog extends Entity
{
	/**
	 * @return string
	 */
	public function getContentTitle()
	{
		$logger = $this->app()->logger()->moderatorLogger();
		if ($logger->isValidContentType($this->content_type))
		{
			return $logger->getContentTitle($this);
		}
		else
		{
			return $this->app()->stringFormatter()->censorText($this->content_title_);
		}
	}

	/**
	 * @return Phrase|string
	 */
	public function getActionText()
	{
		$logger = $this->app()->logger()->moderatorLogger();
		if ($logger->isValidContentType($this->content_type))
		{
			return $logger->getAction($this);
		}
		else
		{
			return "$this->content_type $this->action";
		}
	}

	public static function getStructure(Structure $structure)
	{
		$structure->table = 'xf_moderator_log';
		$structure->shortName = 'XF:ModeratorLog';
		$structure->primaryKey = 'moderator_log_id';
		$structure->columns = [
			'moderator_log_id' => ['type' => self::UINT, 'autoIncrement' => true, 'nullable' => true],
			'log_date' => ['type' => self::UINT, 'default' => \XF::$time],
			'user_id' => ['type' => self::UINT, 'required' => true],
			'ip_address' => ['type' => self::BINARY, 'maxLength' => 16, 'default' => ''],
			'content_type' => ['type' => self::STR, 'maxLength' => 25, 'required' => true],
			'content_id' => ['type' => self::UINT, 'required' => true],
			'content_user_id' => ['type' => self::UINT, 'default' => 0],
			'content_username' => ['type' => self::STR, 'maxLength' => 50, 'default' => ''],
			'content_title' => ['type' => self::STR, 'maxLength' => 150, 'forced' => true, 'default' => ''],
			'content_url' => ['type' => self::STR, 'default' => ''],
			'discussion_content_type' => ['type' => self::STR, 'maxLength' => 25, 'required' => true],
			'discussion_content_id' => ['type' => self::UINT, 'required' => true],
			'action' => ['type' => self::STR, 'maxLength' => 25, 'required' => true],
			'action_params' => ['type' => self::JSON_ARRAY, 'default' => ''],
		];
		$structure->getters = [
			'content_title' => true,
			'action_text' => true,
		];
		$structure->relations = [
			'User' => [
				'entity' => 'XF:User',
				'type' => self::TO_ONE,
				'conditions' => 'user_id',
				'primary' => true,
			],
			'ContentUser' => [
				'entity' => 'XF:User',
				'type' => self::TO_ONE,
				'conditions' => [['user_id', '=', '$content_user_id']],
				'primary' => true,
			],
		];

		return $structure;
	}
}
