Piwik\Plugin\Controller::setBasicVariablesView PHP Method

Controller Class Documentation Usage Examples Of Piwik\Plugin\Controller::setBasicVariablesView Show file Open project: piwik/piwik

setBasicVariablesView() protected method

The following variables assigned: **isSuperUser** - True if the current user is the Super User, false if otherwise. **hasSomeAdminAccess** - True if the current user has admin access to at least one site, false if otherwise. **isCustomLogo** - The value of the branding_use_custom_logo option. **logoHeader** - The header logo URL to use. **logoLarge** - The large logo URL to use. **logoSVG** - The SVG logo URL to use. **hasSVGLogo** - True if there is a SVG logo, false if otherwise. **enableFrames** - The value of the [General] enable_framed_pages INI config option. If true, {@link Piwik\View::setXFrameOptions()} is called on the view. Also calls {@link setHostValidationVariablesView()}.

protected setBasicVariablesView ( View $view )
$view	Piwik\View

    protected function setBasicVariablesView($view)
    {
        $view->clientSideConfig = PiwikConfig::getInstance()->getClientSideOptions();
        $view->isSuperUser = Access::getInstance()->hasSuperUserAccess();
        $view->hasSomeAdminAccess = Piwik::isUserHasSomeAdminAccess();
        $view->hasSomeViewAccess = Piwik::isUserHasSomeViewAccess();
        $view->isUserIsAnonymous = Piwik::isUserIsAnonymous();
        $view->hasSuperUserAccess = Piwik::hasUserSuperUserAccess();
        if (!Piwik::isUserIsAnonymous()) {
            $view->emailSuperUser = implode(',', Piwik::getAllSuperUserAccessEmailAddresses());
        }
        $this->addCustomLogoInfo($view);
        $view->logoHeader = \Piwik\Plugins\API\API::getInstance()->getHeaderLogoUrl();
        $view->logoLarge = \Piwik\Plugins\API\API::getInstance()->getLogoUrl();
        $view->logoSVG = \Piwik\Plugins\API\API::getInstance()->getSVGLogoUrl();
        $view->hasSVGLogo = \Piwik\Plugins\API\API::getInstance()->hasSVGLogo();
        $view->superUserEmails = implode(',', Piwik::getAllSuperUserAccessEmailAddresses());
        $general = PiwikConfig::getInstance()->General;
        $view->enableFrames = $general['enable_framed_pages'] || isset($general['enable_framed_logins']) && $general['enable_framed_logins'];
        if (!$view->enableFrames) {
            $view->setXFrameOptions('sameorigin');
        }
        self::setHostValidationVariablesView($view);
    }

Usage Example

Example #1

Show file

File: ControllerAdmin.php Project: josl/CGE-File-Sharing

 /**
  * Calls {@link setBasicVariablesView()} and {@link setBasicVariablesAdminView()}
  * using the supplied view.
  *
  * @param View $view
  * @api
  */
 protected function setBasicVariablesView($view)
 {
     parent::setBasicVariablesView($view);
     self::setBasicVariablesAdminView($view);
 }

Controller

__construct

addCustomLogoInfo

checkSitePermission

checkTokenInUrl

doRedirectToUrl

getCalendarPrettyDate

getDateParameterInTimezone

getDefaultAction

getEnabledPeriodsInUI

getEnabledPeriodsNames

getGraphParamsModified