smtech\StMarksSearch\Canvas\AbstractCanvasSearchDomain

Complexity

Total Complexity

8

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	20	2
A	setApi()	0	7	2
A	getApi()	0	4	1
A	setId()	0	9	3

<?php

namespace smtech\StMarksSearch\Canvas;

use Exception;
use smtech\CanvasPest\CanvasPest;
use smtech\StMarksSearch\AbstractSearchDomain;

/**
 * Parent class for all Canvas search domains
 *
 * @author Seth Battis <SethBattis@stmarksschool.org>
 */
abstract class AbstractCanvasSearchDomain extends AbstractSearchDomain
{
    const ID = 'id';
    const API = 'api';

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

    /**
     * Construct a CanvasSearchDomain from `$params`, requires `id` and `api`
     * params, will extract `url` param from `api`, if necessary.
     *
     * @inheritdoc
     *
     * @param mixed[string] $params

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

     */
    public function __construct($params)
    {
        static::requireParameter($params, self::ID);
        static::requireParameter($params, self::API, CanvasPest::class);

        static::defaultParameter(
            $params,
            'icon',
            'https://du11hjcvx0uqb.cloudfront.net/dist/images/favicon-e10d657a73.ico'
        );

        $this->setApi($params[self::API]);
        if (empty($params[self::URL])) {
            $params[self::URL] = preg_replace('%^(.*)/api/v\d+$%', '$1', $this->getApi()->base_url);
        }

        parent::__construct($params);

        $this->setId($params[self::ID]);
    }

    /**
     * Update the `$api` field
     *
     * @param CanvasPest $api
     * @throws Exception If `$api` is `NULL`
     */
    protected function setApi(CanvasPest $api)
    {
        if ($api === null) {
            throw new Exception('Initialized CanvasPest object required');
        }
        $this->api = $api;
    }

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

    /**
     * Update the ID of the Canvas object
     *
     * @used-by AbstractCanvasSearchDomain::__construct()
     * @param string|integer $id Canvas ID or SIS ID formatted as `sis_*_id:*`
     */
    protected function setId($id)
    {
        if (!is_numeric($id) &&
            !preg_match('/^sis_[a-z]+_id:\S+$/i', $id)
        ) {
            throw new Exception('ID must be a Canvas ID or SIS ID, received:' . PHP_EOL . print_r($id, true));
        }
        $this->id = $id;

The property id does not exist. Did you maybe forget to declare it?

    }
}