smtech\StMarksSearch\Canvas\Courses\Announcements\AnnouncementsSearch

Complexity

Total Complexity

7

Size/Duplication

Total Lines	62
Duplicated Lines	37.1 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	search()	11	33	5
A	relevance()	12	12	2

<?php

namespace smtech\StMarksSearch\Canvas\Courses\Announcements;

use smtech\CanvasPest\CanvasArray;
use smtech\CanvasPest\CanvasObject;
use smtech\StMarksSearch\Relevance;
use smtech\StMarksSearch\SearchResult;
use smtech\StMarksSearch\SearchSource;
use smtech\StMarksSearch\Canvas\Courses\AbstractCourseSearchDomain;

/**
 * Search a Canvas course's announcements
 *
 * @author Seth Battis <SethBattis@stmarksschool.org>
 */
class AnnouncementsSearch extends AbstractCourseSearchDomain
{
    /**
     * Search for `$query` among the announcements
     *
     * @param string $query
     * @return SearchResult[] Ordered by descending relevance
     */
    public function search($query)
    {
        /* Canvas doesn't accept search queries shorter than 3 characters */
        if (strlen(trim($query)) < 3) {
            return [];
        }

        $source = new SearchSource($this);
        $results = [];

        $response = $this->getApi()->get(
            'courses/' . $this->getId() . '/discussion_topics',
            [

array('search_term' => $query, 'only_announcements' => true) is of type array<string,string|boolean,{"search_term":"string","only_announcements":"boolean"}>, but the function expects a string|array<integer,string>.

                'search_term' => $query,
                'only_announcements' => true
            ]
        );

        if (is_a($response, CanvasArray::class)) {

This code seems to be duplicated across your project.

            foreach ($response as $announcement) {

The expression $response of type object<smtech\CanvasPest\CanvasObject>|object<smtech\CanvasPest\CanvasArray> is not guaranteed to be traversable. How about adding an additional type check?

                $results[] = new SearchResult(
                    $announcement['html_url'],
                    $this->relevance($announcement, $query),
                    $announcement['title'],
                    (empty($announcement['message']) ? '' : substr(str_replace(PHP_EOL, ' ', strip_tags($announcement['message'])), 0, 255) . '…'),
                    $source
                );
            }
        }

        $this->sortByRelevance($results);
        return $results;
    }

    /**
     * Calculate the relevance of a particular announcement
     *
     * @param CanvasObject $announcement
     * @param string $query
     * @return Relevance
     */
    protected function relevance($announcement, $query)

This method seems to be duplicated in your project.

    {
        $relevance = new Relevance();

        $relevance->add(Relevance::stringProportion($announcement['title'], $query), 'title match');

        if (($count = substr_count(strtolower($announcement['message']), strtolower($query))) > 0) {
            $relevance->add($count * 0.01, "$count occurrences in body");
        }

        return $relevance;
    }
}