smtech\StMarksSearch\Canvas\RequireCanvasPestParameter

Complexity

Total Complexity

3

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	requireCanvasPestParameter()	0	5	1
A	setApi()	0	5	1
A	getApi()	0	4	1

<?php

namespace smtech\StMarksSearch\Canvas;

use Exception;
use smtech\CanvasPest\CanvasPest;
use smtech\StMarksSearch\RequireParameter;

/**
 * Require and manage a CanvasPest parameter
 *
 * @author Seth Battis <SethBattis@stmarksschool.org>
 */
trait RequireCanvasPestParameter
{
    use RequireParameter;

    /**
     * API access object
     * @var CanvasPest
     */
    protected $api;

    /**
     * Require and store a CanvasPest parameter
     *
     * @param mixed[string] $params

The doc-type mixed[string] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

     * @param string $key (Optional, defaults to `'api'`)
     * @return void
     */
    protected function requireCanvasPestParameter($params, $key = 'api')
    {
        $this->requireParameter($params, $key, CanvasPest::class);
        $this->setApi($params[$key]);
    }

    /**
     * Update the `$api` field
     *
     * @param CanvasPest $api
     */
    protected function setApi(CanvasPest $api)
    {
        assert($api !== null, new Exception('Initialized CanvasPest object required'));
        $this->api = $api;
    }

    /**
     * Get the Canvas API field
     *
     * @return CanvasPest
     */
    protected function getApi()
    {
        return $this->api;
    }
}