Axiom\Rivescript\Cortex\Topic

Complexity

Total Complexity

12

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	responses()	0	3	1
A	__construct()	0	5	1
A	sortTriggers()	0	8	2
A	determineTypeCount()	0	20	6
A	determineWordCount()	0	6	1
A	triggers()	0	3	1

<?php
/*
 * This file is part of Rivescript-php
 *
 * (c) Shea Lewis <shea.lewis89@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Axiom\Rivescript\Cortex;

use Axiom\Collections\Collection;

/**
 * Topic class
 *
 * Stores information about a topic.
 *
 * PHP version 7.4 and higher.
 *
 * @category Core
 * @package  Cortext
 * @author   Shea Lewis <shea.lewis89@gmail.com>
 * @license  https://opensource.org/licenses/MIT MIT
 * @link     https://github.com/axiom-labs/rivescript-php
 * @since    0.3.0
 */
class Topic
{
    /**
     * The name of this Topic.
     *
     * @var string
     */
    protected string $name;

    /**
     * The triggers for this Topic.
     *
     * @var Collection<string, mixed>
     */
    public Collection $triggers;

    /**
     * The responses for this Topic.
     *
     * @var Collection<string, mixed>
     */
    public Collection $responses;

    /**
     * Create a new Topic instance.
     *
     * @param string $name
     */
    public function __construct(string $name)
    {
        $this->name = $name;
        $this->triggers = new Collection([]);
        $this->responses = new Collection([]);
    }

    /**
     * Return triggers associated with this branch.
     *
     * @return Collection<string, mixed>
     */
    public function triggers(): Collection
    {
        return $this->triggers;
    }

    /**
     * Return the responses associated with this branch.
     *
     * @return Collection<string, mixed>
     */
    public function responses(): Collection
    {
        return $this->responses;
    }

    /**
     * Sort triggers based on type and word count from
     * largest to smallest.
     *
     * @param \Axiom\Collections\Collection $triggers
     *
     * @return \Axiom\Collections\Collection
     */
    public function sortTriggers(Collection $triggers): Collection
    {
        $triggers = $this->determineWordCount($triggers);
        $triggers = $this->determineTypeCount($triggers);

        return $triggers->sort(function ($current, $previous) {
            return ($current['order'] < $previous['order']) ? -1 : 1;
        })->reverse();
    }

    /**
     * Determine the order in the triggers.
     *
     * @param Collection<array> $triggers A collection of triggers.
     *
     * @return Collection<array>
     */
    protected function determineTypeCount(Collection $triggers): Collection
    {
        return $triggers->each(function ($data, $trigger) use ($triggers) {
            if (isset($data['type'])) {
                switch ($data['type']) {
                    case 'atomic':
                        $data['order'] += 4000000;
                        break;
                    case 'alphabetic':
                        $data['order'] += 3000000;
                        break;
                    case 'numeric':
                        $data['order'] += 2000000;
                        break;
                    case 'global':
                        $data['order'] += 1000000;
                        break;
                }

                $triggers->put($trigger, $data);
            }
        });
    }

    /**
     * Sort triggers based on word count from
     * largest to smallest.
     *
     * @param Collection<array> $triggers A collection of triggers.
     *
     * @return Collection<array>
     */
    protected function determineWordCount(Collection $triggers): Collection
    {
        return $triggers->each(function ($data, $trigger) use ($triggers) {
            $data['order'] = count(explode(' ', $trigger));

            $triggers->put($trigger, $data);
        });
    }
}