]> gitweb.fluxo.info Git - lorea/elgg.git/commitdiff
brought the simplepie plugin up to Elgg coding standards
authorcash <cash.costello@gmail.com>
Sun, 4 Jul 2010 19:39:29 +0000 (19:39 +0000)
committercash <cash.costello@gmail.com>
Sun, 4 Jul 2010 19:39:29 +0000 (19:39 +0000)
README
languages/en.php
sp_compatibility_test.php
start.php
views/default/settings/simplepie/edit.php
views/default/widgets/feed_reader/edit.php
views/default/widgets/feed_reader/view.php

diff --git a/README b/README
index bbfb946358f358f030e887a6fe11f7a6debf8f44..81f5dcd7db3bbc97acdfc9079dd8859b1c431f28 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,20 @@
-Widget Title\r
----------------------------\r
-To change the widget title, edit the language file (en.php) and change the string simplepie:widget from Blog to whatever you desire.\r
-\r
-\r
-Proxy Server\r
-----------------------------\r
-If your site is going through a proxy server to get to the feeds, you may want to increase the timeout on the feeds (though this is unlikely as the default timeout is 10 seconds). You can do this by editing simplepie/views/default/widgets/feed_reader/view.php. There you can just uncomment the line $feed->set_timeout(20);
\ No newline at end of file
+Widget Title
+---------------------------
+To change the widget title, edit the language file (en.php) and change the 
+string 'simplepie:widget' from 'RSS Feed' to whatever you desire.
+
+
+Proxy Server
+----------------------------
+If your site is going through a proxy server to get to the feeds, you may 
+want to increase the timeout on the feeds (though this is unlikely as the 
+default timeout is 10 seconds). You can do this by editing 
+simplepie/views/default/widgets/feed_reader/view.php. There you can just 
+uncomment the line $feed->set_timeout(20);
+
+
+Images
+--------------------------
+Currently, images are stripped from the feeds as they are likely larger 
+than the width of the widget and will cause display issues. To include
+images, edit the widget view and add the img tag to the $allow_tags array.
\ No newline at end of file
index 83841088abb29436ee1f61d9a54441cea5037e3b..e6c66b27faf464eab43eb17e8f381dea4023e8fa 100644 (file)
@@ -1,16 +1,15 @@
 <?php\r
 \r
-       $english = array(       \r
-      'simplepie:widget' => 'Blog',\r
-      'simplepie:description' => 'Add an external blog to your profile',\r
-      'simplepie:notset' => 'Feed url is not set',\r
-      'simplepie:notfind' => 'Cannot find feed. Check the feed url.',\r
-      'simplepie:feed_url' => 'Feed URL',\r
-      'simplepie:num_items' => 'Number of items',\r
-      'simplepie:excerpt' => 'Include excerpt',        \r
-      'simplepie:post_date' => 'Include post date',    \r
-       );\r
-                                       \r
-       add_translation("en",$english);\r
+$english = array(\r
+       'simplepie:widget' => 'RSS Feed',\r
+       'simplepie:description' => 'Add an external blog to your profile',\r
+       'simplepie:notset' => 'Feed url is not set',\r
+       'simplepie:notfind' => 'Cannot find feed. Check the feed url.',\r
+       'simplepie:feed_url' => 'Feed URL',\r
+       'simplepie:num_items' => 'Number of items',\r
+       'simplepie:excerpt' => 'Include excerpt',\r
+       'simplepie:post_date' => 'Include post date',\r
+);\r
+\r
+add_translation("en", $english);\r
 \r
-?>\r
index 638a13cf0323e5d152742afab0ad97b5e0078ebd..0448aa01dac184d56728802962e32deb1be1b04e 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 
-  // this is a quick hack of the compatibility script included with simple pie
+// this is a quick hack of the compatibility script included with simple pie
 
-  // Load Elgg engine
-  require_once(dirname(dirname(dirname(__FILE__))) . "/engine/start.php");
+// Load Elgg engine
+require_once(dirname(dirname(dirname(__FILE__))) . "/engine/start.php");
 
 $php_ok = (function_exists('version_compare') && version_compare(phpversion(), '4.3.0', '>='));
 $xml_ok = extension_loaded('xml');
