Changeset 26946

Timestamp:

Jan 24, 2014, 1:50:48 PM (10 years ago)

Author:

mistic100

Message:

feature 2999; docblocks for history, install and metadata

Location:

trunk/admin/include

Files:

• functions_history.inc.php (modified) (3 diffs)
• functions_install.inc.php (modified) (4 diffs)
• functions_metadata.php (modified) (7 diffs)

trunk/admin/include/functions_history.inc.php

@@ -22 +22 @@
 // +-----------------------------------------------------------------------+
 
+/**
+ * @package functions\admin\history
+ */
+
+
 include_once(PHPWG_ROOT_PATH.'admin/include/tabsheet.class.php');
 
+/**
+ * Init tabsheet for history pages
+ * @ignore
+ */
 function history_tabsheet()
 {
@@ -35 +44 @@
 }
 
+/**
+ * Callback used to sort history entries
+ */
 function history_compare($a, $b)
 {
@@ -40 +52 @@
 }
 
+/**
+ * Perform history search.
+ *
+ * @param array $data  - used in trigger_change
+ * @param array $search
+ * @param string[] $types
+ * @param array
+ */
 function get_history($data, $search, $types)
 {

trunk/admin/include/functions_install.inc.php

@@ -23 +23 @@
 
 /**
- * loads an sql file and executes all queries
- *
+ * @package functions\admin\install
+ */
+
+
+/**
+ * Loads a SQL file and executes all queries.
  * Before executing a query, $replaced is... replaced by $replacing. This is
  * useful when the SQL file contains generic words. Drop table queries are
  * not executed.
  *
- * @param string filepath
- * @param string replaced
- * @param string replacing
- * @return void
+ * @param string $filepath
+ * @param string $replaced
+ * @param string $replacing
  */
 function execute_sqlfile($filepath, $replaced, $replacing, $dblayer)
@@ -71 +74 @@
 /**
  * Automatically activate all core themes in the "themes" directory.
- *
- * @return void
  */
 function activate_core_themes()
@@ -87 +88 @@
 }
 
+/**
+ * Connect to database during installation. Uses $_POST.
+ *
+ * @param array &$infos - populated with infos
+ * @param array &$errors - populated with errors
+ */
 function install_db_connect(&$infos, &$errors)
 {
@@ -100 +107 @@
   }
 }
+
 ?>

trunk/admin/include/functions_metadata.php

@@ -22 +22 @@
 // +-----------------------------------------------------------------------+
 
+/**
+ * @package functions\admin\metadata
+ */
+
+
 include_once(PHPWG_ROOT_PATH.'/include/functions_metadata.inc.php');
 
 
+/**
+ * Returns IPTC metadata to sync from a file, depending on IPTC mapping.
+ * @toto : clean code (factorize foreach)
+ *
+ * @param string $file
+ * @return array
+ */
 function get_sync_iptc_data($file)
 {
@@ -81 +93 @@
 }
 
+/**
+ * Returns EXIF metadata to sync from a file, depending on EXIF mapping.
+ *
+ * @param string $file
+ * @return array
+ */
 function get_sync_exif_data($file)
 {
@@ -111 +129 @@
 }
 
-
+/**
+ * Get all potential file metadata fields, including IPTC and EXIF.
+ *
+ * @return string[]
+ */
 function get_sync_metadata_attributes()
 {
@@ -140 +162 @@
 }
 
+/**
+ * Get all metadata of a file.
+ *
+ * @param array $infos - (path[, representative_ext])
+ * @return array - includes data provided in $infos
+ */
 function get_sync_metadata($infos)
 {
@@ -179 +207 @@
 }
 
-
+/**
+ * Sync all metadata of a list of images.
+ * Metadata are fetched from original files and saved in database.
+ *
+ * @param int[] $ids
+ */
 function sync_metadata($ids)
 {
@@ -256 +289 @@
 
 /**
- * returns an array associating element id (images.id) with its complete
+ * Returns an array associating element id (images.id) with its complete
  * path in the filesystem
  *
- * @param int id_uppercat
- * @param int site_id
- * @param boolean recursive ?
- * @param boolean only newly added files ?
+ * @param int $category_id
+ * @param int $site_id
+ * @param boolean $recursive
+ * @param boolean $only_new
  * @return array
  */
@@ -318 +351 @@
   return hash_from_query($query, 'id');
 }
+
 ?>