enwikipedia-acc / waca

includes/Fragments/TemplateOutput.php

<?php
/******************************************************************************
 * Wikipedia Account Creation Assistance tool                                 *
 * ACC Development Team. Please see team.json for a list of contributors.     *
 *                                                                            *
 * This is free and unencumbered software released into the public domain.    *
 * Please see LICENSE.md for the full licencing statement.                    *
 ******************************************************************************/

namespace Waca\Fragments;

use Smarty;
use Waca\DataObjects\User;
use Waca\Environment;
use Waca\SiteConfiguration;

trait TemplateOutput
{
    /** @var Smarty */
    private $smarty;

    /**
     * @return SiteConfiguration
     */
    protected abstract function getSiteConfiguration();

    /**
     * Assigns a Smarty variable
     *
     * @param  array|string $name  the template variable name(s)
     * @param  mixed        $value the value to assign
     */
    final protected function assign($name, $value)
    {
        $this->smarty->assign($name, $value);
    }

    /**
     * Sets up the variables used by the main Smarty base template.
     *
     * This list is getting kinda long.
     */
    final protected function setUpSmarty()
    {
        $this->smarty = new Smarty();
        $this->smarty->addPluginsDir($this->getSiteConfiguration()->getFilePath() . '/smarty-plugins');
        $this->registerPlugin('modifier', 'count', 'count');

It seems like registerPlugin() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->registerPlugin('modifier', 'implode', 'implode');

        $this->assign('currentUser', User::getCommunity());
        $this->assign('skin', 'auto');
        $this->assign('currentDomain', null);
        $this->assign('loggedIn', false);
        $this->assign('baseurl', $this->getSiteConfiguration()->getBaseUrl());
        $this->assign('resourceCacheEpoch', $this->getSiteConfiguration()->getResourceCacheEpoch());

        $this->assign('siteNoticeText', '');
        $this->assign('siteNoticeVersion', 0);
        $this->assign('siteNoticeState', 'd-none');
        $this->assign('toolversion', Environment::getToolVersion());

        // default these
        $this->assign('onlineusers', array());
        $this->assign('typeAheadBlock', '');
        $this->assign('extraJs', array());

        // nav menu access control
        $this->assign('nav__canRequests', false);
        $this->assign('nav__canLogs', false);
        $this->assign('nav__canUsers', false);
        $this->assign('nav__canSearch', false);
        $this->assign('nav__canStats', false);
        $this->assign('nav__canBan', false);
        $this->assign('nav__canEmailMgmt', false);
        $this->assign('nav__canWelcomeMgmt', false);
        $this->assign('nav__canSiteNoticeMgmt', false);
        $this->assign('nav__canUserMgmt', false);
        $this->assign('nav__canViewRequest', false);
        $this->assign('nav__canJobQueue', false);
        $this->assign('nav__canFlaggedComments', false);
        $this->assign('nav__canDomainMgmt', false);
        $this->assign('nav__canQueueMgmt', false);
        $this->assign('nav__canFormMgmt', false);
        $this->assign('nav__canErrorLog', false);

        // Navigation badges for concern areas.
        $this->assign("nav__numAdmin", 0);
        $this->assign("nav__numFlaggedComments", 0);
        $this->assign("nav__numJobQueueFailed", 0);

        // debug helpers
        $this->assign('showDebugCssBreakpoints', $this->getSiteConfiguration()->getDebuggingCssBreakpointsEnabled());

        $this->assign('page', $this);
    }

    /**
     * Fetches a rendered Smarty template
     *
     * @param $template string Template file path, relative to /templates/
     *
     * @return string Templated HTML
     */
    final protected function fetchTemplate($template)
    {
        return $this->smarty->fetch($template);
    }
}