smtech\GradingAnalytics\Snapshots\CacheableDatabase

Complexity

Total Complexity

9

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	20	6
A	getMySql()	0	4	1
A	getCache()	0	11	2

<?php
/** CacheableDatabase class */

namespace smtech\GradingAnalytics\Snapshots;

use mysqli;
use smtech\ReflexiveCanvasLTI\Toolbox;
use smtech\GradingAnalytics\Snapshots\Exception\SnapshotException;
use Battis\HierarchicalSimpleCache;

/**
 * An object that has access to a MySQL database and a cache.
 *
 * @author Seth Battis <SethBattis@stmarksschool.org>
 */
class CacheableDatabase
{
    /**
     * MySQL database access
     * @var mysqli
     */
    protected $sql;

    /**
     * Caching for queried data
     * @var HierarchicalSimpleCache
     */
    protected $cache;

    /**
     * Construct a CacheableDatabase object
     *
     * Note that the cache is instantiated just in time, and will not be created
     * until its first use.
     *
     * @param mysqli|Toolbox|CacheableDatabase $databaseProvider An object
     *        containing a mysqli object that can be reused
     *
     * @throws SnapshotException `SnapshotException::MYSQL` If a valid mysqli
     *         database object cannot be extracted from the `$databaseProvider`
     */
    public function __construct($databaseProvider)
    {
        if (is_a($databaseProvider, mysqli::class)) {
            $this->sql = $databaseProvider;
        } elseif (is_a($databaseProvider, CacheableDatabase::class)) {
            $this->sql = $databaseProvider->sql;
        } elseif (is_a($databaseProvider, Toolbox::class)) {
            $this->sql = $databaseProvider->getMySql();

The method getMySql does only exist in smtech\GradingAnalytics\Snapshots\CacheableDatabase and smtech\ReflexiveCanvasLTI\Toolbox, but not in mysqli.

        }

        if (!is_a($this->sql, mysqli::class)) {
            throw new SnapshotException(
                'Database provider not recognized (instance of ' . (is_object($databaseProvider) ?
                        get_class($databaseProvider) :
                        gettype($databaseProvider)
                    ) .')',
                SnapshotException::MYSQL
            );
        }
    }

    /**
     * MySQL access
     *
     * @return mysqli
     */
    protected function getMySql()
    {
        return $this->sql;
    }

    /**
     * Cache access
     *
     * @return HierarchicalSimpleCache
     */
    protected function getCache()
    {
        if (empty($this->cache)) {
            $this->cache = new HierarchicalSimpleCache(
                $this->getMySql(),
                get_class($this)
            );
            $this->cache->purgeExpired();
        }
        return $this->cache;
    }
}