Changeset 11423 for extensions/Copyrights

Timestamp:

Jun 18, 2011, 9:16:29 PM (13 years ago)

Author:

Mattias

Message:

• batch renamed to batch_global and moved to a distinct file
• created batch_single.php
• some comments here and there

Location:

extensions/Copyrights

Files:

• TODO (modified) (2 diffs)
• batch_global.php (added)
• batch_global.tpl (added)
• batch_single.php (added)
• image.php (modified) (2 diffs)
• main.inc.php (modified) (4 diffs)

extensions/Copyrights/TODO

@@ -1 +1 @@
 === TODO ===
 - Implement single mode Batch Manager
-    Probably use prefilters combined with loc_begin_element_set_unit
+    Probably use prefilters combined with "loc_begin_element_set_unit" (found in event tracer)
+        SOURCES: "loc_begin_admin": http://piwigo.org/forum/viewtopic.php?id=17468
+                         "use prefilters": http://piwigo.org/forum/viewtopic.php?id=17551&p=2
 - Add Icon field to copyrights
 - Show the copyright when image is displayed
@@ -9 +11 @@
         - If you create a new copyright with a name that's already used
         - Description doesnt show with the copyright info (on the admin page)
+        - The warning triangle saying our plugin does not seem compatible - no clue

extensions/Copyrights/image.php

@@ -9 +9 @@
 */
 
-
+// What do these prefilters do?
+// First they use loc_begin_picture to set some template variables
+// Then they use the same event to set a prefilter, who on his turn will change the content
 
 // Add a prefilter - whatever a prefilter may be
-add_event_handler('loc_begin_picture', 'set_prefilter_add_to_pic_info', 55 );
+add_event_handler('loc_begin_picture', 'copyrights_set_prefilter_add_to_pic_info', 55 );
 
-function set_prefilter_add_to_pic_info()
+// Another function of which i cant see the use ;-)
+add_event_handler('loc_begin_picture', 'copyrights_add_vars_to_template');
+
+function copyrights_set_prefilter_add_to_pic_info()
 {
         global $template;
-        $template->set_prefilter('picture', 'add_to_pic_info');
+        $template->set_prefilter('picture', 'copyrights_add_to_pic_info');
 }
  
 
  // This function is called by the set_prefilter_add_to_pic_info function. It has something to do with the prefilter stuff, whatever it may be :p
-function add_to_pic_info($content, &$smarty)
+function copyrights_add_to_pic_info($content, &$smarty)
 {
         // Voeg de informatie toe na de auteur - dus voor de datum dat ie gemaakt is...
@@ -42 +47 @@
 }
 
