Ad.class.php

<?php

namespace wcf\data\ad;

use wcf\data\condition\Condition;
use wcf\data\DatabaseObject;
use wcf\data\object\type\ObjectTypeCache;
use wcf\system\ad\location\IAdLocation;
use wcf\system\condition\ConditionHandler;
use wcf\system\request\IRouteController;
use wcf\system\WCF;
use wcf\util\StringUtil;

/**
 * Represents an ad.
 *
 * @author  Matthias Schmidt
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 *
 * @property-read   int     $adID           unique id of the ad
 * @property-read   int     $objectTypeID   id of the `com.woltlab.wcf.adLocation` object type
 * @property-read   string  $adName         name of the ad shown in ACP
 * @property-read   ?string $ad             ad text
 * @property-read   0|1     $isDisabled     is `1` if the ad is disabled and thus not shown, otherwise `0`
 * @property-read   int     $showOrder      position of the ad in relation to the other ads at the same location
 */
class Ad extends DatabaseObject implements IRouteController
{
    /**
     * Returns the conditions of the ad.
     *
     * @return  Condition[]
     */
    public function getConditions()
    {
        return ConditionHandler::getInstance()->getConditions('com.woltlab.wcf.condition.ad', $this->adID);
    }

    /**
     * Returns the location of the ad.
     *
     * @return  string
     */
    public function getLocation()
    {
        $objectType = ObjectTypeCache::getInstance()->getObjectType($this->objectTypeID);

        $location = WCF::getLanguage()->get('wcf.acp.ad.location.' . $objectType->objectType);
        if ($objectType->categoryname != 'com.woltlab.wcf.global') {
            $location = WCF::getLanguage()->get('wcf.acp.ad.location.category.' . $objectType->categoryname) . ': ' . $location;
        }

        return $location;
    }

    /**
     * @inheritDoc
     */
    public function getTitle(): string
    {
        return $this->adName;
    }

    /**
     * Returns the HTML code used to display the ad.
     *
     * @return  string
     * @since   5.2
     */
    public function getHtmlCode()
    {
        $output = $this->ad;

        $objectType = ObjectTypeCache::getInstance()->getObjectType($this->objectTypeID);

        if (WCF::getUser()->userID) {
            $output = \strtr($output, ['{$username}' => StringUtil::encodeHTML(WCF::getUser()->username)]);
        } else {
            $output = \strtr(
                $output,
                ['{$username}' => StringUtil::encodeHTML(WCF::getLanguage()->get('wcf.user.guest'))]
            );
        }

        if ($objectType->className && \is_subclass_of($objectType->className, IAdLocation::class)) {
            /** @var IAdLocation $adLocation */
            $adLocation = $objectType->getProcessor();

            $output = $adLocation->replaceVariables($output);
        }

        return $output;
    }
}