class Favorites in Flickr API Integration 8

Class Favorites.

@package Drupal\flickr_api\Service

Hierarchy

• class \Drupal\flickr_api\Service\Favorites

1 string reference to 'Favorites'

flickr_api.services.yml in ./flickr_api.services.yml

flickr_api.services.yml

1 service uses Favorites

flickr_api.favorites in ./flickr_api.services.yml

Drupal\flickr_api\Service\Favorites

File

src/Service/Favorites.php, line 10

Namespace

Drupal\flickr_api\Service

class Favorites {

  /**
   * Client.
   *
   * @var \Drupal\flickr_api\Service\Client
   */
  protected $client;

  /**
   * Favorites constructor.
   *
   * @param \Drupal\flickr_api\Service\Client $client
   *   Client.
   */
  public function __construct(Client $client) {

    // Flickr API Client.
    $this->client = $client;
  }

  /**
   * Returns a list of favorite public photos for the given user.
   *
   * @param string $nsid
   *   NSID of the user whose photoset tags will be returned.
   * @param int $page
   *   Page of results to return.
   * @param array $otherArgs
   *   Other args.
   * @param bool $cacheable
   *   Cacheable.
   *
   * @return array
   *   Response from the flickr method flickr.favorites.getPublicList.
   *   (https://www.flickr.com/services/api/flickr.favorites.getPublicList.html)
   */
  public function favoritesGetPublicList($nsid, $page = 1, array $otherArgs = [], $cacheable = TRUE) {
    $args = [
      'user_id' => $nsid,
      'page' => $page,
    ];
    $args = array_merge($args, $otherArgs);

    // Set per_page to flickr_api module default if not specified in $args.
    if (!isset($args['per_page'])) {

      // TODO Expose pager as a setting.
      $args['per_page'] = 6;
    }
    $response = $this->client
      ->request('flickr.favorites.getPublicList', $args, $cacheable);
    if ($response) {
      return $response['photos'];
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Favorites::$client	protected	property	Client.
Favorites::favoritesGetPublicList	public	function	Returns a list of favorite public photos for the given user.
Favorites::__construct	public	function	Favorites constructor.