smtech\StMarksSearch\Canvas\AbstractCanvasSearchDomain

Complexity

Total Complexity

5

Size/Duplication

Total Lines	58
Duplicated Lines	5.17 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	3	13	2
A	setId()	0	9	2
A	getId()	0	4	1

<?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
{
    use RequireCanvasPestParameter;

    /**
     * Canvas ID or SIS ID of the Canvas object
     * @var string|integer
     */
    protected $id;

    /**
     * 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)
    {
        $this->requireCanvasPestParameter($params);

        if (empty($params['url'])) {

This code seems to be duplicated across your project.

            $params['url'] = preg_replace('%^(.*)/api/v\d+$%', '$1', $this->getApi()->base_url);
        }

        parent::__construct($params);

        assert(isset($params['id']), new Exception('`id` parameter required'));
        $this->setId($params['id']);
    }

    /**
     * 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)
    {
        assert(
            is_numeric($id) ||
                preg_match('/^sis_[a-z]+_id:\S+$/i', $id),
            new Exception('ID must be a Canvas ID or SIS ID, received:' . PHP_EOL . print_r($id, true))
        );
        $this->id = $id;

It seems like $id can also be of type double. However, the property $id is declared as type string|integer. Maybe add an additional type check?

    }

    /**
     * Get the Canvas object ID
     *
     * @return string|integer
     */
    public function getId()
    {
        return $this->id;
    }
}