Changeset 14328

Show
Ignore:
Timestamp:
01/08/08 23:44:22 (9 months ago)
Author:
flack
Message:

added @static tags to functions where docs said they were static only

improved docblock layout in some cases and fixed other

plus the usual spelling fixes along the way

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/build/installMidcomCore.php

    r14327 r14328  
    151151        /*** 
    152152         * Symlink core MgdSchema 
    153          **/ 
     153         */ 
    154154        $module_name = 'midcom_core'; 
    155155        $schema = sprintf("%s/config/mgdschema/midcom_dbobjects.xml", $this->from); 

  • trunk/midcom/build/packageMidCOMcore.php

    r13572 r14328  
    7575                $this->returnProperty = $r; 
    7676        } 
    77     /* 
     77    /** 
    7878     * the template pacakge.xml file to use.  
    79      * */ 
     79     */ 
    8080    public function setTemplate($t) { 
    8181        $this->template = $t; 
    …… 
    9191    // todo: add a setVersion from the commandline 
    9292    protected $copyfiles = array (); 
    93     /* array of files in the static dir. */ 
     93    /** 
     94     * array of files in the static dir.  
     95     */ 
    9496    protected $staticFiles ; 
    9597 
    …… 
    150152        // todo add release notes... 
    151153    } 
    152     /* 
     154    /** 
    153155     * This method builds the list of files in the static dir and adds them to the  
    154      * */ 
     156     */ 
    155157    protected function addStatic($package)  
    156158    { 
    …… 
    188190    } 
    189191 
    190     /* 
     192    /** 
    191193     * sets up the basic packageobject 
    192      * @returns the package object 
    193      * */ 
     194     * @return the package object 
     195     */ 
    194196    protected function makeBase($options) { 
    195197        PEAR::setErrorHandling(PEAR_ERROR_DIE); 

  • trunk/midcom/cc.kaktus.exhibitions/navigation.php

    r10959 r14328  
    1313 * @package cc.kaktus.exhibitions 
    1414 */ 
    15  
    1615class cc_kaktus_exhibitions_navigation extends midcom_baseclasses_components_navigation 
    1716{ 

  • trunk/midcom/com.magnettechnologies.contactgrabber/config.php

    r14085 r14328  
    2828  * along with this program; if not, write to the Free Software 
    2929  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    30   **/ 
     30  */ 
    3131 
    3232// Write full path to this istallation directory 

  • trunk/midcom/com.magnettechnologies.contactgrabber/contactgrabber.php

    r14085 r14328  
    3232    * 
    3333    * @package com.magnettechnologies.contactgrabber 
    34     **/ 
     34    */ 
    3535class com_magnettechnologies_contactgrabber extends midcom_baseclasses_components_purecode 
    3636{ 

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/gmail/libgmailer.php

    r14327 r14328  
    2222  * along with this program; if not, write to the Free Software 
    2323  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24   **/ 
     24  */ 
    2525 
    2626 

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/myspace/grabMyspace.class.php

    r11459 r14328  
    2222  * along with this program; if not, write to the Free Software 
    2323  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24   **/ 
     24  */ 
    2525 
    2626class myspace 

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/orkut/grabOrkut.class.php

    r11471 r14328  
    2222  * along with this program; if not, write to the Free Software 
    2323  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24   **/ 
     24  */ 
    2525 
    2626     

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/rediff/grabRediff.class.php

    r11471 r14328  
    2222  * along with this program; if not, write to the Free Software 
    2323  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24   **/ 
     24  */ 
    2525 
    2626 

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/class.GrabYahoo.php

    r14082 r14328  
    2222    * along with this program; if not, write to the Free Software 
    2323    * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24     **/ 
     24    */ 
    2525 
    2626 

  • trunk/midcom/com.magnettechnologies.contactgrabber/lib/yahoo/config.php

    r11775 r14328  
    2222  * along with this program; if not, write to the Free Software 
    2323  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA. 
    24   **/ 
     24  */ 
    2525 
    2626// Write full path to this istallation directory 

  • trunk/midcom/de.bitfolge.feedcreator/feedcreator.php

    r14327 r14328  
    181181/** 
    182182 * Version string. 
    183  **/ 
     183 */ 
    184184define("FEEDCREATOR_VERSION", "FeedCreator 1.7.6(BH)"); 
    185185 
    …… 
    528528 
    529529        /** 
    530         * The url of the external xsl stylesheet used to format the naked rss feed. 
    531         * Ignored in the output when empty. 
    532         */ 
     530        * The url of the external xsl stylesheet used to format the naked rss feed. 
     531        * Ignored in the output when empty. 
     532        */ 
    533533        var $xslStyleSheet = ""; 
    534534 
    …… 
    539539        var $items = Array(); 
    540540 
    541         /* 
     541        /** 
    542542         * Generator string 
    543543         * 
    …… 
    557557         * This feed's character encoding. 
    558558         * @since 1.6.1 
    559          **/ 
     559         */ 
    560560        var $encoding = "UTF-8"; //"ISO-8859-1"; 
    561561 
    …… 
    586586         * 
    587587         * 
    588          **/ 
     588         */ 
    589589         function version() { 
    590590 

  • trunk/midcom/midcom.admin.styleeditor/admin.php

    r14135 r14328  
    1414    var $msg; 
    1515 
    16         /* the current topic we are in 
     16        /** 
     17         * the current topic we are in 
     18         *  
    1719         * @var current_topic 
    1820         * @access public 
    19          **/ 
     21         */ 
    2022        var $_current_topic = 0; 
    21     /* pointer to midcom_session_object */ 
     23         
     24    /** 
     25     * pointer to midcom_session_object  
     26     */ 
    2227    var $_session = null; 
    2328 

  • trunk/midcom/midcom.core/documentation/INSTALL

    r6121 r14328  
    1313now integrated into the MidCOM core. There are no known  
    1414problems with mod_midgard_preparser or the Apache 2 mod_midgard, but it 
    15 has not been throughoutly tested. 
     15has not been thoroughly tested. 
    1616 
    1717PHP 5.1.x is required at least, 5.2 or newer is strongly recommended. You 
    …… 
    1919 
    2020* iconv for character translation in the I18n subsystem 
    21 * dba for flat file database support, one of the Berkly DB Handlers 
     21* dba for flat file database support, one of the Berkeley DB Handlers 
    2222  is strongly recommended here, they are the only ones tested (db2, db3 or db4) 
    2323* The Multibyte String extensions are required. 

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

    r14217 r14328  
    25202520     * "self" is fixed by appending the MidCOM site prefix. 
    25212521     * 
    2522      * @returns MidgardObject    Midgard status information. 
     2522     * @return MidgardObject    Midgard status information. 
    25232523     */ 
    25242524    function get_midgard() 

  • trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php

    r14179 r14328  
    6666 * The most important change is that all four original component interface concepts 
    6767 * have been unified into a single class supporting the full interface. Obviously, 
    68  * MidCOMs component loader had to be adapted to this operation. 
     68 * MidCOM's component loader had to be adapted to this operation. 
    6969 * 
    7070 * At this time, the core will not be able to handle the original pre-2.4 interface 
    …… 
    108108 * Manifest: 
    109109 * 
    110  * <pre> 
     110 * <code> 
    111111 * 'name' => 'net.nehmer.static', 
    112112 * 'purecode' => false, 
    …… 
    118118 * ), 
    119119 * 'class_definitions' => Array('my_sepcial_mgd_schema_class.inc'), 
    120  * </pre> 
     120 * </code> 
    121121 * 
    122122 * See the class midcom_core_manifest for further details. 
    …… 
    865865 
    866866    /**#@+ 
    867      * This is an event handler which is called during MidCOMs component interaction. 
     867     * This is an event handler which is called during MidCOM's component interaction. 
    868868     * For most basic components, the default implementation should actually be enough. 
    869869     * 

  • trunk/midcom/midcom.core/midcom/baseclasses/components/request_admin.php

    r14140 r14328  
    11<?php 
    2  
    32/** 
    43 * @package midcom.baseclasses 
    …… 
    4241 * 
    4342 * <code> 
    44  * <?php 
    4543 *  $this->_request_switch[] = Array 
    4644 *  ( 
    …… 
    5149 *      'disable_return_to_topic' => false 
    5250 *  ); 
    53  * ?> 
    5451 * </code> 
    5552 * 
    …… 
    118115        if (! $this->_request_switch) 
    119116        { 
    120             // Generic and personal welcom pages 
     117            // Generic and personal welcome pages 
    121118            $this->_request_switch['welcome'] = Array 
    122119            ( 

  • trunk/midcom/midcom.core/midcom/baseclasses/core/dbobject.php

    r14179 r14328  
    3131 * 
    3232 * @package midcom.baseclasses 
     33 * @static 
    3334 */ 
    3435class midcom_baseclasses_core_dbobject 
    …… 
    3839     * 
    3940     * Separated so that dbfactory->import() can reuse the code 
    40      **/ 
     41     *  
     42     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     43     * @return bool Indicating success. 
     44     */ 
    4145    function update_pre_checks(&$object) 
    4246    { 
    …… 
    103107     * 
    104108     * Separated so that dbfactory->import() can reuse the code 
    105      **/ 
     109     *  
     110     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     111     */ 
    106112    function update_post_ops(&$object) 
    107113    { 
    …… 
    273279     * 
    274280     * Separated so that dbfactory->import() can reuse the code 
    275      **/ 
     281     *  
     282     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     283     */ 
    276284    function create_pre_checks(&$object) 
    277285    { 
    …… 
    361369     * 
    362370     * Separated so that dbfactory->import() can reuse the code 
    363      **/ 
     371     *  
     372     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     373     */ 
    364374    function create_post_ops(&$object) 
    365375    { 
    …… 
    428438     * 
    429439     * Separated so that dbfactory->import() can reuse the code 
    430      **/ 
     440     *  
     441     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     442     */ 
    431443    function delete_pre_checks(&$object) 
    432444    { 
    …… 
    528540     * 
    529541     * Separated so that dbfactory->import() can reuse the code 
    530      **/ 
     542     *  
     543     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
     544     */ 
    531545    function delete_post_ops(&$object) 
    532546    { 
    …… 
    907921    /** 
    908922     * Generates URL-safe name for an object and stores it if needed 
     923     *  
     924     * @param MidgardObject $object A class inherited from one of the MgdSchema driven Midgard classes supporting the above callbacks. 
    909925     */ 
    910926    function generate_urlname($object, $titlefield = 'title') 

  • trunk/midcom/midcom.core/midcom/core/group.php

    r14179 r14328  
    146146     * @param midcom_core_user $user The user that should be looked-up. 
    147147     * @return Array An array of member groups or false on failure. 
     148     * @static 
    148149     */ 
    149150    function list_memberships($user) 

  • trunk/midcom/midcom.core/midcom/core/group_midgard.php

    r14083 r14328  
    194194     * @param midcom_core_user $user The user that should be looked-up. 
    195195     * @return Array An array of member groups or false on failure, indexed by their ID. 
     196     * @static 
    196197     */ 
    197198    function list_memberships($user) 

  • trunk/midcom/midcom.core/midcom/core/group_virtual.php

    r14083 r14328  
    2323 * @package midcom 
    2424 */ 
    25  
    2625class midcom_core_group_virtual extends midcom_core_group 
    2726{ 
    …… 
    161160     * @param midcom_core_user $user The user that should be looked-up. 
    162161     * @return Array An array of member groups or false on failure, indexed by their id.. 
     162     * @static 
    163163     */ 
    164164    function list_memberships($user) 

  • trunk/midcom/midcom.core/midcom/core/privilege.php

    r14327 r14328  
    364364     * @param object $the_object A reference to the object or GUID to query. 
    365365     * @return Array A list of midcom_core_privilege instances. 
     366     * @static 
    366367     */ 
    367368    function get_content_privileges($guid) 
    …… 
    391392     * @param object $the_object A reference to the object or GUID to query. 
    392393     * @return Array A list of midcom_core_privilege instances. 
     394     * @static 
    393395     */ 
    394396    function get_self_privileges($guid) 
    …… 
    418420     * @param string GUID the GUID of the object for which we should look up privileges. 
    419421     * @return Array A list of midcom_core_privilege instances. 
     422     * @static 
    420423     */ 
    421424    function get_all_privileges($guid) 
    …… 
    451454     * @param string $guid The GUID of the object for which to query ACL data. 
    452455     * @return Array A list of midcom_core_privilege instances. 
     456     * @static 
    453457     */ 
    454458    function _query_all_privileges($guid) 
    …… 
    519523     * @param string $classname The optional classname required only for class-limited SELF privileges. 
    520524     * @return midcom_core_privilege The privilege matching the constraints. 
     525     * @static 
    521526     */ 
    522527    function get_privilege(&$object, $name, $assignee, $classname = '') 
    …… 
    599604     * @param midcom_core_user The MidCOM user for which we should collect the privileges, null uses the currently authenticated user. 
    600605     * @return Array An array of privilege_name => privilege_value pairs valid for the given user. 
     606     * @static 
    601607     */ 
    602608    function collect_content_privileges(&$arg, $user = null) 

  • trunk/midcom/midcom.core/midcom/core/querybuilder.php

    r14179 r14328  
    4747    } 
    4848 
    49     /* 
     49    /** 
    5050     * Makes sure that all calls are catched. 
    51      * */ 
     51     */ 
    5252    function __call($name, $args) 
    5353    { 

  • trunk/midcom/midcom.core/midcom/db/article.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/element.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/event.php

    r14139 r14328  
    4242     * do this as we cannot determine the current class in a polymorphic environment without 
    4343     * having a this (this call is static). 
     44     *  
     45     * @static 
    4446     */ 
    4547    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/eventmember.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/group.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 
    …… 
    5153    /** 
    5254     * Helper function, adds the given person to this group. The current user must have 
    53      * midgard:create privileges on this objectg for this to succeed. If the person is 
     55     * midgard:create privileges on this object for this to succeed. If the person is 
    5456     * already a member of this group, nothing is done. 
    5557     * 

  • trunk/midcom/midcom.core/midcom/db/host.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/member.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/page.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/pageelement.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/person.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 
    …… 
    5052 
    5153    /** 
    52      * Adds a user to a given Midgard Group. Calle must ensure access permissions 
     54     * Adds a user to a given Midgard Group. Caller must ensure access permissions 
    5355     * are right. 
    5456     * 

  • trunk/midcom/midcom.core/midcom/db/style.php

    r14139 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/db/topic.php

    r14140 r14328  
    4343     * do this as we cannot determine the current class in a polymorphic environment without 
    4444     * having a this (this call is static). 
     45     *  
     46     * @static 
    4547     */ 
    4648    function new_query_builder() 

  • trunk/midcom/midcom.core/midcom/exec/convert_legacy_metadata.php

    r13424 r14328  
    9797} 
    9898 
    99 /* 
    100 * @ignore 
    101 */ 
     99/** 
     100 * @ignore 
     101 */ 
    102102function hide_unapproved_photos($topic) 
    103103{ 
    …… 
    118118 
    119119/** 
    120 * @ignore 
    121 */ 
     120 * @ignore 
     121 */ 
    122122function convert_aegir($node_id) 
    123123{ 

  • trunk/midcom/midcom.core/midcom/helper/_basicnav.php

    r14140 r14328  
    957957    /** 
    958958     * This function is the controlling instance of the loading mechanism. It 
    959      * is able to load the navigation data of any topic within MidCOMs topic 
     959     * is able to load the navigation data of any topic within MidCOM's topic 
    960960     * tree into memory. Any uplink nodes that are not loaded into memory will 
    961961     * be loaded until any other known topic is encountered. After the 
    …… 
    967967     * 
    968968     * @param int $node_id      The ID of the topic to be loaded 
    969      * @return int                      MIDCOM_ERROK on succes, one of the MIDCOM_ERR... constants upon an error 
     969     * @return int                      MIDCOM_ERROK on success, one of the MIDCOM_ERR... constants upon an error 
    970970     * @access private 
    971971     */ 

  • trunk/midcom/midcom.core/midcom/helper/_dbfactory.php

    r14217 r14328  
    115115     * @param mixed $value Value match for the collector instance 
    116116     * @return midcom_core_collector The initialized instance of the collector. 
    117      * @see midcom_core_querybuilder 
     117     * @see midcom_core_collector 
     118     * @s