Changeset 14385

Show
Ignore:
Timestamp:
01/12/08 14:14:41 (9 months ago)
Author:
flack
Message:

boilerplate docblocks and fixes for _show_xxx functions, part 1

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/cc.kaktus.exhibitions/handler/create.php

    r14140 r14385  
    225225     * Show the editing form 
    226226     * 
     227     * @param mixed $handler_id The ID of the handler. 
     228     * @param mixed &$data The local request data. 
    227229     * @access public 
    228230     */ 

  • trunk/midcom/cc.kaktus.exhibitions/handler/delete.php

    r14140 r14385  
    188188     * Show the editing form 
    189189     * 
     190     * @param mixed $handler_id The ID of the handler. 
     191     * @param mixed &$data The local request data. 
    190192     * @access public 
    191193     */ 

  • trunk/midcom/cc.kaktus.exhibitions/handler/edit.php

    r14140 r14385  
    152152     * Show the editing form 
    153153     * 
     154     * @param mixed $handler_id The ID of the handler. 
     155     * @param mixed &$data The local request data. 
    154156     * @access public 
    155157     */ 

  • trunk/midcom/cc.kaktus.exhibitions/handler/leaves.php

    r14140 r14385  
    298298     * Show the page of an artist 
    299299     * 
     300     * @param mixed $handler_id The ID of the handler. 
     301     * @param mixed &$data The local request data. 
    300302     * @access public 
    301303     */ 

  • trunk/midcom/cc.kaktus.exhibitions/handler/list.php

    r14329 r14385  
    108108     * Show a list of years 
    109109     * 
     110     * @param mixed $handler_id The ID of the handler. 
     111     * @param mixed &$data The local request data. 
    110112     * @access public 
    111113     */ 
    …… 
    243245     * Show the list of exhibitions on a certain year 
    244246     * 
     247     * @param mixed $handler_id The ID of the handler. 
     248     * @param mixed &$data The local request data. 
    245249     * @access public 
    246250     */ 

  • trunk/midcom/cc.kaktus.exhibitions/handler/view.php

    r14140 r14385  
    390390     * Show the page of an artist 
    391391     * 
     392     * @param mixed $handler_id The ID of the handler. 
     393     * @param mixed &$data The local request data. 
    392394     * @access public 
    393395     */ 
    …… 
    550552     * Show the current exhibition or an error page 
    551553     * 
     554     * @param mixed $handler_id The ID of the handler. 
     555     * @param mixed &$data The local request data. 
    552556     * @access public 
    553557     */ 

  • trunk/midcom/cc.kaktus.pearserver/handler/config.php

    r14329 r14385  
    9191     * Show the configuration screen 
    9292     * 
     93     * @param mixed $handler_id The ID of the handler. 
     94     * @param mixed &$data The local request data. 
    9395     * @access public 
    9496     */ 

  • trunk/midcom/cc.kaktus.pearserver/handler/upload.php

    r14140 r14385  
    251251     * Show the upload form 
    252252     * 
     253     * @param mixed $handler_id The ID of the handler. 
     254     * @param mixed &$data The local request data. 
    253255     * @access public 
    254256     */ 

  • trunk/midcom/cc.kaktus.pearserver/handler/welcome.php

    r14329 r14385  
    3131    } 
    3232 
     33    /** 
     34     * 
     35     * @param mixed $handler_id The ID of the handler. 
     36     * @param mixed &$data The local request data. 
     37     */ 
    3338    function _show_welcome($handler_id, &$data) 
    3439    { 

  • trunk/midcom/cc.kaktus.todo/handler/list.php

    r14329 r14385  
    213213     * Show TODO items 
    214214     * 
     215     * @param mixed $handler_id The ID of the handler. 
     216     * @param mixed &$data The local request data. 
    215217     * @access private 
    216218     */ 
    …… 
    248250     * Show TODO items 
    249251     * 
     252     * @param mixed $handler_id The ID of the handler. 
     253     * @param mixed &$data The local request data. 
    250254     * @access private 
    251255     */ 
    …… 
    275279     * Show TODO items 
    276280     * 
     281     * @param mixed $handler_id The ID of the handler. 
     282     * @param mixed &$data The local request data. 
    277283     * @access private 
    278284     */ 

  • trunk/midcom/cc.kaktus.todo/handler/new.php

    r14329 r14385  
    172172     * Show the creation form 
    173173     * 
     174     * @param mixed $handler_id The ID of the handler. 
     175     * @param mixed &$data The local request data. 
    174176     * @access private 
    175177     */ 

  • trunk/midcom/de.linkm.sitemap/handler/sitemap.php

    r14329 r14385  
    130130     * Show the content of xml Sitemap 
    131131     * 
     132     * @param mixed $handler_id The ID of the handler. 
     133     * @param mixed &$data The local request data. 
    132134     * @access private 
    133135     */ 
    …… 
    257259     * Shows the sitemap 
    258260     * 
     261     * @param mixed $handler_id The ID of the handler. 
     262     * @param mixed &$data The local request data. 
    259263     * @access private 
    260264     */ 

  • trunk/midcom/fi.hut.loginbroker/handler/index.php

    r14327 r14385  
    352352    /** 
    353353     * This function does the output. 
    354      *   
     354     * 
     355     * @param mixed $handler_id The ID of the handler. 
     356     * @param mixed &$data The local request data. 
    355357     */ 
    356358    function _show_index($handler_id, &$data) 

  • trunk/midcom/fi.mik.lentopaikkakisa/handler/download.php

    r14329 r14385  
    4141    } 
    4242 
     43    /** 
     44     * 
     45     * @param mixed $handler_id The ID of the handler. 
     46     * @param mixed &$data The local request data. 
     47     */ 
    4348    function _show_xml($handler_id, &$data) 
    4449    { 
    …… 
    7378    } 
    7479 
     80    /** 
     81     * 
     82     * @param mixed $handler_id The ID of the handler. 
     83     * @param mixed &$data The local request data. 
     84     */ 
    7585    function _show_csv($handler_id, &$data) 
    7686    { 

  • trunk/midcom/fi.mik.lentopaikkakisa/handler/index.php

    r14329 r14385  
    4242    } 
    4343 
     44    /** 
     45     * 
     46     * @param mixed $handler_id The ID of the handler. 
     47     * @param mixed &$data The local request data. 
     48     */ 
    4449    function _show_index($handler_id, &$data) 
    4550    { 

  • trunk/midcom/fi.mik.lentopaikkakisa/handler/manage.php

    r14329 r14385  
    8888    } 
    8989 
     90    /** 
     91     * 
     92     * @param mixed $handler_id The ID of the handler. 
     93     * @param mixed &$data The local request data. 
     94     */ 
    9095    function _show_list($handler_id, &$data) 
    9196    { 

  • trunk/midcom/fi.mik.lentopaikkakisa/handler/report.php

    r14329 r14385  
    226226    /** 
    227227     * Shows the loaded report editor 
     228     * 
     229     * @param mixed $handler_id The ID of the handler. 
     230     * @param mixed &$data The local request data. 
    228231     */ 
    229232    function _show_new($handler_id, &$data) 

  • trunk/midcom/fi.mik.lentopaikkakisa/handler/score.php

    r14329 r14385  
    6969    } 
    7070 
     71    /** 
     72     * 
     73     * @param mixed $handler_id The ID of the handler. 
     74     * @param mixed &$data The local request data. 
     75     */ 
    7176    function _show_score($handler_id, &$data) 
    7277    { 

  • trunk/midcom/midcom.admin.babel/handler/process.php

    r14329 r14385  
    132132    } 
    133133 
     134    /** 
     135     * 
     136     * @param mixed $handler_id The ID of the handler. 
     137     * @param mixed &$data The local request data. 
     138     */ 
    134139    function _show_select($handler_id, &$data) 
    135140    { 
    …… 
    260265    } 
    261266 
     267    /** 
     268     * 
     269     * @param mixed $handler_id The ID of the handler. 
     270     * @param mixed &$data The local request data. 
     271     */ 
    262272    function _show_save($handler_id, &$data) 
    263273    { 
    …… 
    292302    } 
    293303 
     304    /** 
     305     * 
     306     * @param mixed $handler_id The ID of the handler. 
     307     * @param mixed &$data The local request data. 
     308     */ 
    294309    function _show_status($handler_id, &$data) 
    295310    { 
    …… 
    382397    } 
    383398 
     399    /** 
     400     * 
     401     * @param mixed $handler_id The ID of the handler. 
     402     * @param mixed &$data The local request data. 
     403     */ 
    384404    function _show_edit($handler_id, &$data) 
    385405    { 
    …… 
    422442    } 
    423443 
     444    /** 
     445     * 
     446     * @param mixed $handler_id The ID of the handler. 
     447     * @param mixed &$data The local request data. 
     448     */ 
    424449    function _show_permission_check($handler_id, &$data) 
    425450    { 

  • trunk/midcom/midcom.admin.folder/handler/delete.php

    r14140 r14385  
    223223     * Shows the _Delete folder_ form. 
    224224     * 
     225     * @param mixed $handler_id The ID of the handler. 
     226     * @param mixed &$data The local request data. 
    225227     * @access private 
    226228     */ 

  • trunk/midcom/midcom.admin.folder/handler/edit.php

    r14140 r14385  
    343343     * Shows the _Edit folder_ page. 
    344344     * 
     345     * @param mixed $handler_id The ID of the handler. 
     346     * @param mixed &$data The local request data. 
    345347     * @access private 
    346348     */ 

  • trunk/midcom/midcom.admin.folder/handler/metadata.php

    r14381 r14385  
    219219     * Output the style element for metadata editing 
    220220     * 
     221     * @param mixed $handler_id The ID of the handler. 
     222     * @param mixed &$data The local request data. 
    221223     * @access private 
    222224     */ 

  • trunk/midcom/midcom.admin.folder/handler/move.php

    r14381 r14385  
    174174     * Output the style element for move editing 
    175175     * 
     176     * @param mixed $handler_id The ID of the handler. 
     177     * @param mixed &$data The local request data. 
    176178     * @access private 
    177179     */ 

  • trunk/midcom/midcom.admin.folder/handler/order.php

    r14329 r14385  
    222222     * Show the sorting 
    223223     * 
     224     * @param mixed $handler_id The ID of the handler. 
     225     * @param mixed &$data The local request data. 
    224226     * @access private 
    225227     */ 

  • trunk/midcom/midcom.admin.libconfig/handler/edit.php

    r14329 r14385  
    277277     * @access private 
    278278     * @param string $handler_id Name of the used handler 
    279      * @param mixed $data Data passed to the show method 
     279     * @param mixed &$data Data passed to the show method 
    280280     */ 
    281281    function _show_edit($handler_id, &$data) 

  • trunk/midcom/midcom.admin.libconfig/handler/list.php

    r13230 r14385  
    7171     * @param string $handler_id Name of the used handler 
    7272     * @param mixed $args Array containing the variable arguments passed to the handler 
    73      * @param mixed $data Data passed to the show method 
     73     * @param mixed &$data Data passed to the show method 
    7474     * @return boolean Indicating successful request 
    7575     */ 
    …… 
    9090     * @access private 
    9191     * @param string $handler_id Name of the used handler 
    92      * @param mixed $data Data passed to the show method 
     92     * @param mixed &$data Data passed to the show method 
    9393     */ 
    9494    public function _show_list($handler_id, &$data) 

  • trunk/midcom/midcom.admin.libconfig/handler/view.php

    r14329 r14385  
    143143     * @access private 
    144144     * @param string $handler_id Name of the used handler 
    145      * @param mixed $data Data passed to the show method 
     145     * @param mixed &$data Data passed to the show method 
    146146     */ 
    147147    function _show_view($handler_id, &$data) 

  • trunk/midcom/midcom.admin.settings/editor.php

    r14338 r14385  
    273273    /** 
    274274     * Shows the loaded article. 
     275     * 
     276     * @param mixed $handler_id The ID of the handler. 
     277     * @param mixed &$data The local request data. 
    275278     */ 
    276279    function _show_edit ($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/group/create.php

    r12824 r14385  
    120120     * @param string $handler_id Name of the used handler 
    121121     * @param mixed $args Array containing the variable arguments passed to the handler 
    122      * @param mixed $data Data passed to the show method 
     122     * @param mixed &$data Data passed to the show method 
    123123     * @return boolean Indicating successful request 
    124124     */ 
    …… 
    151151     * @access private 
    152152     * @param string $handler_id Name of the used handler 
    153      * @param mixed $data Data passed to the show method 
     153     * @param mixed &$data Data passed to the show method 
    154154     */ 
    155155    function _show_create($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/group/edit.php

    r13501 r14385  
    119119     * @param string $handler_id Name of the used handler 
    120120     * @param mixed $args Array containing the variable arguments passed to the handler 
    121      * @param mixed $data Data passed to the show method 
     121     * @param mixed &$data Data passed to the show method 
    122122     * @return boolean Indicating successful request 
    123123     */ 
    …… 
    186186     * @access private 
    187187     * @param string $handler_id Name of the used handler 
    188      * @param mixed $data Data passed to the show method 
     188     * @param mixed &$data Data passed to the show method 
    189189     */ 
    190190    function _show_edit($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/group/list.php

    r14329 r14385  
    152152     * Show the moving of a group phase 
    153153     * 
     154     * @param mixed $handler_id The ID of the handler. 
     155     * @param mixed &$data The local request data. 
    154156     * @access public 
    155157     */ 
    …… 
    199201    /** 
    200202     * Show the group listing 
     203     * 
     204     * @param mixed $handler_id The ID of the handler. 
     205     * @param mixed &$data The local request data. 
    201206     */ 
    202207    function _show_list($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/group/permissions.php

    r12858 r14385  
    8585     * @param string $handler_id Name of the used handler 
    8686     * @param mixed $args Array containing the variable arguments passed to the handler 
    87      * @param mixed $data Data passed to the show method 
     87     * @param mixed &$data Data passed to the show method 
    8888     * @return boolean Indicating successful request 
    8989     */ 
    …… 
    134134     * @access private 
    135135     * @param string $handler_id Name of the used handler 
    136      * @param mixed $data Data passed to the show method 
     136     * @param mixed &$data Data passed to the show method 
    137137     */ 
    138138    function _show_folders($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/list.php

    r13529 r14385  
    106106     * @param string $handler_id Name of the used handler 
    107107     * @param mixed $args Array containing the variable arguments passed to the handler 
    108      * @param mixed $data Data passed to the show method 
     108     * @param mixed &$data Data passed to the show method 
    109109     * @return boolean Indicating successful request 
    110110     */ 
    …… 
    229229     * @access private 
    230230     * @param string $handler_id Name of the used handler 
    231      * @param mixed $data Data passed to the show method 
     231     * @param mixed &$data Data passed to the show method 
    232232     */ 
    233233    function _show_list($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/user/create.php

    r12824 r14385  
    121121     * @param string $handler_id Name of the used handler 
    122122     * @param mixed $args Array containing the variable arguments passed to the handler 
    123      * @param mixed $data Data passed to the show method 
     123     * @param mixed &$data Data passed to the show method 
    124124     * @return boolean Indicating successful request 
    125125     */ 
    …… 
    152152     * @access private 
    153153     * @param string $handler_id Name of the used handler 
    154      * @param mixed $data Data passed to the show method 
     154     * @param mixed &$data Data passed to the show method 
    155155     */ 
    156156    function _show_create($handler_id, &$data) 

  • trunk/midcom/midcom.admin.user/handler/user/edit.php

    r14329 r14385  
    146146     * @param string $handler_id Name of the used handler 
    147147     * @param mixed $args Array containing the variable arguments passed to the handler 
    148      * @param mixed $data Data passed to the show method 
     148     * @param mixed &$data Data passed to the show method 
    149149     * @return boolean Indicating successful request 
    150150     */ 
    …… 
    205205     * @access private 
    206206     * @param string $handler_id Name of the used handler 
    207      * @param mixed $data Data passed to the show method 
     207     * @param mixed &$data Data passed to the show method 
    208208     */ 
    209209    function _show_edit($handler_id, &$data) 
    …… 
    243243     * Auto-generate passwords on the fly 
    244244     * 
     245     * @param mixed $handler_id The ID of the handler. 
     246     * @param mixed &$data The local request data. 
    245247     * @access public 
    246248     */ 
    …… 
    460462     * Show the batch password change form 
    461463     * 
     464     * @param mixed $handler_id The ID of the handler. 
     465     * @param mixed &$data The local request data. 
    462466     * @access public 
    463467     */ 

  • trunk/midcom/midcom.core/midcom/application.php

    r14341 r14385  
    108108{ 
    109109    /** 
    110      * Holds the component context information. This is an array of arrays, the outer 
    111      * one indexed by context IDs, the inner one indexed by context keys. Only valid 
    112      * of the system has left the code-init phase. 
     110     * Holds the component context information. 
     111     * 
     112     * This is an array of arrays, the outer one indexed by context IDs, the 
     113     * inner one indexed by context keys. Only valid of the system has left