From 3e1d6ba47a9201486851fb41f4ec4a0df2db2d5b Mon Sep 17 00:00:00 2001
From: mistic100 <mistic@piwigo.org>
Date: Mon, 18 Nov 2013 10:02:17 +0000
Subject: feature 2999: documentation of functions\comment|cookie|filter|html

git-svn-id: http://piwigo.org/svn/trunk@25548 68402e56-0260-453c-a942-63ccdbb3a9ee
---
 include/functions_comment.inc.php |  90 +++++++++++++------
 include/functions_cookie.inc.php  |  36 +++++---
 include/functions_filter.inc.php  |  10 ++-
 include/functions_html.inc.php    | 184 ++++++++++++++++++++++++++------------
 4 files changed, 222 insertions(+), 98 deletions(-)

(limited to 'include')

diff --git a/include/functions_comment.inc.php b/include/functions_comment.inc.php
index b4599fd4f..f48f711c7 100644
--- a/include/functions_comment.inc.php
+++ b/include/functions_comment.inc.php
@@ -21,7 +21,22 @@
 // | USA.                                                                  |
 // +-----------------------------------------------------------------------+
 
-//returns string action to perform on a new comment: validate, moderate, reject
+/**
+ * @package functions\comment
+ */
+ 
+
+add_event_handler('user_comment_check', 'user_comment_check',
+  EVENT_HANDLER_PRIORITY_NEUTRAL, 2);
+
+/**
+ * Does basic check on comment and returns action to perform.
+ * This method is called by a trigger_event()
+ *
+ * @param string $action before check
+ * @param array $comment
+ * @return string validate, moderate, reject
+ */
 function user_comment_check($action, $comment)
 {
   global $conf,$user;
@@ -54,18 +69,15 @@ function user_comment_check($action, $comment)
   return $action;
 }
 
-
-add_event_handler('user_comment_check', 'user_comment_check',
-  EVENT_HANDLER_PRIORITY_NEUTRAL, 2);
-
 /**
- * Tries to insert a user comment in the database and returns one of :
- * validate, moderate, reject
- * @param array comm contains author, content, image_id
- * @param string key secret key sent back to the browser
- * @param array infos out array of messages
+ * Tries to insert a user comment and returns action to perform.
+ *
+ * @param array $comm
+ * @param string $key secret key sent back to the browser
+ * @param array $infos output array of error messages
+ * @return string validate, moderate, reject
  */
-function insert_user_comment( &$comm, $key, &$infos )
+function insert_user_comment(&$comm, $key, &$infos)
 {
   global $conf, $user;
 
@@ -251,16 +263,17 @@ INSERT INTO '.COMMENTS_TABLE.'
       );
     }
   }
+
   return $comment_action;
 }
 
 /**
- * Tries to delete a user comment in the database
- * only admin can delete all comments
- * other users can delete their own comments
- * so to avoid a new sql request we add author in where clause
+ * Tries to delete a (or more) user comment.
+ *    only admin can delete all comments
+ *    other users can delete their own comments
  *
- * @param int or array of int comment_id
+ * @param int|int[] $comment_id
+ * @return bool false if nothing deleted
  */
 function delete_user_comment($comment_id)
 {
@@ -290,18 +303,21 @@ $user_where_clause.'
                       'comment_id' => $comment_id
                   ));
     trigger_action('user_comment_deletion', $comment_id);
+
+    return true;
   }
+
+  return false;
 }
 
 /**
- * Tries to update a user comment in the database
- * only admin can update all comments
- * users can edit their own comments if admin allow them
- * so to avoid a new sql request we add author in where clause
+ * Tries to update a user comment
+ *    only admin can update all comments
+ *    users can edit their own comments if admin allow them
  *
- * @param comment_id
- * @param post_key
- * @param content
+ * @param array $comment
+ * @param string $post_key secret key sent back to the browser
+ * @return string validate, moderate, reject
  */
 
 function update_user_comment($comment, $post_key)
@@ -397,6 +413,13 @@ $user_where_clause.'
   return $comment_action;
 }
 
+/**
+ * Notifies admins about updated or deleted comment.
+ * Only used when no validation is needed, otherwise pwg_mail_notification_admins() is used.
+ *
+ * @param string $action edit, delete
+ * @param array $comment
+ */
 function email_admin($action, $comment)
 {
   global $conf;
@@ -430,6 +453,13 @@ function email_admin($action, $comment)
     );
 }
 
