summaryrefslogtreecommitdiff
path: root/vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php')
-rw-r--r--vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php49
1 files changed, 49 insertions, 0 deletions
diff --git a/vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php b/vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php
new file mode 100644
index 00000000..5856a039
--- /dev/null
+++ b/vendor/lusitanian/oauth/src/OAuth/Common/Service/ServiceInterface.php
@@ -0,0 +1,49 @@
+<?php
+
+namespace OAuth\Common\Service;
+
+use OAuth\Common\Http\Uri\UriInterface;
+
+/**
+ * Defines methods common among all OAuth services.
+ */
+interface ServiceInterface
+{
+ /**
+ * Sends an authenticated API request to the path provided.
+ * If the path provided is not an absolute URI, the base API Uri (service-specific) will be used.
+ *
+ * @param string|UriInterface $path
+ * @param string $method HTTP method
+ * @param array $body Request body if applicable (an associative array will
+ * automatically be converted into a urlencoded body)
+ * @param array $extraHeaders Extra headers if applicable. These will override service-specific
+ * any defaults.
+ *
+ * @return string
+ */
+ public function request($path, $method = 'GET', $body = null, array $extraHeaders = array());
+
+ /**
+ * Returns the url to redirect to for authorization purposes.
+ *
+ * @param array $additionalParameters
+ *
+ * @return UriInterface
+ */
+ public function getAuthorizationUri(array $additionalParameters = array());
+
+ /**
+ * Returns the authorization API endpoint.
+ *
+ * @return UriInterface
+ */
+ public function getAuthorizationEndpoint();
+
+ /**
+ * Returns the access token API endpoint.
+ *
+ * @return UriInterface
+ */
+ public function getAccessTokenEndpoint();
+}