diff options
Diffstat (limited to 'app/Core/ExternalTask')
-rw-r--r-- | app/Core/ExternalTask/AccessForbiddenException.php | 13 | ||||
-rw-r--r-- | app/Core/ExternalTask/ExternalTaskException.php | 15 | ||||
-rw-r--r-- | app/Core/ExternalTask/ExternalTaskInterface.php | 26 | ||||
-rw-r--r-- | app/Core/ExternalTask/ExternalTaskManager.php | 58 | ||||
-rw-r--r-- | app/Core/ExternalTask/ExternalTaskProviderInterface.php | 77 | ||||
-rw-r--r-- | app/Core/ExternalTask/NotFoundException.php | 13 | ||||
-rw-r--r-- | app/Core/ExternalTask/ProviderNotFoundException.php | 13 |
7 files changed, 215 insertions, 0 deletions
diff --git a/app/Core/ExternalTask/AccessForbiddenException.php b/app/Core/ExternalTask/AccessForbiddenException.php new file mode 100644 index 00000000..2b5ebd33 --- /dev/null +++ b/app/Core/ExternalTask/AccessForbiddenException.php @@ -0,0 +1,13 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +/** + * Class AccessForbiddenException + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +class AccessForbiddenException extends ExternalTaskException +{ +} diff --git a/app/Core/ExternalTask/ExternalTaskException.php b/app/Core/ExternalTask/ExternalTaskException.php new file mode 100644 index 00000000..07e5665d --- /dev/null +++ b/app/Core/ExternalTask/ExternalTaskException.php @@ -0,0 +1,15 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +use Exception; + +/** + * Class NotFoundException + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +class ExternalTaskException extends Exception +{ +} diff --git a/app/Core/ExternalTask/ExternalTaskInterface.php b/app/Core/ExternalTask/ExternalTaskInterface.php new file mode 100644 index 00000000..084af509 --- /dev/null +++ b/app/Core/ExternalTask/ExternalTaskInterface.php @@ -0,0 +1,26 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +/** + * Interface ExternalTaskInterface + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +interface ExternalTaskInterface +{ + /** + * Return Uniform Resource Identifier for the task + * + * @return string + */ + public function getUri(); + + /** + * Return a dict to populate the task form + * + * @return array + */ + public function getFormValues(); +} diff --git a/app/Core/ExternalTask/ExternalTaskManager.php b/app/Core/ExternalTask/ExternalTaskManager.php new file mode 100644 index 00000000..102ec459 --- /dev/null +++ b/app/Core/ExternalTask/ExternalTaskManager.php @@ -0,0 +1,58 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +/** + * Class ExternalTaskManager + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +class ExternalTaskManager +{ + protected $providers = array(); + + /** + * Register a new task provider + * + * @param ExternalTaskProviderInterface $externalTaskProvider + * @return $this + */ + public function register(ExternalTaskProviderInterface $externalTaskProvider) + { + $this->providers[$externalTaskProvider->getName()] = $externalTaskProvider; + return $this; + } + + /** + * Get task provider + * + * @param string $name + * @return ExternalTaskProviderInterface|null + * @throws ProviderNotFoundException + */ + public function getProvider($name) + { + if (isset($this->providers[$name])) { + return $this->providers[$name]; + } + + throw new ProviderNotFoundException('Unable to load this provider: '.$name); + } + + /** + * Get list of task providers + * + * @return array + */ + public function getProvidersList() + { + $providers = array_keys($this->providers); + + if (count($providers)) { + return array_combine($providers, $providers); + } + + return array(); + } +} diff --git a/app/Core/ExternalTask/ExternalTaskProviderInterface.php b/app/Core/ExternalTask/ExternalTaskProviderInterface.php new file mode 100644 index 00000000..f67f7552 --- /dev/null +++ b/app/Core/ExternalTask/ExternalTaskProviderInterface.php @@ -0,0 +1,77 @@ +<?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(); + + /** + * 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); +} diff --git a/app/Core/ExternalTask/NotFoundException.php b/app/Core/ExternalTask/NotFoundException.php new file mode 100644 index 00000000..34eff8ea --- /dev/null +++ b/app/Core/ExternalTask/NotFoundException.php @@ -0,0 +1,13 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +/** + * Class NotFoundException + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +class NotFoundException extends ExternalTaskException +{ +} diff --git a/app/Core/ExternalTask/ProviderNotFoundException.php b/app/Core/ExternalTask/ProviderNotFoundException.php new file mode 100644 index 00000000..6ad1fae1 --- /dev/null +++ b/app/Core/ExternalTask/ProviderNotFoundException.php @@ -0,0 +1,13 @@ +<?php + +namespace Kanboard\Core\ExternalTask; + +/** + * Class ProviderNotFoundException + * + * @package Kanboard\Core\ExternalTask + * @author Frederic Guillot + */ +class ProviderNotFoundException extends ExternalTaskException +{ +} |