+/**
+ * Returns the author id of a comment
+ *
+ * @param int $comment_id
+ * @param bool $die_on_error
+ * @return int
+ */
 function get_comment_author_id($comment_id, $die_on_error=true)
 {
   $query = '
@@ -457,8 +487,9 @@ SELECT
 }
 
 /**
- * Tries to validate a user comment in the database
- * @param int or array of int comment_id
+ * Tries to validate a user comment.
+ *
+ * @param int|int[] $comment_id
  */
 function validate_user_comment($comment_id)
 {
@@ -479,14 +510,19 @@ UPDATE '.COMMENTS_TABLE.'
   trigger_action('user_comment_validation', $comment_id);
 }
 
-
+/**
+ * Clears cache of nb comments for all users
+ */
 function invalidate_user_cache_nb_comments()
 {
   global $user;
+
   unset($user['nb_available_comments']);
+
   $query = '
 UPDATE '.USER_CACHE_TABLE.'
-  SET nb_available_comments = NULL';
+  SET nb_available_comments = NULL
+;';
   pwg_query($query);
 }
 
diff --git a/include/functions_cookie.inc.php b/include/functions_cookie.inc.php
index 668dca670..df18997b5 100644
--- a/include/functions_cookie.inc.php
+++ b/include/functions_cookie.inc.php
@@ -21,10 +21,19 @@
 // | USA.                                                                  |
 // +-----------------------------------------------------------------------+
 
-// cookie_path returns the path to use for the Piwigo cookie.
-// If Piwigo is installed on :
-// http://domain.org/meeting/gallery/category.php
-// cookie_path will return : "/meeting/gallery"
+/**
+ * @package functions\cookie
+ */
+
+
+/**
+ * Returns the path to use for the Piwigo cookie.
+ * If Piwigo is installed on :
+ * http://domain.org/meeting/gallery/
+ * it will return : "/meeting/gallery"
+ *
+ * @return string
+ */
 function cookie_path()
 {
   if ( isset($_SERVER['REDIRECT_SCRIPT_NAME']) and
@@ -83,9 +92,13 @@ function cookie_path()
 }
 
 /**
- * persistently stores a variable in pwg cookie
- * @return boolean true on success
- * @see pwg_get_cookie_var
+ * Persistently stores a variable in pwg cookie.
+ * Set $value to null to delete the cookie.
+ *
+ * @param string $car
+ * @param mixed $value
+ * @param int|null $expire
+ * @return bool
  */
 function pwg_set_cookie_var($var, $value, $expire=null)
 {
@@ -104,9 +117,12 @@ function pwg_set_cookie_var($var, $value, $expire=null)
 }
 
 /**
- * retrieves the value of a persistent variable in pwg cookie
- * @return mixed
+ * Retrieves the value of a persistent variable in pwg cookie
  * @see pwg_set_cookie_var
+ *
+ * @param string $var
+ * @param mixed $default
+ * @return mixed
  */
 function pwg_get_cookie_var($var, $default = null)
 {
@@ -120,4 +136,4 @@ function pwg_get_cookie_var($var, $default = null)
   }
 }
 
-?>
+?>
\ No newline at end of file
diff --git a/include/functions_filter.inc.php b/include/functions_filter.inc.php
index d5b21075c..13691aed6 100644
--- a/include/functions_filter.inc.php
+++ b/include/functions_filter.inc.php
@@ -21,13 +21,15 @@
 // | USA.                                                                  |
 // +-----------------------------------------------------------------------+
 
+/**
+ * @package functions\filter
+ */
 
 
 /**
- * update data of categories with filtered values
+ * Updates data of categories with filtered values
  *
- * @param array list of categories
- * @return null
+ * @param array $cats
  */
 function update_cats_with_filtered_data(&$cats)
 {
@@ -47,4 +49,4 @@ function update_cats_with_filtered_data(&$cats)
   }
 }
 
-?>
+?>
\ No newline at end of file
diff --git a/include/functions_html.inc.php b/include/functions_html.inc.php
index 3f9c6542a..c0a2225be 100644
--- a/include/functions_html.inc.php
+++ b/include/functions_html.inc.php
@@ -22,18 +22,22 @@
 // +-----------------------------------------------------------------------+
 
 /**
- * returns the list of categories as a HTML string
- *
- * categories string returned contains categories as given in the input
+ * @package functions\html
+ */
+
+
+/**
+ * Generates breadcrumb from categories list.
+ * Categories string returned contains categories as given in the input
  * array $cat_informations. $cat_informations array must be an array
  * of array( id=>?, name=>?, permalink=>?). If url input parameter is null,
  * returns only the categories name without links.
  *
- * @param array cat_informations
- * @param string url
+ * @param array $cat_informations
+ * @param string|null $url
  * @return string
  */
