Support collections

Author: GuLinux

blueprints.yaml

@@ -37,4 +37,8 @@ form:
       type: text
       size: medium
       label: Flickr API Key
+    flickr_user_id:
+      type: text
+      size: medium
+      label: Flickr User ID
 

classes/Collection.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Grav\Plugin\Flickr;
+require_once(__DIR__.'/Photoset.php');
+use Grav\Plugin\Flickr\Photoset;
+
+use Grav\Common\Grav;
+
+class Collection
+{
+    private $info;
+    private $collections;
+    private $sets;
+    
+    public function __construct($tree, $api)
+    {
+        $this->info = $tree;
+        $this->collections = [];
+        $this->sets = [];
+        dump($tree);
+        if(is_array($tree['collection'])) {
+            foreach($tree['collection'] as $collection) {
+                $this->collections[] = new Collection($collection, $api);
+            }
+        }
+        if(is_array($tree['set'])) {
+            foreach($tree['set'] as $set) {
+                $this->sets[] = $api->photoset($set['id'], []);
+            }
+        }
+        dump($this->collections);
+        dump($this->sets);
+    }
+
+    
+    public function title() {
+        return $this->info["title"];
+    }
+    public function description() {
+        return $this->info["description"];
+    }
+    
+    public function collections() {
+        return $this->collections;
+    }
+    
+    public function sets() {
+        return $this->sets;
+    }
+}

classes/FlickrAPI.php

@@ -2,9 +2,11 @@
 
 namespace Grav\Plugin\Flickr;
 require_once(__DIR__.'/Photoset.php');
+require_once(__DIR__.'/Collection.php');
 
 use Grav\Common\Grav;
 use Grav\Plugin\Flickr\Photoset;
+use Grav\Plugin\Flickr\Collection;
 use Grav\Common\GPM\Response;
 use Grav\Common\Cache;
 
@@ -19,6 +21,7 @@ class FlickrAPI
 {
     protected $key;
     protected $secret;
+    protected $user_id;
     protected $grav;
     protected $config;
     protected $cache;
@@ -32,26 +35,41 @@ public function __construct()
         $this->config = $this->grav['config'];
         $this->key = $this->config->get('plugins.flickr.flickr_api_key');
         $this->secret = $this->config->get('plugins.flickr.flickr_api_secret');        
+        $this->user_id = $this->config->get('plugins.flickr.flickr_user_id');        
         $this->cache = new Cache($this->grav);
     }
 
-    /**
-     * do some work
-     */
     public function photoset($id, $params)
     {
         $info = $this->request( ['method' => 'flickr.photosets.getInfo', 'photoset_id' => $id ])['photoset'];
         $get_photos_params = array_merge(
             [ "method" => "flickr.photosets.getPhotos", "photoset_id" => $id, 'user_id' => $info['owner'], 'extras' => 
-                'license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_m, url_o' ],
+                'license,date_upload,date_taken,owner_name,icon_server,original_format,last_update,geo,tags,machine_tags,views,media' ],
             $this->get_params($params, ['page', 'per_page', 'privacy_filter', 'media']));
 
         $photos = $this->request( $get_photos_params )['photoset'];
         return new Photoset($info, $photos);
     }
 
