buzzerstar - static - core - Measurable - SOURCE CODE

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik\Measurable;

use Exception;
use Piwik\Site;

/**
 * Provides access to individual measurables.
 */
class Measurable extends Site
{

    public function getSettingValue($name)
    {
        $settings = new MeasurableSettings($this->id, $this->getType());
        $setting  = $settings->getSetting($name);

        if (!empty($setting)) {
            return $setting->getValue(); // Calling `getValue` makes sure we respect read permission of this setting
        }

        throw new Exception(sprintf('Setting %s does not exist', $name));
    }
}

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik\Measurable;

use Piwik\Piwik;

/**
 * Describes a Type setting for a website, mobile app, ...
 *
 * See {@link \Piwik\Plugin\Settings}.
 */
class MeasurableSetting extends \Piwik\Settings\Setting
{
    /**
     * By default the value of the type setting is only readable by users having at least view access to one site
     *
     * @var bool
     * @since 2.14.0
     */
    public $readableByCurrentUser = false;

    /**
     * By default the value of the type setting is only writable by users having at least admin access to one site
     * @var bool
     * @internal
     */
    public $writableByCurrentUser = false;

    /**
     * Constructor.
     *
     * @param string $name The persisted name of the setting.
     * @param string $title The display name of the setting.
     */
    public function __construct($name, $title)
    {
        parent::__construct($name, $title);

        $this->writableByCurrentUser = Piwik::isUserHasSomeAdminAccess();
        $this->readableByCurrentUser = Piwik::isUserHasSomeViewAccess();
    }

    /**

... [truncated, 21 more lines] ...

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\Measurable;

use Piwik\Db;
use Piwik\Piwik;
use Piwik\Plugin\Settings;
use Piwik\Measurable\Settings\Storage;
use Piwik\Settings\Setting;
use Piwik\Measurable\Type\TypeManager;

class MeasurableSettings extends Settings
{

    /**
     * @var int
     */
    private $idSite = null;

    /**
     * @var string
     */
    private $idType = null;

    /**
     * @param int $idSite The id of a site. If you want to get settings for a not yet created site just pass an empty value ("0")
     * @param string $idType If no typeId is given, the type of the site will be used.
     *
     * @throws \Exception
     */
    public function __construct($idSite, $idType)
    {
        $this->idSite = $idSite;
        $this->idType = $idType;
        $this->storage = new Storage(Db::get(), $this->idSite);
        $this->pluginName = 'MeasurableSettings';

        $this->init();
    }

    protected function init()
    {
        $typeManager = new TypeManager();
        $type = $typeManager->getType($this->idType);

... [truncated, 54 more lines] ...

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\Measurable;

class Type
{
    const ID = '';
    protected $name = 'General_Measurable';
    protected $namePlural = 'General_Measurables';
    protected $description = 'Default measurable type';
    protected $howToSetupUrl = '';

    public function isType($typeId)
    {
        // here we should add some point also check whether id matches any extended ID. Eg if
        // MetaSites extends Websites, then we expected $metaSite->isType('website') to be true (maybe)
        return $this->getId() === $typeId;
    }

    public function getId()
    {
        $id = static::ID;

        if (empty($id)) {
            $message = 'Type %s does not define an ID. Set the ID constant to fix this issue';;
            throw new \Exception(sprintf($message, get_called_class()));
        }

        return $id;
    }

    public function getDescription()
    {
        return $this->description;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getNamePlural()
    {
        return $this->namePlural;

... [truncated, 13 more lines] ...