-function get_cat_display_name($cat_informations, $url = '')
+function get_cat_display_name($cat_informations, $url='')
 {
   global $conf;
 
@@ -87,15 +91,13 @@ function get_cat_display_name($cat_informations, $url = '')
 }
 
 /**
- * returns the list of categories as a HTML string, with cache of names
- *
- * categories string returned contains categories as given in the input
- * array $cat_informations. $uppercats is the list of category ids to
- * display in the right order. If url input parameter is empty, returns only
- * the categories name without links.
+ * Generates breadcrumb from categories list using a cache.
+ * @see get_cat_display_name()
  *
- * @param string uppercats
- * @param string url
+ * @param string $uppercats
+ * @param string|null $url
+ * @param bool $single_link
+ * @param string|null $link_class
  * @return string
  */
 function get_cat_display_name_cache($uppercats,
@@ -176,12 +178,28 @@ SELECT id, name, permalink
 }
 
 /**
- * returns HTMLized comment contents retrieved from database
+ * Generates breadcrumb for a category.
+ * @see get_cat_display_name()
  *
- * newlines becomes br tags, _word_ becomes underline, /word/ becomes
- * italic, *word* becomes bolded
+ * @param int $cat_id
+ * @param string|null $url
+ * @return string
+ */
+function get_cat_display_name_from_id($cat_id, $url = '')
+{
+  $cat_info = get_cat_info($cat_id);
+  return get_cat_display_name($cat_info['upper_names'], $url);
+}
+
+/**
+ * Apply basic markdown transformations to a text.
+ * newlines becomes br tags
+ * _word_ becomes underline
+ * /word/ becomes italic
+ * *word* becomes bolded
+ * urls becomes a tags
  *
- * @param string content
+ * @param string $content
  * @return string
  */
 function render_comment_content($content)
@@ -208,13 +226,9 @@ function render_comment_content($content)
   $replacement = '<span style="font-style:italic;">$1$2</span>';
   $content = preg_replace($pattern, $replacement, $content);
 
-  return $content;
-}
+  // TODO : add a trigger
 
-function get_cat_display_name_from_id($cat_id, $url = '')
-{
-  $cat_info = get_cat_info($cat_id);
-  return get_cat_display_name($cat_info['upper_names'], $url);
+  return $content;
 }
 
 /**
@@ -266,11 +280,17 @@ function get_html_tag_selection(
   return $output;
 }
 
+/**
+ * Callback used for sorting by name.
+ */
 function name_compare($a, $b)
 {
   return strcmp(strtolower($a['name']), strtolower($b['name']));
 }
 
+/**
+ * Callback used for sorting by name (slug) with cache.
+ */
 function tag_alpha_compare($a, $b)
 {
   global $cache;
@@ -287,7 +307,7 @@ function tag_alpha_compare($a, $b)
 }
 
 /**
- * exits the current script (either exit or redirect)
+ * Exits the current script (or redirect to login page if not logged).
  */
 function access_denied()
 {
@@ -314,9 +334,11 @@ function access_denied()
 }
 
 /**
- * exits the current script with 403 code
- * @param string msg a message to display
- * @param string alternate_url redirect to this url
+ * Exits the current script with 403 code.
+ * TODO : nice display if $template loaded
+ *
+ * @param string $msg
+ * @param string|null $alternate_url redirect to this url
  */
 function page_forbidden($msg, $alternate_url=null)
 {
@@ -331,9 +353,11 @@ function page_forbidden($msg, $alternate_url=null)
 }
 
 /**
- * exits the current script with 400 code
- * @param string msg a message to display
- * @param string alternate_url redirect to this url
+ * Exits the current script with 400 code.
+ * TODO : nice display if $template loaded
+ *
+ * @param string $msg
+ * @param string|null $alternate_url redirect to this url
  */
 function bad_request($msg, $alternate_url=null)
 {
@@ -348,9 +372,11 @@ function bad_request($msg, $alternate_url=null)
 }
 
 /**
- * exits the current script with 404 code when a page cannot be found
- * @param string msg a message to display
- * @param string alternate_url redirect to this url
+ * Exits the current script with 404 code.
+ * TODO : nice display if $template loaded
+ *
+ * @param string $msg
+ * @param string|null $alternate_url redirect to this url
  */
 function page_not_found($msg, $alternate_url=null)
 {
@@ -365,9 +391,12 @@ function page_not_found($msg, $alternate_url=null)
 }
 
 /**
- * exits the current script with 500 http code
- * this method can be called at any time (does not use template/language/user etc...)
- * @param string msg a message to display
+ * Exits the current script with 500 code.
+ * TODO : nice display if $template loaded
+ *
+ * @param string $msg
+ * @param string|null $title
+ * @param bool $show_trace
  */
 function fatal_error($msg, $title=null, $show_trace=true)
 {
@@ -408,7 +437,10 @@ $btrace_msg
   die(0); // just in case
 }
 