index 5f138ff4d3d668d71ab75e7d338b7c8080b65335..538c5625c7d9cee47921fc0a67571665a3bcc75b 100644 (file)
--- a/start.php
+++ b/start.php
@@ -1,17 +1,16 @@
 <?php\r
 \r
-  /**\r
-   * Simplepie Plugin\r
-   * \r
-   * Loads the simplepie feed parser library \r
-   **/\r
-  \r
-  function simplepie_init() \r
-  {    \r
-    add_widget_type('feed_reader', elgg_echo('simplepie:widget'), elgg_echo('simplepie:description'));\r
-  \r
-    extend_view('css','feed_reader/css');\r
-  }\r
-  \r
-  register_elgg_event_handler('plugins_boot', 'system', 'simplepie_init');\r
-?>\r
+/**\r
+* Simplepie Plugin\r
+* \r
+* Loads the simplepie feed parser library and provides a widget\r
+**/\r
+\r
+function simplepie_init() {\r
+       add_widget_type('feed_reader', elgg_echo('simplepie:widget'), elgg_echo('simplepie:description'));\r
+\r
+       extend_view('css','feed_reader/css');\r
+}\r
+\r
+register_elgg_event_handler('plugins_boot', 'system', 'simplepie_init');\r
+\r
index ae6cbf9de3742c61aea7de2404e5692943ab4251..4583394c3e3d11d64799d8e69ec08e208c4714fe 100644 (file)
@@ -1,8 +1,8 @@
 <?php
-  global $CONFIG;
-  
-  $compat_url = $CONFIG->wwwroot . 'mod/simplepie/sp_compatibility_test.php';
-  $permit_url = $CONFIG->wwwroot . 'mod/simplepie/permissions.php';
+global $CONFIG;
+
+$compat_url = $CONFIG->wwwroot . 'mod/simplepie/sp_compatibility_test.php';
+$permit_url = $CONFIG->wwwroot . 'mod/simplepie/permissions.php';
 
 ?>
 
