Changeset 11656 for extensions/Copyrights/admin.php

Timestamp:

Jul 7, 2011, 1:27:50 PM (13 years ago)

Author:

J.Commelin

Message:

Refactored code and added comments

File:

• extensions/Copyrights/admin.php (modified) (14 diffs)

extensions/Copyrights/admin.php

@@ -32 +32 @@
 check_status(ACCESS_ADMINISTRATOR);
 
-// Default is to create, if changed to 1, show edit page
+// Default is to create a copyright, if changed to 1, show the edit page
 $edit = 0;
 
@@ -44 +44 @@
 // Do managing of copyrights
 if (isset($_GET['tab'])) {
+  // Create a new copyright
   if ($_GET['tab'] == 'create') {
+    // Fetch the values from the form
     $name = pwg_db_real_escape_string($_REQUEST['name']);
     $url = pwg_db_real_escape_string($_REQUEST['url']);
     $descr = pwg_db_real_escape_string($_REQUEST['descr']);
     $visible = (isset($_REQUEST['visible']) ? 1 : 0);
+
+    // Check whether a copyright with such a name exists
+    // Therefore count the number of copyrights with that name
     $query = sprintf(
       'SELECT COUNT(*)
@@ -56 +61 @@
       COPYRIGHTS_ADMIN, $name);
     list($counter) = pwg_db_fetch_row(pwg_query($query));
-    if ($counter != 0) {
+
+    if ($counter != 0) { // The copyright exists already
       array_push($page['errors'], l10n('This copyright already exists'));
-    } else {
+    } else { // The copyright did not yet exist
+      // Compose a query to insert the copyright
       $query = sprintf(
         'INSERT INTO %s
@@ -65 +72 @@
         ;',
         COPYRIGHTS_ADMIN, $name, $url, $descr, $visible);
-      pwg_query($query);
+      pwg_query($query); // Execute the query
     }
   }
 
+  // Edit an existing copyright
   if ($_GET['tab'] == 'edit') {
-    $edit = 1;
-    $CRid = $_REQUEST['id'];
+    $edit = 1; // Show the edit page
+    $CRid = $_REQUEST['id']; // Fetch the id of the copyright to be edited
+
+    // Fetch the current attributes to the copyright
     $query = sprintf(
       'SELECT *
@@ -80 +90 @@
     $result = pwg_query($query);
     $row = pwg_db_fetch_assoc($result);
+
+    // Save the attributes in convenient variables
     $CRname = $row['name'];
     $CRurl = $row['url'];
@@ -86 +98 @@
   }
 
+  // Update an existing copyright
   if ($_GET['tab'] == 'update') {
+    // Fetch the values from the edit form
     $id = pwg_db_real_escape_string($_REQUEST['id']);
     $name = pwg_db_real_escape_string($_REQUEST['name']);
@@ -92 +106 @@
     $descr= pwg_db_real_escape_string($_REQUEST['descr']);
     $visible = (isset($_REQUEST['visible']) ? 1 : 0);
+
+    // Compose a query to update the copyright
     $query = sprintf(
       'UPDATE %s
@@ -98 +114 @@
       ;',
       COPYRIGHTS_ADMIN, $name, $url, $descr, $visible, $id);
-    pwg_query($query);
+    pwg_query($query); // Execute the query
   }
-  
+
+  // Delete an existing copyright
   if ($_GET['tab'] == 'delete') {
-    $id = $_REQUEST['id'];
+    $id = $_REQUEST['id']; // Fetch the id of the copyright to be deleted
+
+    // Compose a query to delete the copyright
     $query = sprintf(
       'DELETE FROM %s
@@ -108 +127 @@
       ;',
       COPYRIGHTS_ADMIN, $id);
-    pwg_query($query);
+    pwg_query($query); // Execute the query
   }
 }
 
-// Create page template
+/* Assign variables to the template */
 global $template;
 
+// Add the admin.tpl template
 $template->set_filenames(
   array(
@@ -121 +141 @@
 );
 
+// Select the existing copyrights
 $query = sprintf(
   'SELECT *
@@ -128 +149 @@
 $result = pwg_query($query);
 
+// Append the copyrights to the Smarty array
 while ($row = pwg_db_fetch_assoc($result)) {
   $template->append(
@@ -141 +163 @@
 }
 
+// Assign the path for URL forming
 $template->assign(
   'COPYRIGHTS_PATH',
@@ -146 +169 @@
 );
 
+// Assign all the variables we constructed above
 $template->assign('edit', $edit);
 $template->assign('CRid', $CRid);
@@ -153 +177 @@
 $template->assign('CRvisible', $CRvisible);
 
+// Get it up and running
 $template->assign_var_from_handle('ADMIN_CONTENT', 'plugin_admin_content');