-/* returns the title to be displayed above thumbnails on tag page
+/**
+ * Returns the breadcrumb to be displayed above thumbnails on tag page.
+ *
+ * @return string
  */
 function get_tags_content_title()
 {
@@ -457,7 +489,9 @@ function get_tags_content_title()
 }
 
 /**
-  Sets the http status header (200,401,...)
+ * Sets the http status header (200,401,...)
+ * @param int $code
+ * @param string $text for exotic http codes
  */
 function set_status_header($code, $text='')
 {
@@ -486,16 +520,25 @@ function set_status_header($code, $text='')
   trigger_action('set_status_header', $code, $text);
 }
 
-/** returns the category comment for rendering in html textual mode (subcatify)
- * this is an event handler. don't call directly
+/**
+ * Returns the category comment for rendering in html textual mode (subcatify)
+ * This method is called by a trigger_action()
+ *
+ * @param string $desc
+ * @return string
  */
 function render_category_literal_description($desc)
 {
   return strip_tags($desc, '<span><p><a><br><b><i><small><big><strong><em>');
 }
 
-/*event handler for menu*/
-function register_default_menubar_blocks( $menu_ref_arr )
+/**
+ * Add known menubar blocks.
+ * This method is called by a trigger_event()
+ *
+ * @param BlockManager[] $menu_ref_arr
+ */
+function register_default_menubar_blocks($menu_ref_arr)
 {
   $menu = & $menu_ref_arr[0];
   if ($menu->get_id() != 'menubar')
@@ -509,34 +552,46 @@ function register_default_menubar_blocks( $menu_ref_arr )
 }
 
 /**
+ * Returns display name for an element.
+ * Returns 'name' if exists of name from 'file'.
+ *
+ * @param array $info at least file or name
+ * @return string
  */
 function render_element_name($info)
 {
-  $name = $info['name'];
-  if (!empty($name))
+  if (!empty($info['name']))
   {
-    $name = trigger_event('render_element_name', $name);
-    return $name;
+    return trigger_event('render_element_name', $info['name']);
   }
-
   return get_name_from_file($info['file']);
 }
 
+/**
+ * Returns display description for an element.
+ *
+ * @param array $info at least comment
+ * @param string $param used to identify the trigger
+ * @return string
+ */
 function render_element_description($info, $param='')
 {
-  $comment = $info['comment'];
-  if (!empty($comment))
+  if (!empty($info['comment']))
   {
-    $comment = trigger_event('render_element_description', $comment, $param);
-    return $comment;
+    return trigger_event('render_element_description', $info['comment'], $param);
   }
   return '';
 }
 
 /**
- * returns the title of the thumbnail based on photo properties
+ * Add info to the title of the thumbnail based on photo properties.
+ *
+ * @param array $info hit, rating_score, nb_comments
+ * @param string $title
+ * @param string $comment
+ * @return string
  */
-function get_thumbnail_title($info, $title, $comment)
+function get_thumbnail_title($info, $title, $comment='')
 {
   global $conf, $user;
 
@@ -570,16 +625,29 @@ function get_thumbnail_title($info, $title, $comment)
 
   $title = htmlspecialchars(strip_tags($title));
   $title = trigger_event('get_thumbnail_title', $title, $info);
+
   return $title;
 }
 
-/** optional event handler to protect src image urls */
+/**
+ * Event handler to protect src image urls.
+ *
+ * @param string $url
+ * @param SrcImage $src_image
+ * @return string
+ */
 function get_src_image_url_protection_handler($url, $src_image)
 {
   return get_action_url($src_image->id, $src_image->is_original() ? 'e' : 'r', false);
 }
 
-/** optional event handler to protect element urls */
+/**
+ * Event handler to protect element urls.
+ *
+ * @param string $url
+ * @param array $infos id, path
+ * @return string
+ */
 function get_element_url_protection_handler($url, $infos)
 {
   global $conf;
@@ -594,7 +662,9 @@ function get_element_url_protection_handler($url, $infos)
   return get_action_url($infos['id'], 'e', false);
 }
 
-
+/**
+ * Sends to the template all messages stored in $page and in the session.
+ */
 function flush_page_messages()
 {
   global $template, $page;
-- 
cgit v1.2.3