index 5fd987701f964d2d12221c694491c492a89e874e..77355bfa4cc8028ef3ae9aca8e9ca6b0790284b4 100644 (file)
@@ -1,55 +1,64 @@
-<?php\r
-       $num_items = $vars['entity']->num_items;\r
-       if (!isset($num_items)) $num_items = 10;\r
-\r
-       $excerpt = $vars['entity']->excerpt;\r
-       if (!isset($excerpt)) $excerpt = 0;\r
-\r
-       $post_date = $vars['entity']->post_date;\r
-       if (!isset($post_date)) $post_date = 0;\r
-\r
-?>\r
-\r
-  <p>\r
-    <?php echo elgg_echo("simplepie:feed_url"); ?>\r
-    <input type="text" onclick="this.select();" name="params[feed_url]" value="<?php echo htmlentities($vars['entity']->feed_url); ?>" />  \r
-  </p>\r
-\r
-  <p>\r
-<?php echo elgg_echo('simplepie:num_items'); ?>\r
-       \r
-<?php\r
-       echo elgg_view('input/pulldown', array(\r
-                       'internalname' => 'params[num_items]',\r
-                       'options_values' => array( '3' => '3',\r
-                                 '5' => '5',\r
-                                                  '8' => '8',\r
-                                                  '10' => '10',\r
-                                                  '12' => '12',\r
-                                                  '15' => '15',\r
-                                                  '20' => '20',\r
-                                                ),\r
-                       'value' => $num_items\r
-               ));\r
-?>\r
-  </p>\r
-\r
-  <p>\r
-<?php \r
-  echo elgg_view('input/hidden', array('internalname' => 'params[excerpt]', 'js' => 'id="params[excerpt]"', 'value' => $excerpt ));\r
-  echo "<input class='input-checkboxes' type='checkbox' value='' name='excerptcheckbox' onclick=\"document.getElementById('params[excerpt]').value = 1 - document.getElementById('params[excerpt]').value;\" ";\r
-  if ($excerpt) echo "checked='yes'";\r
-  echo " />";\r
-  echo ' ' . elgg_echo('simplepie:excerpt');\r
-?>\r
-  </p>  \r
-\r
-  <p>\r
-<?php \r
-  echo elgg_view('input/hidden', array('internalname' => 'params[post_date]', 'js' => 'id="params[post_date]"', 'value' => $post_date ));\r
-  echo "<input class='input-checkboxes' type='checkbox' value='' name='post_datecheckbox' onclick=\"document.getElementById('params[post_date]').value = 1 - document.getElementById('params[post_date]').value;\" ";\r
-  if ($post_date) echo "checked='yes'";\r
-  echo " />";\r
-  echo ' ' . elgg_echo('simplepie:post_date');\r
-?>\r
-  </p>  \r
+<?php
+       $num_items = $vars['entity']->num_items;
+       if (!isset($num_items)) {
+               $num_items = 10;
+       }
+
+       $excerpt = $vars['entity']->excerpt;
+       if (!isset($excerpt)) {
+               $excerpt = 0;
+       }
+       
+       $post_date = $vars['entity']->post_date;
+       if (!isset($post_date)) {
+               $post_date = 0;
+       }
+?>
+
+<p>
+       <?php echo elgg_echo("simplepie:feed_url"); ?>
+       <input type="text" onclick="this.select();" name="params[feed_url]" value="<?php echo htmlentities($vars['entity']->feed_url); ?>" />  
+</p>
+
+<p>
+<?php echo elgg_echo('simplepie:num_items'); ?>
+       
+<?php
+       echo elgg_view('input/pulldown', array(
+                       'internalname' => 'params[num_items]',
+                       'options_values' => array(      '3' => '3',
+                                                                               '5' => '5',
+                                                                               '8' => '8',
+                                                                               '10' => '10',
+                                                                               '12' => '12',
+                                                                               '15' => '15',
+                                                                               '20' => '20',
+                                                                       ),
+                       'value' => $num_items
+               ));
+?>
+</p>
+
+<p>
+<?php 
+echo elgg_view('input/hidden', array('internalname' => 'params[excerpt]', 'js' => 'id="params[excerpt]"', 'value' => $excerpt ));
+echo "<input class='input-checkboxes' type='checkbox' value='' name='excerptcheckbox' onclick=\"document.getElementById('params[excerpt]').value = 1 - document.getElementById('params[excerpt]').value;\" ";
+if ($excerpt) {
+       echo "checked='yes'";
+}
+echo " />";
+echo ' ' . elgg_echo('simplepie:excerpt');
+?>
+</p>  
+
+<p>
+<?php 
+echo elgg_view('input/hidden', array('internalname' => 'params[post_date]', 'js' => 'id="params[post_date]"', 'value' => $post_date ));
+echo "<input class='input-checkboxes' type='checkbox' value='' name='post_datecheckbox' onclick=\"document.getElementById('params[post_date]').value = 1 - document.getElementById('params[post_date]').value;\" ";
+if ($post_date) {
+       echo "checked='yes'";
+}
+echo " />";
+echo ' ' . elgg_echo('simplepie:post_date');
+?>
+</p>  
index e689d3550a0351a3e2f3577bc84c63a3a3bf287f..56bf4482dcbe60641cae20e8c402917a91be84f0 100644 (file)
@@ -1,70 +1,72 @@
 <div class="contentWrapper">
 <?php
