MDL-22054 converting block name strings to pluginname
[moodle.git] / blocks / tag_flickr / block_tag_flickr.php
1 <?php
3 require_once($CFG->dirroot.'/tag/lib.php');
4 require_once($CFG->libdir . '/filelib.php');
6 define('FLICKR_DEV_KEY', '4fddbdd7ff2376beec54d7f6afad425e');
7 define('DEFAULT_NUMBER_OF_PHOTOS', 6);
9 class block_tag_flickr extends block_base {
11     function init() {
12         $this->title = get_string('pluginname','block_tag_flickr');
13         $this->version = 2007101509;
14     }
16     function applicable_formats() {
17         return array('tag' => true);
18     }
20     function specialization() {
21         $this->title = !empty($this->config->title) ? $this->config->title : get_string('pluginname', 'block_tag_flickr');
22     }
24     function instance_allow_multiple() {
25         return true;
26     }
28     function preferred_width() {
29         return 170;
30     }
32     function get_content() {
34         global $CFG, $USER;
36         if ($this->content !== NULL) {
37             return $this->content;
38         }
40         $tagid = optional_param('id', 0, PARAM_INT);   // tag id - for backware compatibility
41         $tag = optional_param('tag', '', PARAM_TAG); // tag
43         if ($tag) {
44             $tagobject = tag_get('name', $tag);
45         } else if ($tagid) {
46             $tagobject = tag_get('id', $tagid);
47         }
49         if (empty($tagobject)) {
50             $this->content = new stdClass;
51             $this->content->text = '';
52             $this->content->footer = '';
53             return $this->content;
54         }
56         //include related tags in the photo query ?
57         $tagscsv = $tagobject->name;
58         if (!empty($this->config->includerelatedtags)) {
59             $tagscsv .= ',' . tag_get_related_tags_csv(tag_get_related_tags($tagobject->id), TAG_RETURN_TEXT);
60         }
61         $tagscsv = urlencode($tagscsv);
63         //number of photos to display
64         $numberofphotos = DEFAULT_NUMBER_OF_PHOTOS;
65         if( !empty($this->config->numberofphotos)) {
66             $numberofphotos = $this->config->numberofphotos;
67         }
69         //sort search results by
70         $sortby = 'relevance';
71         if( !empty($this->config->sortby)) {
72             $sortby = $this->config->sortby;
73         }
75         //pull photos from a specific photoset
76         if(!empty($this->config->photoset)){
78             $request = 'http://api.flickr.com/services/rest/?method=flickr.photosets.getPhotos';
79             $request .= '&api_key='.FLICKR_DEV_KEY;
80             $request .= '&photoset_id='.$this->config->photoset;
81             $request .= '&per_page='.$numberofphotos;
82             $request .= '&format=php_serial';
84             $response = $this->fetch_request($request);
86             $search = unserialize($response);
88             foreach ($search['photoset']['photo'] as $p){
89                 $p['owner'] = $search['photoset']['owner'];
90             }
92             $photos = array_values($search['photoset']['photo']);
94         }
95         //search for photos tagged with $tagscsv
96         else{
98             $request = 'http://api.flickr.com/services/rest/?method=flickr.photos.search';
99             $request .= '&api_key='.FLICKR_DEV_KEY;
100             $request .= '&tags='.$tagscsv;
101             $request .= '&per_page='.$numberofphotos;
102             $request .= '&sort='.$sortby;
103             $request .= '&format=php_serial';
105             $response = $this->fetch_request($request);
107             $search = unserialize($response);
108             $photos = array_values($search['photos']['photo']);
109         }
112         if(strcmp($search['stat'], 'ok') != 0) return; //if no results were returned, exit...
114         //Accessibility: render the list of photos
115         $text = '<ul class="inline-list">';
116          foreach ($photos as $photo) {
117             $text .= '<li><a href="http://www.flickr.com/photos/' . $photo['owner'] . '/' . $photo['id'] . '/" title="'.s($photo['title']).'">';
118             $text .= '<img alt="'.s($photo['title']).'" class="flickr-photos" src="'. $this->build_photo_url($photo, 'square') ."\" /></a></li>\n";
119          }
120         $text .= "</ul>\n";
122         $this->content = new stdClass;
123         $this->content->text = $text;
124         $this->content->footer = '';
126         return $this->content;
127     }
129     function fetch_request($request){
130         $c =  new curl(array('cache' => true, 'module_cache'=> 'tag_flickr'));
132         $response = $c->get($request);
134         return $response;
135     }
137     function build_photo_url ($photo, $size='medium') {
138         //receives an array (can use the individual photo data returned
139         //from an API call) and returns a URL (doesn't mean that the
140         //file size exists)
141         $sizes = array(
142             'square' => '_s',
143             'thumbnail' => '_t',
144             'small' => '_m',
145             'medium' => '',
146             'large' => '_b',
147             'original' => '_o'
148         );
150         $size = strtolower($size);
151         if (!array_key_exists($size, $sizes)) {
152             $size = 'medium';
153         }
155         if ($size == 'original') {
156             $url = 'http://farm' . $photo['farm'] . '.static.flickr.com/' . $photo['server'] . '/' . $photo['id'] . '_' . $photo['originalsecret'] . '_o' . '.' . $photo['originalformat'];
157         } else {
158             $url = 'http://farm' . $photo['farm'] . '.static.flickr.com/' . $photo['server'] . '/' . $photo['id'] . '_' . $photo['secret'] . $sizes[$size] . '.jpg';
159         }
160         return $url;
161     }