src/Module/Api/Twitter/FriendsList.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Api\Twitter;
  23
  24 use Friendica\Core\System;
  25 use Friendica\Model\Contact;
  26
  27 /**
  28  * @see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list
  29  */
  30 class FriendsList extends ContactEndpoint
  31 {
  32         public static function rawContent(array $parameters = [])
  33         {
  34                 // Expected value for user_id parameter: public/user contact id
  35                 $contact_id    = filter_input(INPUT_GET, 'user_id'      , FILTER_VALIDATE_INT);
  36                 $screen_name   = filter_input(INPUT_GET, 'screen_name');
  37                 $cursor        = filter_input(INPUT_GET, 'cursor'       , FILTER_VALIDATE_INT);
  38                 $count         = filter_input(INPUT_GET, 'count'        , FILTER_VALIDATE_INT, ['options' => [
  39                         'default' => self::DEFAULT_COUNT,
  40                         'min_range' => 1,
  41                         'max_range' => self::MAX_COUNT,
  42                 ]]);
  43                 $skip_status           = filter_input(INPUT_GET, 'skip_status'          , FILTER_VALIDATE_BOOLEAN);
  44                 $include_user_entities = filter_input(INPUT_GET, 'include_user_entities', FILTER_VALIDATE_BOOLEAN);
  45
  46                 // Friendica-specific
  47                 $since_id      = filter_input(INPUT_GET, 'since_id'     , FILTER_VALIDATE_INT);
  48                 $max_id        = filter_input(INPUT_GET, 'max_id'       , FILTER_VALIDATE_INT, ['options' => [
  49                         'default' => 1,
  50                 ]]);
  51
  52                 System::jsonExit(self::list(
  53                         [Contact::SHARING, Contact::FRIEND],
  54                         self::getUid($contact_id, $screen_name),
  55                         $cursor ?? $since_id ?? - $max_id,
  56                         $count,
  57                         $skip_status,
  58                         $include_user_entities
  59                 ));
  60         }
  61 }