+    public function photo($id)
+    {
+        $info = $this->request( ['method' => 'flickr.photos.getInfo', 'photo_id' => $id ])['photo'];        
+        return new Photo($info);
+    }
+    
+    public function collection($id)
+    {
+        $info = $this->request( ['method' => 'flickr.collections.getTree', 'collection_id' => $id ])['collections'];
+        foreach($info['collection'] as $collection) {
+            if( ! strpos($collection['id'], $id) ) {
+                return new Collection($collection, $this);
+            }
+        }
+        return null; // TODO
+    }
+    
     private function request($params) {
-        $url = 'https://api.flickr.com/services/rest/?' . http_build_query(array_merge($params, ['api_key' => $this->key, 'format' => 'php_serial']));
+        $url = 'https://api.flickr.com/services/rest/?' . http_build_query(array_merge($params, ['api_key' => $this->key, 'format' => 'php_serial', 'user_id' => $this->user_id]));
         $obj = $this->cache->fetch($url);
         if($obj) {
             return $obj;

classes/Photo.php

@@ -18,11 +18,11 @@ public function id() {
     }
 
     public function title() {
-        return $this->info['title'];
+        return $this->content($this->info['title']);
     }
 
     public function datetaken() {
-        return $this->info['datetaken'];
+        return $this->content($this->info['datetaken']);
     }
 
     public function url($format) {
@@ -34,5 +34,9 @@ public function url($format) {
         }
         return 'https://farm' . $this->info['farm'] . '.staticflickr.com/' . $this->info['server'] . '/' . $this->info['id'] . '_' . $this->info['secret'] . '.jpg';
     }
+    
+    private function content($val) {
+        return is_array($val) ? $val['_content'] : $val;
+    }
 }
 

flickr.yaml

@@ -1,4 +1,5 @@
 enabled: true
 flickr_api_key: ""
 flickr_api_secret: ""
+flickr_user_id: ""
 

shortcodes/FlickrCollectionShortcode.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Grav\Plugin\Shortcodes;
+require_once(__DIR__.'/../classes/FlickrAPI.php');
+use Grav\Common\Utils;
+use Thunder\Shortcode\Shortcode\ShortcodeInterface;
+use Grav\Plugin\Flickr\FlickrAPI;
+use Grav\Plugin\Flickr\FlickrAPIException;
+use Grav\Plugin\Flickr\Photoset;
+
+class FlickrCollectionShortcode extends Shortcode
+{
+    public function init()
+    {
+        $this->shortcode->getHandlers()->add('flickr-collection', function(ShortcodeInterface $sc) {
+            $content = $sc->getContent();
+            $id = $sc->getParameter('id', '');
+            $api = new FlickrAPI();
+            $params = array_merge(['display-format-photo' => 's', 'display-format-photo-lightbox' => 'z'], $sc->getParameters());
+            try {
+                $collection = $api->collection($id );
+                $output = $this->twig->processTemplate('partials/flickr-collection.html.twig', [
+                    'collection' => $collection,
+                    'params' => $params,
+                ]);
+
+                return $output;
+            } catch(FlickrAPIException $e) {
+                return $e->getMessage();
+            }
+        });
+    }
+}
+ 

shortcodes/FlickrPhotoShortcode.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Grav\Plugin\Shortcodes;
+require_once(__DIR__.'/../classes/FlickrAPI.php');
+use Grav\Common\Utils;
+use Thunder\Shortcode\Shortcode\ShortcodeInterface;
+use Grav\Plugin\Flickr\FlickrAPI;
+use Grav\Plugin\Flickr\FlickrAPIException;
+use Grav\Plugin\Flickr\Photoset;
+
+class FlickrPhotoShortcode extends Shortcode
+{
+    public function init()
+    {
+        $this->shortcode->getHandlers()->add('flickr-photo', function(ShortcodeInterface $sc) {
+            $content = $sc->getContent();
+            $id = $sc->getParameter('id', '');
+            $api = new FlickrAPI();
+            $params = array_merge(['display-format-photo' => 's', 'display-format-photo-lightbox' => 'z'], $sc->getParameters());
+            try {
+                $photo = $api->photo($id );
+                $output = $this->twig->processTemplate('partials/flickr-photo.html.twig', [
+                    'photo' => $photo,
+                    'params' => $params,
+                ]);
+
+                return $output;
+            } catch(FlickrAPIException $e) {
+                return $e->getMessage();
+            }
+        });
+    }
+}

templates/partials/flickr-collection.html.twig

@@ -0,0 +1,10 @@
+<div class="flickr flickr-collection">
+<h2>{{ collection.title() }}</h2>
+<h3>{{ collection.description() }}</h3>
+{% for set in collection.sets() %}
+    {% include 'partials/flickr-photoset.html.twig' with {'photoset':set} %}
+{% endfor %}
+</div>
+{% for current in collection.collections() %}
+    {% include 'partials/flickr-collection.html.twig' with {'collection':current} %}
+{% endfor %}

templates/partials/flickr-photo-lightbox.html.twig

@@ -1,5 +1,5 @@
  <div id="lightbox-{{ photo.id() }}" class="flickr-lightbox">
     <img src="{{ photo.url(params['display-format-photo-lightbox']) }}">
     <figcaption>{{ photo.title() }}</figcaption>
-    <span><a href="{{ photo.url('o') }}" target='_blank'>High resolution version</a></span>
+    <span><a href="{{ photo.url('o') }}" target='_blank'>Original version</a></span>
 </div>