]> git.mxchange.org Git - friendica.git/commitdiff
Move Module\Base\Api to Module\BaseApi
authorHypolite Petovan <hypolite@mrpetovan.com>
Tue, 28 Jan 2020 02:18:42 +0000 (21:18 -0500)
committerHypolite Petovan <hypolite@mrpetovan.com>
Tue, 28 Jan 2020 02:18:42 +0000 (21:18 -0500)
src/Module/Api/Mastodon/FollowRequests.php
src/Module/Api/Mastodon/Instance.php
src/Module/Api/Mastodon/Instance/Peers.php
src/Module/Base/Api.php [deleted file]
src/Module/BaseApi.php [new file with mode: 0644]

index 79fe487834f0d6c5440dd7665fc1432f337e767c..3b2de61bcc3345189cdcad456a2ac39ca300a749 100644 (file)
@@ -2,18 +2,15 @@
 
 namespace Friendica\Module\Api\Mastodon;
 
-use Friendica\Object\Api\Mastodon;
-use Friendica\Object\Api\Mastodon\Relationship;
 use Friendica\Core\System;
 use Friendica\DI;
-use Friendica\Model\Contact;
-use Friendica\Module\Base\Api;
+use Friendica\Module\BaseApi;
 use Friendica\Network\HTTPException;
 
 /**
  * @see https://docs.joinmastodon.org/methods/accounts/follow_requests
  */
