Changeset 26946


Ignore:
Timestamp:
01/24/14 13:50:48 (5 years ago)
Author:
mistic100
Message:

feature 2999; docblocks for history, install and metadata

Location:
trunk/admin/include
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/admin/include/functions_history.inc.php

    r26461 r26946  
    2222// +-----------------------------------------------------------------------+ 
    2323 
     24/** 
     25 * @package functions\admin\history 
     26 */ 
     27 
     28 
    2429include_once(PHPWG_ROOT_PATH.'admin/include/tabsheet.class.php'); 
    2530 
     31/** 
     32 * Init tabsheet for history pages 
     33 * @ignore 
     34 */ 
    2635function history_tabsheet() 
    2736{ 
     
    3544} 
    3645 
     46/** 
     47 * Callback used to sort history entries 
     48 */ 
    3749function history_compare($a, $b) 
    3850{ 
     
    4052} 
    4153 
     54/** 
     55 * Perform history search. 
     56 * 
     57 * @param array $data  - used in trigger_change 
     58 * @param array $search 
     59 * @param string[] $types 
     60 * @param array 
     61 */ 
    4262function get_history($data, $search, $types) 
    4363{ 
  • trunk/admin/include/functions_install.inc.php

    r26461 r26946  
    2323 
    2424/** 
    25  * loads an sql file and executes all queries 
    26  * 
     25 * @package functions\admin\install 
     26 */ 
     27 
     28 
     29/** 
     30 * Loads a SQL file and executes all queries. 
    2731 * Before executing a query, $replaced is... replaced by $replacing. This is 
    2832 * useful when the SQL file contains generic words. Drop table queries are 
    2933 * not executed. 
    3034 * 
    31  * @param string filepath 
    32  * @param string replaced 
    33  * @param string replacing 
    34  * @return void 
     35 * @param string $filepath 
     36 * @param string $replaced 
     37 * @param string $replacing 
    3538 */ 
    3639function execute_sqlfile($filepath, $replaced, $replacing, $dblayer) 
     
    7174/** 
    7275 * Automatically activate all core themes in the "themes" directory. 
    73  * 
    74  * @return void 
    7576 */ 
    7677function activate_core_themes() 
     
    8788} 
    8889 
     90/** 
     91 * Connect to database during installation. Uses $_POST. 
     92 * 
     93 * @param array &$infos - populated with infos 
     94 * @param array &$errors - populated with errors 
     95 */ 
    8996function install_db_connect(&$infos, &$errors) 
    9097{ 
     
    100107  } 
    101108} 
     109 
    102110?> 
  • trunk/admin/include/functions_metadata.php

    r26461 r26946  
    2222// +-----------------------------------------------------------------------+ 
    2323 
     24/** 
     25 * @package functions\admin\metadata 
     26 */ 
     27 
     28 
    2429include_once(PHPWG_ROOT_PATH.'/include/functions_metadata.inc.php'); 
    2530 
    2631 
     32/** 
     33 * Returns IPTC metadata to sync from a file, depending on IPTC mapping. 
     34 * @toto : clean code (factorize foreach) 
     35 * 
     36 * @param string $file 
     37 * @return array 
     38 */ 
    2739function get_sync_iptc_data($file) 
    2840{ 
     
    8193} 
    8294 
     95/** 
     96 * Returns EXIF metadata to sync from a file, depending on EXIF mapping. 
     97 * 
     98 * @param string $file 
     99 * @return array 
     100 */ 
    83101function get_sync_exif_data($file) 
    84102{ 
     
    111129} 
    112130 
    113  
     131/** 
     132 * Get all potential file metadata fields, including IPTC and EXIF. 
     133 * 
     134 * @return string[] 
     135 */ 
    114136function get_sync_metadata_attributes() 
    115137{ 
     
    140162} 
    141163 
     164/** 
     165 * Get all metadata of a file. 
     166 * 
     167 * @param array $infos - (path[, representative_ext]) 
     168 * @return array - includes data provided in $infos 
     169 */ 
    142170function get_sync_metadata($infos) 
    143171{ 
     
    179207} 
    180208 
    181  
     209/** 
     210 * Sync all metadata of a list of images. 
     211 * Metadata are fetched from original files and saved in database. 
     212 * 
     213 * @param int[] $ids 
     214 */ 
    182215function sync_metadata($ids) 
    183216{ 
     
    256289 
    257290/** 
    258  * returns an array associating element id (images.id) with its complete 
     291 * Returns an array associating element id (images.id) with its complete 
    259292 * path in the filesystem 
    260293 * 
    261  * @param int id_uppercat 
    262  * @param int site_id 
    263  * @param boolean recursive ? 
    264  * @param boolean only newly added files ? 
     294 * @param int $category_id 
     295 * @param int $site_id 
     296 * @param boolean $recursive 
     297 * @param boolean $only_new 
    265298 * @return array 
    266299 */ 
     
    318351  return hash_from_query($query, 'id'); 
    319352} 
     353 
    320354?> 
Note: See TracChangeset for help on using the changeset viewer.