seretos\testrail\api\Plans

Complexity

Total Complexity

13

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	8	1
A	updateEntry()	0	4	1
A	all()	0	6	2
A	close()	0	4	1
A	createEntry()	0	5	1
A	delete()	0	3	1
A	update()	0	4	1
A	get()	0	3	1
A	findByName()	0	9	3
A	deleteEntry()	0	3	1

<?php
/**
 * Created by PhpStorm.
 * User: aappen
 * Date: 04.10.18
 * Time: 11:27
 */

namespace seretos\testrail\api;


class Plans extends AbstractApi
{
    private $cache = [];
    public function all(int $projectId)
    {
        if (!isset($this->cache[$projectId])) {
            $this->cache[$projectId] = $this->connector->send_get('get_plans/'.$this->encodePath($projectId));
        }
        return $this->cache[$projectId];
    }

    public function get(int $planId)
    {
        return $this->connector->send_get('get_plan/'.$this->encodePath($planId));
    }

    public function findByName(int $projectId, string $name)
    {
        $allPlans = $this->all($projectId);
        foreach ($allPlans as $plan) {
            if ($plan['name'] === $name) {
                return $plan;
            }
        }
        return [];
    }

    public function create(int $projectId, string $name, string $description = null, int $milestoneId = null)
    {
        $plan = $this->connector->send_post('add_plan/'.$this->encodePath($projectId),
            ['name' => $name,
                'description' => $description,
                'milestone_id' => $milestoneId]);
        unset($this->cache[$projectId]);
        return $plan;
    }

    public function createEntry(int $planId, int $suiteId, string $name, array $configIds = [], array $runs = [], string $description = null, bool $all = true, array $cases = [], int $assignedTo = null) {
        $entry = $this->connector->send_post('add_plan_entry/'.$this->encodePath($planId),
            ['suite_id' => $suiteId, 'name' => $name, 'description' => $description, 'include_all' => $all, 'case_ids' => $cases, 'config_ids' => $configIds, 'runs' => $runs, 'assignedto_id' => $assignedTo]);
        $this->cache = [];
        return $entry;
    }

    /**
     * @param int $planId
     * @param array $parameters {
     *      @var string       $name
     *      @var string       $description
     *      @var int        $milestone_id
     * }
     */
    public function update(int $planId, array $parameters = []) {
        $plan = $this->connector->send_post('update_plan/'.$this->encodePath($planId), $parameters);
        $this->cache = [];
        return $plan;
    }

    public function updateEntry(int $planId, int $entryId, array $parameters = []) {
        $entry = $this->connector->send_post('update_plan_entry/'.$this->encodePath($planId).'/'.$this->encodePath($entryId), $parameters);
        $this->cache = [];
        return $entry;
    }

    public function delete(int $planId) {
        $this->connector->send_post('delete_plan/'.$this->encodePath($planId), []);
        $this->cache = [];
    }

    public function deleteEntry(int $planId, int $entryId) {
        $this->connector->send_post('delete_plan_entry/'.$this->encodePath($planId).'/'.$this->encodePath($entryId), []);
        $this->cache = [];
    }

    public function close(int $planId) {
        $plan = $this->connector->send_post('close_plan/'.$this->encodePath($planId), []);
        $this->cache = [];
        return $plan;
    }
}