-class FollowRequests extends Api
+class FollowRequests extends BaseApi
 {
        public static function init(array $parameters = [])
        {
index c3d1b93ac0e215d4ac6d2b5b10fd510b1847bd4e..927642887514e9afa8c1e2c6f05e387bbb4d9590 100644 (file)
@@ -2,14 +2,14 @@
 
 namespace Friendica\Module\Api\Mastodon;
 
-use Friendica\Object\Api\Mastodon\Instance as InstanceEntity;
 use Friendica\Core\System;
-use Friendica\Module\Base\Api;
+use Friendica\Module\BaseApi;
+use Friendica\Object\Api\Mastodon\Instance as InstanceEntity;
 
 /**
  * @see https://docs.joinmastodon.org/api/rest/instances/
  */
-class Instance extends Api
+class Instance extends BaseApi
 {
        /**
         * @param array $parameters
index 5eaf355cc2df15cf7b387a60b96b581ddf0c47e6..99c878fcbb5afc986870d5d059fdeab46eea2bf2 100644 (file)
@@ -5,14 +5,14 @@ namespace Friendica\Module\Api\Mastodon\Instance;
 use Friendica\Core\Protocol;
 use Friendica\Core\System;
 use Friendica\Database\DBA;
-use Friendica\Module\Base\Api;
+use Friendica\Module\BaseApi;
 use Friendica\Network\HTTPException;
 use Friendica\Util\Network;
 
 /**
  * Undocumented API endpoint that is implemented by both Mastodon and Pleroma
  */
-class Peers extends Api
+class Peers extends BaseApi
 {
        /**
         * @param array $parameters
diff --git a/src/Module/Base/Api.php b/src/Module/Base/Api.php
deleted file mode 100644 (file)
index 7349f45..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-<?php
-
-namespace Friendica\Module\Base;
-
-use Friendica\BaseModule;
-use Friendica\DI;
-use Friendica\Network\HTTPException;
-
-require_once __DIR__ . '/../../../include/api.php';
-
-class Api extends BaseModule
-{
-       /**
-        * @var string json|xml|rss|atom
-        */
-       protected static $format = 'json';
-       /**
-        * @var bool|int
-        */
-       protected static $current_user_id;
-
-       public static function init(array $parameters = [])
-       {
-               $arguments = DI::args();
-
-               if (substr($arguments->getQueryString(), -4) === '.xml') {
-                       self::$format = 'xml';
-               }
-               if (substr($arguments->getQueryString(), -4) === '.rss') {
-                       self::$format = 'rss';
-               }
-               if (substr($arguments->getQueryString(), -4) === '.atom') {
-                       self::$format = 'atom';
-               }
-       }
-
-       public static function post(array $parameters = [])
-       {
-               if (!api_user()) {
-                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
-               }
-
-               $a = DI::app();
-
-               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
-                       throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
-               }
-       }
-
-       /**
-        * Log in user via OAuth1 or Simple HTTP Auth.
-        *
-        * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
-        *
-        * @return bool Was a user authenticated?
-        * @throws HTTPException\ForbiddenException
-        * @throws HTTPException\UnauthorizedException
-        * @throws HTTPException\InternalServerErrorException
-        * @hook  'authenticate'
-        *               array $addon_auth
-        *               'username' => username from login form
-        *               'password' => password from login form
-        *               'authenticated' => return status,
-        *               'user_record' => return authenticated user record
-        */
-       protected static function login()
-       {
-               api_login(DI::app());
-
-               self::$current_user_id = api_user();
-
-               return (bool)self::$current_user_id;
-       }
-
-       /**
-        * Get user info array.
-        *
-        * @param int|string $contact_id Contact ID or URL
-        * @return array|bool
-        * @throws HTTPException\BadRequestException
-        * @throws HTTPException\InternalServerErrorException
-        * @throws HTTPException\UnauthorizedException
-        * @throws \ImagickException
-        */
-       protected static function getUser($contact_id = null)
-       {
-               return api_get_user(DI::app(), $contact_id);
-       }
-
-       protected static function format($root_element, $data)
-       {
-               switch (self::$format) {
-                       case "atom":
-                       case "rss":
-                       case "xml":
-                               $ret = api_create_xml($data, $root_element);
-                               break;
-                       case "json":
-                       default:
-                               $ret = $data;
-                               break;
-               }
-
-               return $ret;
-       }
-}
diff --git a/src/Module/BaseApi.php b/src/Module/BaseApi.php
new file mode 100644 (file)
index 0000000..81814bb
--- /dev/null
@@ -0,0 +1,106 @@
+<?php
+
+namespace Friendica\Module;
+
+use Friendica\BaseModule;
+use Friendica\DI;
+use Friendica\Network\HTTPException;
+
+require_once __DIR__ . '/../../include/api.php';
+
+class BaseApi extends BaseModule
+{
+       /**
+        * @var string json|xml|rss|atom
+        */
+       protected static $format = 'json';
+       /**
+        * @var bool|int
+        */
+       protected static $current_user_id;
+
+       public static function init(array $parameters = [])
+       {
+               $arguments = DI::args();
+
+               if (substr($arguments->getQueryString(), -4) === '.xml') {
+                       self::$format = 'xml';
+               }
+               if (substr($arguments->getQueryString(), -4) === '.rss') {
+                       self::$format = 'rss';
+               }
+               if (substr($arguments->getQueryString(), -4) === '.atom') {
+                       self::$format = 'atom';
+               }
+       }
+
+       public static function post(array $parameters = [])
+       {
+               if (!api_user()) {
+                       throw new HTTPException\UnauthorizedException(DI::l10n()->t('Permission denied.'));
+               }
+
+               $a = DI::app();
+
+               if (!empty($a->user['uid']) && $a->user['uid'] != api_user()) {
+                       throw new HTTPException\ForbiddenException(DI::l10n()->t('Permission denied.'));
+               }
+       }
+
+       /**
+        * Log in user via OAuth1 or Simple HTTP Auth.
+        *
+        * Simple Auth allow username in form of <pre>user@server</pre>, ignoring server part
+        *
+        * @return bool Was a user authenticated?
+        * @throws HTTPException\ForbiddenException
+        * @throws HTTPException\UnauthorizedException
+        * @throws HTTPException\InternalServerErrorException
+        * @hook  'authenticate'
+        *               array $addon_auth
+        *               'username' => username from login form
+        *               'password' => password from login form
+        *               'authenticated' => return status,
+        *               'user_record' => return authenticated user record
+        */
+       protected static function login()
+       {
+               api_login(DI::app());
+
+               self::$current_user_id = api_user();
+
+               return (bool)self::$current_user_id;
+       }
+
+       /**
+        * Get user info array.
+        *
+        * @param int|string $contact_id Contact ID or URL
+        * @return array|bool
+        * @throws HTTPException\BadRequestException
+        * @throws HTTPException\InternalServerErrorException
+        * @throws HTTPException\UnauthorizedException
+        * @throws \ImagickException
+        */
+       protected static function getUser($contact_id = null)
+       {
+               return api_get_user(DI::app(), $contact_id);
+       }
+
+       protected static function format($root_element, $data)
+       {
+               switch (self::$format) {
+                       case "atom":
+                       case "rss":
+                       case "xml":
+                               $ret = api_create_xml($data, $root_element);
+                               break;
+                       case "json":
+                       default:
+                               $ret = $data;
+                               break;
+               }
+
+               return $ret;
+       }
+}