smtech\CanvasHack\Toolbox

Complexity

Total Complexity

5

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getGenerator()	0	12	1
A	loadConfiguration()	0	9	1
A	setCustomPrefs()	0	4	1
A	getCustomPrefs()	0	4	1
A	customPrefs_query()	0	4	1

<?php

namespace smtech\CanvasHack;

use mysqli;
use Battis\ConfigXML;

class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox
{
    /**
     * Custom Preferences database
     * @var mysqli
     */
    protected $customPrefs;

    /**
     * Configure account navigation placement
     *
     * @return Generator
     */
    public function getGenerator()
    {
        parent::getGenerator();

        $this->generator->setOptionProperty(
            Option::COURSE_NAVIGATION(),
            'visibility',
            'admins'
        );

        return $this->generator;
    }

    /**
     * Update a Toolbox instance from a configuration file
     *
     * @see Toolbox::fromConfiguration() Use `Toolbox::fromConfiguration()`
     *
     * @param  string $configFilePath
     * @param  boolean $forceRecache
     * @return void
     */
    protected function loadConfiguration($configFilePath, $forceRecache = false)
    {
        parent::loadConfiguration($configFilePath, $forceRecache);

        $config = new ConfigXML($configFilePath);

        /* configure database connections */
        $this->setCustomPrefs($config->newInstanceOf(mysqli::class, '/config/mysql/customprefs'));
    }

    /**
     * Set MySQL connection object
     *
     * @param mysqli $mysql
     */
    public function setCustomPrefs(mysqli $mysql)
    {
        $this->customPrefs = $mysql;
    }

    /**
     * Get MySQL connection object
     *
     * @return mysqli
     */
    public function getCustomPrefs()
    {
        return $this->customPrefs;
    }

    /**
     * Make a MySQL query
     *
     * @link http://php.net/manual/en/mysqli.query.php Pass-through to `mysqli::query()`
     * @param string $query
     * @param int $resultMode (Optional, defaults to `MYSQLI_STORE_RESULT`)
     * @return mixed
     */
    public function customPrefs_query($query, $resultMode = MYSQLI_STORE_RESULT)
    {
        return $this->getCustomPrefs()->query($query, $resultMode);
    }
}