Changeset 14390

Show
Ignore:
Timestamp:
01/12/08 16:39:27 (9 months ago)
Author:
flack
Message:

PHPdoc tag fixes and some formatting improvements

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/midcom.core/constants.php

    r14140 r14390  
    1010// Constants for the MidCOM System 
    1111 
    12 // MidCOM Property Keys 
     12/**#@+ 
     13 * MidCOM Property Keys 
     14 */ 
    1315define ('MIDCOM_PROP_DLOAD', 0); /* DEPRECATED ??? */ 
    1416define ('MIDCOM_PROP_VERSION', 1); 
    …… 
    1719define ('MIDCOM_PROP_ACL_PRIVILEGES', 4); 
    1820define ('MIDCOM_PROP_VGROUPS', 5); 
    19  
    20 // MidCOM Default Error Codes (-> HTTP) 
     21/**#@-*/ 
     22 
     23/**#@+ 
     24 *MidCOM Default Error Codes (-> HTTP) 
     25 */ 
    2126define ('MIDCOM_ERROK',200); 
    2227define ('MIDCOM_ERRNOTFOUND',404); 
    …… 
    2429define ('MIDCOM_ERRAUTH',401); 
    2530define ('MIDCOM_ERRCRIT',500); 
     31/**#@-*/ 
    2632 
    2733// MidCOM NAP URL Information Constants 
    2834 
    29 // MidCOM Meta Data Constants 
     35/**#@+ 
     36 * MidCOM Meta Data Constants 
     37 */ 
    3038define ('MIDCOM_NAV_URL',0); 
    3139define ('MIDCOM_NAV_NAME',1); 
    …… 
    5967define ('MIDCOM_META_EDITOR',102); /* DEPRECATED AS OF 2.4.0 */ 
    6068define ('MIDCOM_META_EDITED',103); /* DEPRECATED AS OF 2.4.0 */ 
    61  
    62 // MidCOM Component Context Keys 
     69/**#@-*/ 
     70 
     71/**#@+ 
     72 * MidCOM Component Context Keys 
     73 */ 
    6374define ('MIDCOM_CONTEXT_ANCHORPREFIX',0); 
    6475define ('MIDCOM_CONTEXT_SUBSTYLE',1); 
    …… 
    7384define ('MIDCOM_CONTEXT_PERMALINKGUID', 11); 
    7485define ('MIDCOM_CONTEXT_URI', 12); 
    75  
    76 // INTERNAL Context Keys, not accessible from outside midcom_application. 
     86/**#@-*/ 
     87 
     88/** 
     89 * INTERNAL Context Keys, not accessible from outside midcom_application. 
     90 */ 
    7791define ('MIDCOM_CONTEXT_CUSTOMDATA', 1000); 
    7892 
    79 // URL PARSER Object Types 
     93/**#@+ 
     94 * URL PARSER Object Types 
     95 */ 
    8096define ('MIDCOM_HELPER_URLPARSER_TOPIC',0); 
    8197define ('MIDCOM_HELPER_URLPARSER_ARTICLE',1); 
    …… 
    8399define ('MIDCOM_HELPER_URLPARSER_KEY',3); 
    84100define ('MIDCOM_HELPER_URLPARSER_VALUE',4); 
    85  
    86 // Debugger 
     101/**#@-*/ 
     102 
     103/**#@+ 
     104 * Debugger 
     105 */ 
    87106define ('MIDCOM_LOG_DEBUG', 4); 
    88107define ('MIDCOM_LOG_INFO', 3); 
    …… 
    90109define ('MIDCOM_LOG_ERROR', 1); 
    91110define ('MIDCOM_LOG_CRIT', 0); 
    92  
    93 // Client Status Array Keys 
     111/**#@-*/ 
     112 
     113/**#@+ 
     114 * Client Status Array Keys 
     115 */ 
    94116define ('MIDCOM_CLIENT_MOZILLA',0); 
    95117define ('MIDCOM_CLIENT_IE',1); 
    …… 
    99121define ('MIDCOM_CLIENT_MAC',11); 
    100122define ('MIDCOM_CLIENT_WIN',12); 
    101  
    102 // Request Types 
     123/**#@-*/ 
     124 
     125/**#@+ 
     126 * Request Types 
     127 */ 
    103128define ('MIDCOM_REQUEST_CONTENT',0); 
    104129define ('MIDCOM_REQUEST_CONTENTADM',1); 
    105130define ('MIDCOM_REQUEST_COMPONENTADM',2); 
    106  
    107 // Data Manager 
     131/**#@-*/ 
     132 
     133/**#@+ 
     134 * Data Manager 
     135 */ 
    108136define ('MIDCOM_DATAMGR_EDITING',0); 
    109137define ('MIDCOM_DATAMGR_SAVED',1); 
    …… 
    114142define ('MIDCOM_DATAMGR_CREATEFAILED',6); 
    115143define ('MIDCOM_DATAMGR_SAVE_DELAYED',7); 
    116  
    117 // MidCOM Core Status Codes 
     144/**#@-*/ 
     145 
     146/**#@+ 
     147 * MidCOM Core Status Codes 
     148 */ 
    118149define ('MIDCOM_STATUS_PREPARE',0); 
    119150define ('MIDCOM_STATUS_CANHANDLE',1); 
    …… 
    122153define ('MIDCOM_STATUS_CLEANUP',4); 
    123154define ('MIDCOM_STATUS_ABORT',5); 
    124  
    125 // MidCOM NAP Sorting Modes 
     155/**#@-*/ 
     156 
     157/**#@+ 
     158 * MidCOM NAP Sorting Modes 
     159 */ 
    126160define ('MIDCOM_NAVORDER_DEFAULT', 0); 
    127161define ('MIDCOM_NAVORDER_ARTICLESFIRST', 1); 
    128162define ('MIDCOM_NAVORDER_TOPICSFIRST', 2); 
    129163define ('MIDCOM_NAVORDER_SCORE', 3); 
    130  
     164/**#@-*/ 
    131165 
    132166/**#@+ 

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

    r14385 r14390  
    208208     * I18n service class 
    209209     * 
    210      * @var midcom_helper_i18n 
     210     * @var midcom_services_i18n 
    211211     */ 
    212212    public $i18n = null; 

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

    r14329 r14390  
    725725     * It will call the corresponding event handler reading the topic configuration beforehand. 
    726726     * 
    727      * @param midcom_services_indexer_document $document The document to check. This object is passed by 
     727     * @param midcom_services_indexer_document &$document The document to check. This object is passed by 
    728728     *     reference and may therefore be modified to match the current security policy. 
    729729     * @param MidgardTopic $topic The topic this document is assigned to. 
    …… 
    951951     * @param MidgardTopic $topic The topic to reindex. 
    952952     * @param midgard_helper_config $config The configuration associated with this topic. 
    953      * @param midcom_service_indexer The indexer object to use for indexing. (Passed by reference!) 
     953     * @param midcom_services_indexer The indexer object to use for indexing. (Passed by reference!) 
    954954     * @return boolean Indicating success. 
    955955     */ 
    …… 
    972972     * though this <i>should</i> be avoided if possible. 
    973973     * 
    974      * @param midcom_services_indexer_document $document The document to check. This object is passed by 
     974     * @param midcom_services_indexer_document &$document The document to check. This object is passed by 
    975975     *     reference and may therefore be modified to match the current security policy. 
    976976     * @param midcom_helper_configuration $config The configuration associated with the topic. 

  • trunk/midcom/midcom.core/midcom/debug.php

    r14329 r14390  
    244244     * 
    245245     * @param string $message   The message to be logged 
    246      * @param mixed $variable The variable to be logged 
     246     * @param mixed &$variable        The variable to be logged 
    247247     * @param int $loglevel             The log level 
    248248     */ 
    …… 
    318318     * 
    319319     * @param string $message   The message to be logged 
    320      * @param mixed $variable The variable of which the type should be logged 
     320     * @param mixed &$variable        The variable of which the type should be logged 
    321321     * @param int $loglevel             The log level 
    322322     */ 
    …… 
    395395 * 
    396396 * @param string $message       The message to be logged 
    397  * @param mixed $variable     The variable to be logged 
     397 * @param mixed &$variable    The variable to be logged 
    398398 * @param int $loglevel         The log level 
    399399 */ 
    …… 
    418418 * 
    419419 * @param string $message       The message to be logged 
    420  * @param mixed $variable     The variable of which the type should be logged 
     420 * @param mixed &$variable    The variable of which the type should be logged 
    421421 * @param int $loglevel         The log level 
    422422 */ 

  • trunk/midcom/midcom.core/midcom/services/indexer/backend.php

    r14329 r14390  
    3838    function index ($documents) 
    3939    { 
    40         die ('The method midcom_service_indexer_backend::index must be implemented.'); 
     40        die ('The method midcom_services_indexer_backend::index must be implemented.'); 
    4141    } 
    4242     
    …… 
    4949    function delete ($RI) 
    5050    { 
    51         die ('The method midcom_service_indexer_backend::remove must be implemented.'); 
     51        die ('The method midcom_services_indexer_backend::remove must be implemented.'); 
    5252    } 
    5353     
    …… 
    6161    function delete_all() 
    6262    { 
    63         die ('The method midcom_service_indexer_backend::remove_all must be implemented.'); 
     63        die ('The method midcom_services_indexer_backend::remove_all must be implemented.'); 
    6464    } 
    6565     
    …… 
    7575    function query ($query, $filter) 
    7676    { 
    77         die ('The method midcom_service_indexer_backend::query must be implemented.'); 
     77        die ('The method midcom_services_indexer_backend::query must be implemented.'); 
    7878    } 
    7979     

  • trunk/midcom/midcom.core/midcom/services/indexer/document.php

    r14381 r14390  
    2626 * 
    2727 * This class should not be instantiated directly, a new instance of this class 
    28  * can be obtained using the midcom_service_indexer class. 
     28 * can be obtained using the midcom_services_indexer class. 
    2929 * 
    3030 * A number of predefined fields are available using member fields. These fields 
    …… 
    289289        if (! array_key_exists($name, $this->_fields)) 
    290290        { 
    291             debug_push('midcom_service_indexer_document::get_field'); 
     291            debug_push('midcom_services_indexer_document::get_field'); 
    292292            debug_add("Field {$name} not found in the document.", MIDCOM_LOG_INFO); 
    293293            debug_pop(); 
    …… 
    311311        if (! array_key_exists($name, $this->_fields)) 
    312312        { 
    313             debug_push('midcom_service_indexer_document::get_field_record'); 
     313            debug_push('midcom_services_indexer_document::get_field_record'); 
    314314            debug_add("Field {$name} not found in the document.", MIDCOM_LOG_INFO); 
    315315            debug_pop(); 
    …… 
    734734     * Tries to resolve created,revised,author,editor and creator for the document from Midgard object 
    735735     * 
    736      * @param midgard_object $object object to use as source for the info 
     736     * @param midgard_object &$object object to use as source for the info 
    737737     */ 
    738738    function read_metadata_from_object(&$object) 

  • trunk/midcom/midcom.core/midcom/services/indexer/filter.php

    r3766 r14390  
    1818 * @abstract Abstract indexer filter class 
    1919 * @package midcom.services 
    20  * @see midcom_service_indexer 
     20 * @see midcom_services_indexer 
    2121 */ 
    2222 

  • trunk/midcom/midcom.helper.datamanager2/baseclasses/filter.php

    r14130 r14390  
    4949     * members. 
    5050     * 
    51      * @param midcom_helper_datamanager2_formmanager $formmanager The formmanager we are bound to. 
     51     * @param midcom_helper_datamanager2_formmanager &$formmanager The formmanager we are bound to. 
    5252     * @param mixed $config The configuration we are operating on. 
    5353     */ 

  • trunk/midcom/midcom.helper.datamanager2/formmanager.php

    r14380 r14390  
    196196     * constructor call, to allow for full reference safety. 
    197197     * 
    198      * @param name The name of the form. This defaults to the name of the currently active component, which should 
     198     * @param mixed $name The name of the form. This defaults to the name of the currently active component, which should 
    199199     *     suffice in most cases. 
    200200     * @return boolean Indicating success. 

  • trunk/midcom/midcom.helper.datamanager2/formmanager/ajax.php

    r14380 r14390  
    6969     * ... 
    7070     * 
    71      * @param name The name of the form. This defaults to the name of the currently active component, which should 
     71     * @param mixed $name The name of the form. This defaults to the name of the currently active component, which should 
    7272     *     suffice in most cases. 
    7373     * @return boolean Indicating success. 

  • trunk/midcom/midcom.helper.datamanager2/formmanager/paged.php

    r14380 r14390  
    6565     * ... 
    6666     * 
    67      * @param name The name of the form. This defaults to the name of the currently active component, which should 
     67     * @param mixed $name The name of the form. This defaults to the name of the currently active component, which should 
    6868     *     suffice in most cases. 
    6969     * @return boolean Indicating success. 

  • trunk/midcom/midcom.helper.datamanager2/type/blobs.php

    r14380 r14390  
    3636{ 
    3737    /** 
    38      * All attachments covered by this field. The array contains 
    39      * midcom_baseclasses_database_attachment objects indexed by their identifier 
    40      * within the field. 
     38     * All attachments covered by this field.  
     39     * The array contains midcom_baseclasses_database_attachment objects indexed by their  
     40     * identifier within the field. 
    4141     * 
    4242     * See the $attachments_info member for a more general approach easily usable 
    …… 
    4949 
    5050    /** 
    51      * This is the base URL used for attachment serving. It defaults to the global 
    52      * MidCOM attachment handler at the sites root. When constructing Attachment 
    53      * Info blocks, this URL is completed using "{$baseurl}{$guid}/{$filename}". 
     51     * This is the base URL used for attachment serving.  
     52     * 
     53     * It defaults to the global MidCOM attachment handler at the sites root.  
     54     * When constructing Attachment Info blocks, this URL is completed using  
     55     * "{$baseurl}{$guid}/{$filename}". 
    5456     * 
    5557     * @var string 
    …… 
    6062    /** 
    6163     * This member is populated and synchronized with all known changes to the 
    62      * attachments listing. It contains a batch of metadata that makes presenting 
    63      * them easy. The information is kept in an array per attachment, again indexed 
     64     * attachments listing.  
     65     * 
     66     * It contains a batch of metadata that makes presenting them easy. The  
     67     * information is kept in an array per attachment, again indexed 
    6468     * by their identifiers. The following keys are defined: 
    6569     * 
    …… 
    97101 
    98102    /** 
    99      * Set the base URL accordingly (this requires midcom_config access and is thus 
    100      * not possible using class member initializers. 
     103     * Set the base URL accordingly 
     104     * 
     105     * this requires midcom_config access and is thus not possible using class member initializers. 
    101106     */ 
    102107    function _on_configuring($config) 
    …… 
    109114 
    110115    /** 
    111      * This function loads all known attachments from the storage object. It 
    112      * will leave the field empty in case the storage object is null. 
     116     * This function loads all known attachments from the storage object.  
     117     * 
     118     * It will leave the field empty in case the storage object is null. 
    113119     */ 
    114120    function convert_from_storage ($source) 
    …… 
    154160 
    155161    /** 
    156      * This function sorts the attachment lists by filename. It has to be called 
    157      * after each attachment operation. It uses a user-defined ordering function 
    158      * for each of the two arrays to be sorted: _sort_attachments_callback() and 
    159      * _sort_attachments_info_callback(). 
     162     * This function sorts the attachment lists by filename.  
     163     * 
     164     * It has to be called after each attachment operation. It uses a  
     165     * user-defined ordering function for each of the two arrays to be sorted:  
     166     * _sort_attachments_callback() and _sort_attachments_info_callback(). 
    160167     * 
    161168     * @access protected 
    …… 
    170177 
    171178    /** 
    172      * User-defined array sorting callback, used for sorting $attachments. See the 
    173      * usort() documentation for further details. 
     179     * User-defined array sorting callback, used for sorting $attachments.  
     180     * 
     181     * See the usort() documentation for further details. 
    174182     * 
    175183     * @access protected 
    …… 
    184192 
    185193    /** 
    186      * User-defined array sorting callback, used for sorting $attachments_info. See the 
    187      * usort() documentation for further details. 
     194     * User-defined array sorting callback, used for sorting $attachments_info.  
     195     * 
     196     * See the usort() documentation for further details. 
    188197     * 
    189198     * @access protected 
    …… 
    551560 
    552561    /** 
    553      * Updates the title field of the specified attachment. This will automatically update 
    554      * the attachment info as well. 
     562     * Updates the title field of the specified attachment.  
     563     * 
     564     * This will automatically update the attachment info as well. 
    555565     * 
    556566     * @param string $identifier The identifier of the new attachment. 

  • trunk/midcom/midcom.helper.replicator/exporter.php

    r14328 r14390  
    1616     * The subscription object the transporter has been instantiated for 
    1717     * 
    18      * @var midcom_helper_replication_subscription_dba 
     18     * @var midcom_helper_replicator_subscription_dba 
    1919     * @access protected 
    2020     */ 
    …… 
    3030     * Initializes the class. The real startup is done by the initialize() call. 
    3131     * 
    32      * @param midcom_helper_replication_subscription_dba $subscription Subscription 
     32     * @param midcom_helper_replicator_subscription_dba $subscription Subscription 
    3333     */ 
    3434    function midcom_helper_replicator_exporter($subscription) 
    …… 
    5050     * <b>This function must be called statically.</b> 
    5151     * 
    52      * @param midcom_helper_replication_subscription_dba $subscription Subscription 
     52     * @param midcom_helper_replicator_subscription_dba $subscription Subscription 
    5353     * @return midcom_helper_replicator_exporter A reference to the newly created exporter instance. 
    5454     * @static 
    …… 
    128128     * Serialize attachment object 
    129129     * 
    130      * @param midgard_attachment $object The attachment object to serialize 
     130     * @param midgard_attachment &$attachment The attachment object to serialize 
    131131     * @return array Array of exported attachments metadata and blob 
    132132     */ 
    …… 
    134134    { 
    135135        debug_push_class(__CLASS__, __FUNCTION__); 
    136         debug_add("called for attachement {$attachment->guid}"); 
     136        debug_add("called for attachment {$attachment->guid}"); 
    137137        $serializations = array(); 
    138138 
    …… 
    188188     * Serialize attachments of an object 
    189189     * 
    190      * @param midgard_object $object The Object to export attachments of 
     190     * @param midgard_object &$object The Object to export attachments of 
    191191     * @return array Array of exported attachments as XML indexed by GUID 
    192192     */ 
    …… 
    241241     * Serialize parameters of an object 
    242242     * 
    243      * @param midgard_object $object The Object to export parameters of 
     243     * @param midgard_object &$object The Object to export parameters of 
    244244     * @return array Array of exported parameters as XML indexed by GUID 
    245245     */ 
    …… 
    295295     * This will also serialize the attachments and parameters of the object. 
    296296     * 
    297      * @param midgard_object $object The Object to export parameters of 
     297     * @param midgard_object &$object The Object to export parameters of 
    298298     * @return array Array of exported objects as XML indexed by GUID 
    299299     */ 
    …… 
    431431     * contextual handling of dependencies. 
    432432     * 
    433      * @param midgard_object $object The Object to export parameters of 
     433     * @param midgard_object &$object The Object to export parameters of 
    434434     * @return boolean Whether the object may be exported with this exporter 
    435435     */ 
    …… 
    469469     * contextual handling of dependencies. 
    470470     * 
    471      * @param midgard_object $object The Object to export parameters of 
     471     * @param midgard_object &$object The Object to export parameters of 
    472472     * @return array Array of exported objects as XML indexed by GUID 
    473473     */ 

  • trunk/midcom/midcom.helper.replicator/exporter/mirror.php

    r14322 r14390  
    8585     * all content this will always return true. 
    8686     * 
    87      * @param midgard_object $object The Object to export parameters of 
     87     * @param midgard_object &$object The Object to export parameters of 
    8888     * @return boolean Whether the object may be exported with this exporter 
    8989     */ 
    …… 
    162162     * Export some children of the object 
    163163     * 
    164      * @param midgard_object $object The Object to export parameters of 
     164     * @param midgard_object &$object The Object to export parameters of 
    165165     * @return array Array of exported objects as XML indexed by GUID 
    166166     */ 
    …… 
    186186     * and walk the object's parent tree as needed. 
    187187     * 
    188      * @param midgard_object $object The Object to export parameters of 
     188     * @param midgard_object &$object The Object to export parameters of 
    189189     * @return array Array of exported objects as XML indexed by GUID 
    190190     */ 
    …… 
    265265     * object itself, but also its parent hierarchy. 
    266266     * 
    267      * @param midgard_object $object The Object to export parameters of 
     267     * @param midgard_object &$object The Object to export parameters of 
    268268     * @return array Array of exported objects as XML indexed by GUID 
    269269     */ 

  • trunk/midcom/midcom.helper.replicator/exporter/staging2live.php

    r14084 r14390  
    4343     * all content this will always return true. 
    4444     * 
    45      * @param midgard_object $object The Object to export parameters of 
     45     * @param midgard_object &$object The Object to export parameters of 
    4646     * @return boolean Whether the object may be exported with this exporter 
    4747     */ 
    …… 
    283283     * Export some children of the object 
    284284     * 
    285      * @param midgard_object $object The Object to export parameters of 
     285     * @param midgard_object &$object The Object to export parameters of 
    286286     * @return array Array of exported objects as XML indexed by GUID 
    287287     * @todo rethink child/parent handling 

  • trunk/midcom/midcom.helper.replicator/helpers.php

    r14130 r14390  
    1414 * it (otherwise properly) inside MidCOM application 
    1515 * 
    16  * @param midgard_object $object reference to an object 
     16 * @param midgard_object &$object reference to an object 
    1717 * @return string object serialized (or false in case of failure) 
    1818 */ 
    …… 
    7070 * it (otherwise properly) inside MidCOM application 
    7171 * 
    72  * @param midgard_object $object reference to an object 
     72 * @param midgard_object &$object reference to an object 
    7373 * @param boolean $use_force whether to use force 
    7474 * @return boolean indicating success/failure 

  • trunk/midcom/midcom.helper.replicator/importer.php

    r14328 r14390  
    7676     
    7777    /** 
    78      * This is the checkpoint of the importer. This should be overridden in subclasses for more 
    79      * contextual handling of dependencies. 
    80      * 
    81      * @param midgard_object $object The Object to import 
     78     * This is the checkpoint of the importer.  
     79     *  
     80     * This should be overridden in subclasses for more contextual handling of dependencies. 
     81     * 
     82     * @param midgard_object &$object The Object to import 
    8283     * @return boolean Whether the object may be imported with this importer 
    8384     */ 
    …… 
    8889     
    8990    /** 
    90      * This is the main entry point of the importer. This should be overridden in subclasses for more 
    91      * contextual handling of dependencies. 
     91     * This is the main entry point of the importer.  
     92     *  
     93     * This should be overridden in subclasses for more contextual handling of dependencies. 
    9294     * 
    9395     * @param string $xml XML replication content 

  • trunk/midcom/midcom.helper.replicator/midcom/interfaces.php

    r14329 r14390  
    142142     * 
    143143     * @param array $args handler arguments 
    144      * @param object $handler reference to the cron_handler object calling this method. 
     144     * @param object &$handler reference to the cron_handler object calling this method. 
    145145     * @return boolean indicating success/failure 
    146146     * @todo figure out how to handle deleted (not purged) object replication 

  • trunk/midcom/midcom.helper.replicator/transporter.php

    r14328 r14390  
    1616     * The subscription object the transporter has been instantiated for 
    1717     * 
    18      * @var midcom_helper_replication_subscription_dba 
     18     * @var midcom_helper_replicator_subscription_dba 
    1919     * @access protected 
    2020     */ 
    …… 
    3232     * Initializes the class. The real startup is done by the initialize() call. 
    3333     * 
    34      * @param midcom_helper_replication_subscription_dba $subscription Subscription 
     34     * @param midcom_helper_replicator_subscription_dba $subscription Subscription 
    3535     */ 
    3636    function midcom_helper_replicator_transporter($subscription) 
    …… 
    5252     * <b>This function must be called statically.</b> 
    5353     * 
    54      * @param midcom_helper_replication_subscription_dba $subscription Subscription 
     54     * @param midcom_helper_replicator_subscription_dba $subscription Subscription 
    5555     * @return midcom_helper_replicator_transporter A reference to the newly created transporter instance. 
    5656     * @static 

  • trunk/midcom/midgard.admin.asgard/reflector_tree.php

    r14327 r14390  
    249249     * Statically callable method to count children of given object 
    250250     * 
    251      * @param midgard_object $object object to get children for 
     251     * @param midgard_object &$object object to get children for 
    252252     * @param boolean $deleted whether to count (only) deleted or not-deleted objects 
    253253     * @return array multidimensional array (keyed by classname) of objects or false on failure 
    …… 
    298298     * are available, check for is_callable/method_exists first ! 
    299299     * 
    300      * @param midgard_object $object the object to get parent for 
     300     * @param midgard_object &$object the object to get parent for 
    301301     */ 
    302302    function get_parent(&$object) 
    …… 
    411411     * Statically callable method to get children of given object 
    412412     * 
    413      * @param midgard_object $object object to get children for 
     413     * @param midgard_object &$object object to get children for 
    414414     * @param boolean $deleted whether to get (only) deleted or not-deleted objects 
    415415     * @return array multidimensional array (keyed by classname) of objects or false on failure 

  • trunk/midcom/midgard.admin.sitegroup/creation/config/config.php

    r14328 r14390  
    7070    /** 
    7171     * Sets a value to null 
    72      * @param name of the value 
     72     * @param string $valuename of the value 
    7373     * @return boolean true if value was deleted. 
    7474     */ 

  • trunk/midcom/net.nemein.ping/midcom/interfaces.php

    r14381 r14390  
    7474     * AT handler for handling subscription cycles. 
    7575     * @param array $args handler arguments 
    76      * @param object $handler reference to the cron_handler object calling this method. 
     76     * @param object &$handler reference to the cron_handler object calling this method. 
    7777     * @return boolean indicating success/failure 
    7878     */ 

  • trunk/midcom/org.maemo.socialnews/midcom/interfaces.php

    r14329 r14390  
    6868     * AT handler for handling recalculations 
    6969     * @param array $args handler arguments 
    70      * @param object $handler reference to the cron_handler object calling this method. 
     70     * @param object &$handler reference to the cron_handler object calling this method. 
    7171     * @return boolean indicating success/failure 
    7272     */ 

  • trunk/midcom/org.openpsa.contacts/midcom/interfaces.php

    r14338 r14390  
    365365     * AT handler for fetching Semantic Web data for person or group 
    366366     * @param array $args handler arguments 
    367      * @param object $handler reference to the cron_handler object calling this method. 
     367     * @param object &$handler reference to the cron_handler object calling this method. 
    368368     * @return boolean indicating success/failure 
    369369     */ 

  • trunk/midcom/org.openpsa.directmarketing/midcom/interfaces.php

    r14338 r14390  
    5757     * Test case for the AT service 
    5858     * @param array $args handler arguments 
    59      * @param object $handler reference to the cron_handler object calling this method. 
     59     * @param object &$handler reference to the cron_handler object calling this method. 
    6060     * @return boolean Always true 
    6161     */ 
    …… 
    7373     * Background message sending AT batch handler 
    7474     * @param array $args handler arguments 
    75      * @param object $handler reference to the cron_handler object calling this method. 
     75     * @param object &$handler reference to the cron_handler object calling this method. 
    7676     * @return boolean indicating success/failure 
    7777     */ 
    …… 
    138138     * For updating smart campaigns members in background 
    139139     * @param array $args handler arguments 
    140      * @param object $handler reference to the cron_handler object calling this method. 
     140     * @param object &$handler reference to the cron_handler object calling this method. 
    141141     * @return boolean indicating success/failure 
    142142     */ 

  • trunk/midcom/org.openpsa.documents/viewer.php

    r14387 r14390  
    179179            foreach ($this->_request_data['results'] as $document) 
    180180            { 
    181                 // $obj->RI will contain either document or attachement GUID depending on match, ->source will always contain the document GUID 
     181                // $obj->RI will contain either document or attachment GUID depending on match, ->source will always contain the document GUID 
    182182                $this->_request_data['metadata'] = $this->_metadata_handler->_load_metadata($document->source); 
    183183                if ($this->_request_data['metadata']) 

  • trunk/midcom/org.openpsa.sales/midcom/interfaces.php

    r14329 r14390  
    256256     * AT handler for handling subscription cycles. 
    257257     * @param array $args handler arguments 
    258      * @param object $handler reference to the cron_handler object calling this method. 
     258     * @param object &$handler reference to the cron_handler object calling this method. 
    259259     * @return boolean indicating success/failure 
    260260     */