dukt / analytics

src/base/PluginTrait.php

<?php
/**
 * @link      https://dukt.net/analytics/
 * @copyright Copyright (c) 2022, Dukt
 * @license   https://github.com/dukt/analytics/blob/master/LICENSE.md
 */

namespace dukt\analytics\base;

use Craft;
use craft\db\Query;
use craft\helpers\Db;
use dukt\analytics\models\Info;
use dukt\analytics\Plugin as Analytics;

/**
 * PluginTrait implements the common methods and properties for plugin classes.
 *
 * @property \dukt\analytics\services\Analytics                 $analytics                  The analytics service
 * @property \dukt\analytics\services\Apis                      $apis                       The apis service
 * @property \dukt\analytics\services\Cache                     $cache                      The cache service
 * @property \dukt\analytics\services\Geo                       $geo                        The geo service
 * @property \dukt\analytics\services\Metadata                  $metadata                   The metadata service
 * @property \dukt\analytics\services\Oauth                     $oauth                      The oauth service
 * @property \dukt\analytics\services\Reports                   $reports                    The reports service
 * @property \dukt\analytics\services\Views                     $views                      The views service
 */
trait PluginTrait
{
    // Properties
    // =========================================================================

    /**
     * @var
     */
    private $_info;

    /**
     * @var
     */
    private $_isInstalled;

    // Public Methods
    // =========================================================================

    /**
     * Returns the analytics service.
     *
     * @return \dukt\analytics\services\Analytics The analytics service
     * @throws \yii\base\InvalidConfigException
     */
    public function getAnalytics()
    {
        /** @var Analytics $this */
        return $this->get('analytics');

The expression return $this->get('analytics') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Analytics.

    }

    /**
     * Returns the apis service.
     *
     * @return \dukt\analytics\services\Apis The apis service
     * @throws \yii\base\InvalidConfigException
     */
    public function getApis()
    {
        /** @var Analytics $this */
        return $this->get('apis');

The expression return $this->get('apis') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Apis.

    }

    /**
     * Returns the cache service.
     *
     * @return \dukt\analytics\services\Cache The cache service
     * @throws \yii\base\InvalidConfigException
     */
    public function getCache()
    {
        /** @var Analytics $this */
        return $this->get('cache');

The expression return $this->get('cache') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Cache.

    }

    /**
     * Returns the geo service.
     *
     * @return \dukt\analytics\services\Geo The geo service
     * @throws \yii\base\InvalidConfigException
     */
    public function getGeo()
    {
        /** @var Analytics $this */
        return $this->get('geo');

The expression return $this->get('geo') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Geo.

    }

    /**
     * Returns the metadata service.
     *
     * @return \dukt\analytics\services\Metadata The metadata service
     * @throws \yii\base\InvalidConfigException
     */
    public function getMetadata()
    {
        /** @var Analytics $this */
        return $this->get('metadata');

The expression return $this->get('metadata') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Metadata.

    }

    /**
     * Returns the oauth service.
     *
     * @return \dukt\analytics\services\Oauth The oauth service
     * @throws \yii\base\InvalidConfigException
     */
    public function getOauth()
    {
        /** @var Analytics $this */
        return $this->get('oauth');

The expression return $this->get('oauth') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Oauth.

    }

    /**
     * Returns the reports service.
     *
     * @return \dukt\analytics\services\Reports The reports service
     * @throws \yii\base\InvalidConfigException
     */
    public function getReports()
    {
        /** @var Analytics $this */
        return $this->get('reports');

The expression return $this->get('reports') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Reports.

    }

    /**
     * Returns the views service.
     *
     * @return \dukt\analytics\services\Views The views service
     * @throws \yii\base\InvalidConfigException
     */
    public function getViews()
    {
        /** @var Analytics $this */
        return $this->get('views');

The expression return $this->get('views') also could return the type mixed which is incompatible with the documented return type dukt\analytics\services\Views.

    }

    /**
     * Updates the info row.
     *
     * @param Info $info
     *
     * @return bool
     * @throws \yii\db\Exception
     */
    public function saveInfo(Info $info): bool
    {
        $attributes = Db::prepareValuesForDb($info);

        if (array_key_exists('id', $attributes) && $attributes['id'] === null) {
            unset($attributes['id']);
        }

        if ($this->getIsInstalled()) {
            Craft::$app->getDb()->createCommand()
                ->update('{{%analytics_info}}', $attributes)
                ->execute();
        } else {
            Craft::$app->getDb()->createCommand()
                ->insert('{{%analytics_info}}', $attributes)
                ->execute();

            if (Craft::$app->getIsInstalled()) {
                // Set the new id
                $info->id = Craft::$app->getDb()->getLastInsertID('{{%analytics_info}}');

It seems like Craft::app->getDb()->getLastInsertID('{{%analytics_info}}') of type string is incompatible with the declared type integer|null of property $id.

            }
        }

        $this->_info = $info;

        return true;
    }

    /**
     * Returns the info model, or just a particular attribute.
     *
     * @return Info
     * @throws ServerErrorHttpException if the info table is missing its row
     */
    public function getInfo(): Info
    {
        /** @var WebApplication|ConsoleApplication $this */
        if ($this->_info !== null) {
            return $this->_info;
        }

        if (!$this->getIsInstalled()) {
            return new Info();
        }

        $row = (new Query())
            ->from(['{{%analytics_info}}'])
            ->one();

        if (!$row) {
            $tableName = $this->getDb()->getSchema()->getRawTableName('{{%analytics_info}}');
            throw new ServerErrorHttpException("The {$tableName} table is missing its row");

The type dukt\analytics\base\ServerErrorHttpException was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        return $this->_info = new Info($row);
    }

    /**
     * Returns whether Craft is installed.
     *
     * @return bool
     */
    public function getIsInstalled(): bool
    {
        /** @var WebApplication|ConsoleApplication $this */
        if ($this->_isInstalled !== null) {
            return $this->_isInstalled;
        }

        $infoRowExists = false;

        if(Craft::$app->getDb()->tableExists('{{%analytics_info}}', false)) {
            $infoRowExists = (new Query())
                ->from(['{{%analytics_info}}'])
                ->one();
        }

        return $this->_isInstalled = (
            Craft::$app->getIsDbConnectionValid() &&
            $infoRowExists
        );
    }
}