summaryrefslogtreecommitdiff
path: root/app/Core/ExternalTask/ExternalTaskProviderInterface.php
blob: 9e6727809328fa6cb28da24efe44431c4d60c0e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?php

namespace Kanboard\Core\ExternalTask;

/**
 * Interface ExternalTaskProviderInterface
 *
 * @package Kanboard\Core\ExternalTask
 * @author  Frederic Guillot
 */
interface ExternalTaskProviderInterface
{
    /**
     * Get templates
     *
     * @return string
     */
    public function getCreationFormTemplate();
    public function getModificationFormTemplate();
    public function getTaskViewTemplate();

    /**
     * Get provider name (visible in the user interface)
     *
     * @access public
     * @return string
     */
    public function getName();

    /**
     * Retrieve task from external system or cache
     *
     * @access public
     * @throws \Kanboard\Core\ExternalTask\AccessForbiddenException
     * @throws \Kanboard\Core\ExternalTask\NotFoundException
     * @param  string $uri
     * @return array       Dict that will populate the form
     */
    public function retrieve($uri);

    /**
     * Save the task to the external system and/or update the cache
     *
     * @access public
     * @param  string  $uri
     * @param  array   $data
     * @return bool
     */
    public function persist($uri, array $data);
}