From 5c92f467867b43034b9e66b46b3b465ba9db655c Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Sat, 30 Jan 2016 20:38:20 -0500
Subject: Add external links for tasks with plugin api

---
 .../ExternalLink/ExternalLinkProviderInterface.php | 71 ++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 app/Core/ExternalLink/ExternalLinkProviderInterface.php

(limited to 'app/Core/ExternalLink/ExternalLinkProviderInterface.php')

diff --git a/app/Core/ExternalLink/ExternalLinkProviderInterface.php b/app/Core/ExternalLink/ExternalLinkProviderInterface.php
new file mode 100644
index 00000000..c908e1eb
--- /dev/null
+++ b/app/Core/ExternalLink/ExternalLinkProviderInterface.php
@@ -0,0 +1,71 @@
+<?php
+
+namespace Kanboard\Core\ExternalLink;
+
+/**
+ * External Link Provider Interface
+ *
+ * @package  externalLink
+ * @author   Frederic Guillot
+ */
+interface ExternalLinkProviderInterface
+{
+    /**
+     * Get provider name (label)
+     *
+     * @access public
+     * @return string
+     */
+    public function getName();
+
+    /**
+     * Get link type (will be saved in the database)
+     *
+     * @access public
+     * @return string
+     */
+    public function getType();
+
+    /**
+     * Get a dictionary of supported dependency types by the provider
+     *
+     * Example:
+     *
+     * [
+     *     'related' => t('Related'),
+     *     'child' => t('Child'),
+     *     'parent' => t('Parent'),
+     *     'self' => t('Self'),
+     * ]
+     *
+     * The dictionary key is saved in the database.
+     *
+     * @access public
+     * @return array
+     */
+    public function getDependencies();
+
+    /**
+     * Set text entered by the user
+     *
+     * @access public
+     * @param  string $input
+     */
+    public function setUserTextInput($input);
+
+    /**
+     * Return true if the provider can parse correctly the user input
+     *
+     * @access public
+     * @return boolean
+     */
+    public function match();
+
+    /**
+     * Get the link found with the properties
+     *
+     * @access public
+     * @return ExternalLinkInterface
+     */
+    public function getLink();
+}
-- 
cgit v1.2.3