summaryrefslogtreecommitdiff
path: root/app/Core/ExternalTask/ExternalTaskProviderInterface.php
blob: 5678efb8a02f0b7177b261ad19b848f46291e13d (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<?php

namespace Kanboard\Core\ExternalTask;

/**
 * Interface ExternalTaskProviderInterface
 *
 * @package Kanboard\Core\ExternalTask
 * @author  Frederic Guillot
 */
interface ExternalTaskProviderInterface
{
    /**
     * Get provider name (visible in the user interface)
     *
     * @access public
     * @return string
     */
    public function getName();

    /**
     * Get provider icon
     *
     * @access public
     * @return string
     */
    public function getIcon();

    /**
     * Get label for adding a new task
     *
     * @access public
     * @return string
     */
    public function getMenuAddLabel();

    /**
     * Retrieve task from external system or cache
     *
     * @access public
     * @throws \Kanboard\Core\ExternalTask\ExternalTaskException
     * @param  string $uri
     * @return ExternalTaskInterface
     */
    public function fetch($uri);

    /**
     * Save external task to another system
     *
     * @throws \Kanboard\Core\ExternalTask\ExternalTaskException
     * @param  string $uri
     * @param  array  $formValues
     * @param  array  $formErrors
     * @return bool
     */
    public function save($uri, array $formValues, array &$formErrors);

    /**
     * Get task import template name
     *
     * @return string
     */
    public function getImportFormTemplate();

    /**
     * Get creation form template
     *
     * @return string
     */
    public function getCreationFormTemplate();

    /**
     * Get modification form template
     *
     * @return string
     */
    public function getModificationFormTemplate();

    /**
     * Get task view template name
     *
     * @return string
     */
    public function getViewTemplate();

    /**
     * Build external task URI based on import form values
     *
     * @param  array $formValues
     * @return string
     */
    public function buildTaskUri(array $formValues);
}