-// Another function of which i cant see the use ;-)
-add_event_handler('loc_begin_picture', 'add_vars_to_template');
-
-function add_vars_to_template()
+function copyrights_add_vars_to_template()
 {
 // For as far as i know i only need the $prefixtable, $page and $template
-global $conf, $page, $template, $tab, $cit, $nbr, $prefixeTable;
+//global $conf, $page, $template, $tab, $cit, $nbr, $prefixeTable;
+global $page, $template, $prefixeTable;
 //load_language('plugin.lang', ADDINFO_PATH);
 //load_language('lang', PHPWG_ROOT_PATH.'local/', array('no_fallback'=>true, 'local'=>true) );

extensions/Copyrights/main.inc.php

@@ -32 +32 @@
 if (!defined('PHPWG_ROOT_PATH')) die('Hacking attempt!');
 
-define('COPYRIGHTS_PATH', PHPWG_PLUGINS_PATH.basename(dirname(__FILE__)) . '/'); // The plugin path
-define('COPYRIGHTS_WEB_PATH', get_root_url().'admin.php?page=plugin-Copyrights');
-// Whats the difference between "COPYRIGHTS_PATH" and "COPYRIGHTS_WEB_PATH" ???
+define('COPYRIGHTS_PATH', PHPWG_PLUGINS_PATH.basename(dirname(__FILE__)) . '/');  // The plugin path
+define('COPYRIGHTS_WEB_PATH', get_root_url().'admin.php?page=plugin-Copyrights'); // The path used in admin.php
 
 global $prefixeTable;
@@ -48 +47 @@
 
 
+ // Add to the menu, dont do anything right now
 add_event_handler('get_admin_plugin_menu_links', 'copyrights_admin_menu');
 function copyrights_admin_menu($menu) {
@@ -66 +66 @@
 
 
-//if (script_basename() == 'picture') // Why should i want this here?
+// Add information to the picture's description (The copyright's name)
 include_once(dirname(__FILE__).'/image.php');
 
@@ -74 +74 @@
  * +-----------------------------------------------------------------------+ */
 
+ 
+ // Global mode
+include_once(dirname(__FILE__).'/batch_global.php');
 
-// @Johan: Misschien een goed idee om dit ook in een apart php scriptje te zetten, voor de overzichtelijkheid.
-// En om deze reden (Citaat uit de piwigo docs http://piwigo.org/doc/doku.php?id=en:plugins):
-// Code size
-// When PWG loads the plugins, it will include every main.inc.php.
-// Don't put in your main.inc.php 3000 lines of code just to add a page on the administration menu.
-// Split you main.inc.php in several files and feel free to add include_once inside functions defined in main.inc.php as much as you want.
-
-
-// Add copyrights drop down menu to the batch manager
-add_event_handler('loc_end_element_set_global', 'copyrights_batch');
-// Add handler to the submit event of the batch manager
-add_event_handler('element_set_global_action', 'copyrights_batch_submit', 50, 2);
-
-function copyrights_batch()
-{
-  global $template;
-
-  load_language('plugin.lang', dirname(__FILE__).'/');                                  // Engels is voorlopig goed zat
-
-  // Assign the template for batch management
-  $template->set_filename('batch', dirname(__FILE__).'/batch.tpl');
-
-  // Fetch all the copyrights and assign them to the template
-  $query = sprintf(
-    'SELECT `cr_id`,`name`
-    FROM %s
-    WHERE `visible`<>0
-    ;',
-    COPYRIGHTS_ADMIN);
-  $result = pwg_query($query);
-  $CRoptions = array();
-  while ($row = pwg_db_fetch_assoc($result)) {
-    $CRoptions[$row['cr_id']] = $row['name'];
-  }
-  $template->assign('CRoptions', $CRoptions);
-
-  
-  // Goed, ik weet dus echt niet waarom dit hieronder gedaan wordt...
-  // AHA!!!! - dit is er zodat de "choose action" optie deze plugin gebruikt....
-  $template->append('element_set_global_plugins_actions', array(
-    'ID' => 'copyrights',       // ID of the batch manager action
-    'NAME' => l10n('Edit copyright'), // Description of the batch manager action
-    'CONTENT' => $template->parse('batch', true)
-    )
-  );
-}
-
-// * Deze functie wordt een keer aangeroepen, nadat de gebruiker submit.
-// * Fietst met een foreach loop over de geselecteerde fotos
-// * Rammelt alle toevoegingen in 1x met mass_updates naar de db.
-function copyrights_batch_submit($action, $collection)
-{
-  if ($action == 'copyrights')
-  {
-          $crID = pwg_db_real_escape_string($_POST['copyrightID']);
-    
-    if (count($collection) > 0) {
-      $query = sprintf(
-        'DELETE
-        FROM %s
-        WHERE media_id IN (%s)
-        ;',
-        COPYRIGHTS_MEDIA, implode(',', $collection));
-      pwg_query($query);
-    }
-
-    $edits = array();
-    foreach ($collection as $image_id)
-    {
-      array_push(
-        $edits,
-        array(
-          'media_id' => $image_id,
-          'cr_id' => $crID,
-          )
-        );
-    }
-
-    mass_inserts(
-      COPYRIGHTS_MEDIA, // Table name
-      array_keys($edits[0]), //Columns
-      $edits // Data
-    );
-  }
-}
+// Single mode - TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST TEST 
+// should become a include_once !!!
+include(dirname(__FILE__).'/batch_single.php');
 
 ?>