-  global $CONFIG;
-    
-  if (!class_exists('SimplePie'))
-  {
-    require_once $CONFIG->pluginspath . '/simplepie/simplepie.inc';
-  }
-  
-  $blog_tags = '<a><p><br><b><i><em><del><pre><strong><ul><ol><li>';
-  $feed_url = $vars['entity']->feed_url;
-  if($feed_url){
+global $CONFIG;
 
-    $excerpt   = $vars['entity']->excerpt;
-    $num_items = $vars['entity']->num_items;
-    $post_date = $vars['entity']->post_date;
-     
-    $cache_loc = $CONFIG->pluginspath . '/simplepie/cache';
-    
-    $feed = new SimplePie($feed_url, $cache_loc);
-    
-    // doubles timeout if going through a proxy
-    //$feed->set_timeout(20);
-    
-    $num_posts_in_feed = $feed->get_item_quantity();
-    
-    // only display errors to profile owner
-    if (get_loggedin_userid() == page_owner())
-    {        
-      if (!$num_posts_in_feed)
-        echo '<p>' . elgg_echo('simplepie:notfind') . '</p>';
-    }
+if (!class_exists('SimplePie')) {
+       require_once $CONFIG->pluginspath . '/simplepie/simplepie.inc';
+}
+
+$allow_tags = '<a><p><br><b><i><em><del><pre><strong><ul><ol><li>';
+$feed_url = $vars['entity']->feed_url;
+if ($feed_url) {
+
+       // get widget settings
+       $excerpt   = $vars['entity']->excerpt;
+       $num_items = $vars['entity']->num_items;
+       $post_date = $vars['entity']->post_date;
+       
+       $cache_loc = $CONFIG->pluginspath . '/simplepie/cache';
+       
+       $feed = new SimplePie($feed_url, $cache_loc);
+       
+       // doubles timeout if going through a proxy
+       //$feed->set_timeout(20);
+       
+       $num_posts_in_feed = $feed->get_item_quantity();
+       
+       // only display errors to profile owner
+       if (get_loggedin_userid() == page_owner()) {
+               if (!$num_posts_in_feed) {
+                       echo '<p>' . elgg_echo('simplepie:notfind') . '</p>';
+               }
+       }
 ?>
-  <div class="simplepie_blog_title">
-    <h2><a href="<?php echo $feed->get_permalink(); ?>"><?php echo $feed->get_title(); ?></a></h2>
-  </div>
+<div class="simplepie_blog_title">
+       <h2><a href="<?php echo $feed->get_permalink(); ?>"><?php echo $feed->get_title(); ?></a></h2>
+</div>
 <?php
-  if ($num_items > $num_posts_in_feed)
-    $num_items = $num_posts_in_feed;
-    
-  foreach ($feed->get_items(0,$num_items) as $item):
-?>
-               <div class="simplepie_item">
-                 <div class="simplepie_title">
-                         <h4><a href="<?php echo $item->get_permalink(); ?>"><?php echo $item->get_title(); ?></a></h4>
-      </div>
-                       <?php 
-        if ($excerpt)
-        {
-          echo '<div class="simplepie_excerpt">' . strip_tags($item->get_description(true),$blog_tags) . '</div>';
-        }
+       // don't display more feed items than user requested
+       if ($num_items > $num_posts_in_feed) {
+               $num_items = $num_posts_in_feed;
+       }
 
-        if ($post_date) 
-        {
-      ?>
-        <div class="simplepie_date">Posted on <?php echo $item->get_date('j F Y | g:i a'); ?></div>
-      <?php } ?>
+       foreach ($feed->get_items(0, $num_items) as $item):
+?>
+       <div class="simplepie_item">
+               <div class="simplepie_title">
+                       <h4><a href="<?php echo $item->get_permalink(); ?>"><?php echo $item->get_title(); ?></a></h4>
                </div>
+<?php 
+               if ($excerpt) {
+                       echo '<div class="simplepie_excerpt">' . strip_tags($item->get_description(true), $allow_tags) . '</div>';
+               }
+
+               if ($post_date) {
+?>
+               <div class="simplepie_date">Posted on <?php echo $item->get_date('j F Y | g:i a'); ?></div>
+<?php 
+               } 
+?>
+       </div>
+
        <?php endforeach; ?>
 
 <?php 
-  } else {
-  
-    if (get_loggedin_userid() == page_owner())        
-      echo '<p>' . elgg_echo('simplepie:notset') . '</p>';      
-  }
+} else {
+       // display message only to owner
+       if (get_loggedin_userid() == page_owner()) {        
+               echo '<p>' . elgg_echo('simplepie:notset') . '</p>';
+       }
+}
 ?>
 </div>