summaryrefslogtreecommitdiff
path: root/vendor/OAuth/Common/Storage/TokenStorageInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/OAuth/Common/Storage/TokenStorageInterface.php')
-rwxr-xr-xvendor/OAuth/Common/Storage/TokenStorageInterface.php98
1 files changed, 98 insertions, 0 deletions
diff --git a/vendor/OAuth/Common/Storage/TokenStorageInterface.php b/vendor/OAuth/Common/Storage/TokenStorageInterface.php
new file mode 100755
index 00000000..46552cee
--- /dev/null
+++ b/vendor/OAuth/Common/Storage/TokenStorageInterface.php
@@ -0,0 +1,98 @@
+<?php
+
+namespace OAuth\Common\Storage;
+
+use OAuth\Common\Token\TokenInterface;
+use OAuth\Common\Storage\Exception\TokenNotFoundException;
+
+/**
+ * All token storage providers must implement this interface.
+ */
+interface TokenStorageInterface
+{
+ /**
+ * @param string $service
+ *
+ * @return TokenInterface
+ *
+ * @throws TokenNotFoundException
+ */
+ public function retrieveAccessToken($service);
+
+ /**
+ * @param string $service
+ * @param TokenInterface $token
+ *
+ * @return TokenStorageInterface
+ */
+ public function storeAccessToken($service, TokenInterface $token);
+
+ /**
+ * @param string $service
+ *
+ * @return bool
+ */
+ public function hasAccessToken($service);
+
+ /**
+ * Delete the users token. Aka, log out.
+ *
+ * @param string $service
+ *
+ * @return TokenStorageInterface
+ */
+ public function clearToken($service);
+
+ /**
+ * Delete *ALL* user tokens. Use with care. Most of the time you will likely
+ * want to use clearToken() instead.
+ *
+ * @return TokenStorageInterface
+ */
+ public function clearAllTokens();
+
+ /**
+ * Store the authorization state related to a given service
+ *
+ * @param string $service
+ * @param string $state
+ *
+ * @return TokenStorageInterface
+ */
+ public function storeAuthorizationState($service, $state);
+
+ /**
+ * Check if an authorization state for a given service exists
+ *
+ * @param string $service
+ *
+ * @return bool
+ */
+ public function hasAuthorizationState($service);
+
+ /**
+ * Retrieve the authorization state for a given service
+ *
+ * @param string $service
+ *
+ * @return string
+ */
+ public function retrieveAuthorizationState($service);
+
+ /**
+ * Clear the authorization state of a given service
+ *
+ * @param string $service
+ *
+ * @return TokenStorageInterface
+ */
+ public function clearAuthorizationState($service);
+
+ /**
+ * Delete *ALL* user authorization states. Use with care. Most of the time you will likely
+ * want to use clearAuthorization() instead.
+ *
+ * @return TokenStorageInterface
+ */
+ public function clearAllAuthorizationStates();
+}