Changeset 14392

Show
Ignore:
Timestamp:
01/12/08 20:03:05 (9 months ago)
Author:
flack
Message:

some facelifting and param tag fixes for phpdoc

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/fi.protie.navigation/main.php

    r14380 r14392  
    4242     * 
    4343     * @access private 
    44      * @var object midcom_helper_nav 
     44     * @var midcom_helper_nav 
    4545     */ 
    4646    var $_nap = null; 

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

    r14389 r14392  
    211211 * classes can of course define more then one request handler. 
    212212 * 
    213  * A plugin class must be a descendant of Midcom_baseclasses_components_handler or at 
     213 * A plugin class must be a descendant of midcom_baseclasses_components_handler or at 
    214214 * least support its full interface. 
    215215 * 

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

    r11859 r14392  
    99 
    1010/** 
    11  * This is the base class for all objects within the MidCOM core. Usually you should 
    12  * not need to inherit from this class directly, as all baseclasses made available 
    13  * for usage are somehow derived from this class. 
     11 * This is the base class for all objects within the MidCOM core.  
     12 * Usually you should not need to inherit from this class directly, as all  
     13 * baseclasses made available for usage are somehow derived from this class. 
    1414 *  
    15  * A noteable exception are all inherited MgdSchema driven database classes, which 
     15 * A notable exception are all inherited MgdSchema driven database classes, which 
    1616 * are not inherited from this class.  
    1717 *  

  • trunk/midcom/midcom.core/midcom/core/manifest.php

    r14329 r14392  
    219219    /** 
    220220     * This is the translated, full component name obtained by looking up the string 
    221      * $name in the l10n library $name. This member is only populated on demand by the 
    222      * get_translated_name() function. 
     221     * $name in the l10n library $name.  
     222 
     223     * This member is only populated on demand by the get_translated_name() function. 
    223224     */ 
    224225    var $name_translated = null; 
    …… 
    247248 
    248249    /** 
    249      * Privileges array definition. Indexes are the full privilege names (including the component 
     250     * Privileges array definition.  
     251     * 
     252     * Indexes are the full privilege names (including the component 
    250253     * prefix), values are arrays holding the global / owner privilege default. 
    251254     * 
    …… 
    257260 
    258261    /** 
    259      * A list of class definition filenames (all looked up in the components configuration 
    260      * directory). 
     262     * A list of class definition filenames  
     263     * 
     264     * (all looked up in the components configuration directory). 
    261265     * 
    262266     * @var array 
    …… 
    272276 
    273277    /** 
    274      * Custom place to extend the schema, the array holds data indexed by the component name 
     278     * Custom place to extend the schema. 
     279     * 
     280     * The array holds data indexed by the component name 
    275281     * they are relevant to. 
    276282     * 
    …… 
    286292    /** 
    287293     * The constructor loads the manifest indicated by the filename passed to it. 
     294     * 
    288295     * If it is a relative path, it is evaluated against MIDCOM_ROOT. Otherwise, 
    289296     * the file is accessed directly. 
    …… 
    366373    /** 
    367374     * This is an internal startup helper which extracts and post-processes the privilege 
    368      * definitions in the loaded manifest information. It will not complete any missing 
    369      * owner default privileges, this is done by the Authentication service upon privilege 
    370      * registering. 
     375     * definitions in the loaded manifest information. 
     376     * 
     377     * It will not complete any missing owner default privileges, this is done by the  
     378     * Authentication service upon privilege registering. 
    371379     * 
    372380     * @access protected 

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

    r14380 r14392  
    4242 *    required SnippetDirs. 
    4343 * 2. Load all Snippets related with the MidCOM Interface Concept 
    44  *    Classes and instantiate the Midcom and Component concept 
     44 *    Classes and instantiate the MidCOM and Component concept 
    4545 *    classes, initialize the Component. Check whether all 
    4646 *    required concept classes exist. 

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

    r14328 r14392  
    8282    *  
    8383    *  
    84     * @return string Midcom stylename. 
     84    * @return string MidCOM stylename. 
    8585    */ 
    8686     

  • trunk/midcom/midcom.core/midcom/services/i18n.php

    r14327 r14392  
    1010 
    1111/** 
    12  * This is a basic Midcom Service which provides an interfaces to the 
    13  * various I18n facilities of Midcom. 
     12 * This is a basic MidCOM Service which provides an interfaces to the 
     13 * various I18n facilities of MidCOM. 
    1414 * 
    1515 * The I18n service serves as a central access point for all aspects 
    …… 
    4848 
    4949    /** 
    50      * Preferred languages extracted out of the HTTP content negotiation. Array 
    51      * keys are the languages, the value is their q-index. 
     50     * Preferred languages extracted out of the HTTP content negotiation. 
     51     * 
     52     * Array keys are the languages, the value is their q-index. 
    5253     * 
    5354     * @var Array 
    …… 
    5758 
    5859    /** 
    59      * Preferred charsets extracted out of the HTTP content negotiation. Array 
    60      * keys are the charsets, the value is their q-index. 
     60     * Preferred charsets extracted out of the HTTP content negotiation. 
     61     * 
     62     * Array keys are the charsets, the value is their q-index. 
    6163     * 
    6264     * @var Array 
    …… 
    6668 
    6769    /** 
    68      * Stores the associative array stored in the cookie 
    69      * "midcom_services_i18n" which contains the keys "language" and 
     70     * Stores the associative array stored in the cookie "midcom_services_i18n" 
     71     * 
     72     * Contains the keys "language" and 
    7073     * "charset" or null if the cookie was not set. 
    7174     * 
    …… 
    8487 
    8588    /** 
    86      * Cache of all instantiated localization classes. They are delivered 
    87      * by reference to all clients. 
     89     * Cache of all instantiated localization classes. 
     90     * 
     91     * They are delivered by reference to all clients. 
    8892     * 
    8993     * @var Array 
    …… 
    101105 
    102106    /** 
    103      * Current language for content. May be different than the UI language 
     107     * Current language for content. 
     108     * 
     109     * May be different than the UI language 
    104110     * 
    105111     * @var string 
    …… 
    109115 
    110116    /** 
    111      * Current Midgard language ID for content. May be different than the UI language 
     117     * Current Midgard language ID for content. 
     118     * 
     119     * May be different than the UI language 
    112120     * 
    113121     * @var string 
    …… 
    125133 
    126134    /** 
    127      * List of different language versions of the site in the format 
    128      * of an array indexed by language ID and containing midgard_host 
    129      * objects 
     135     * List of different language versions of the site 
     136     * 
     137     * Format: An array indexed by language ID and containing midgard_host objects 
    130138     * 
    131139     * @var array 
    …… 
    136144    /** 
    137145     * This method initializes the available i18n framework by determining 
    138      * the desired language  from these different sources: HTTP Content 
    139      * Negotiation, Client side language cookie. It uses the MidCOM Language 
    140      * database now located at  /midcom/services/i18n/_i18n_language-db for 
    141      * any decisions. Its two parameters set the default language in case 
    142      * that none is supplied via HTTP Content Negotiation or through Cookies. 
     146     * the desired language from these different sources: HTTP Content 
     147     * Negotiation, Client side language cookie. 
     148     * 
     149     * It uses the MidCOM Language database now located at 
     150     * /midcom/services/i18n/_i18n_language-db for any decisions. Its two 
     151     * parameters set the default language in case that none is supplied 
     152     * via HTTP Content Negotiation or through Cookies. 
    143153     * 
    144154     * The default language set on startup is currently hardcoded to en 
    …… 
    411421 
    412422    /** 
    413      * Returns a l10n class instance (see the snippet documentation at 
    414      * /midcom/services/_i18n_l10n for details) which can be used to 
    415      * access the localization data of the current component. Using the 
    416      * special name "midcom" you will get the midcom core l10n library. 
     423     * Returns a l10n class instance which can be used to 
     424     * access the localization data of the current component. 
     425     * 
     426     * Using the special name "midcom" you will get the midcom core l10n library. 
    417427     * 
    418428     * Note that you are receiving a reference here. 
    419429     * 
     430     * @see midcom_services__i18n_l10n 
    420431     * @param string $component The component for which to retrieve a string database. 
    421432     * @param string $database  The string table to retrieve from the component's locale directory. 
    …… 
    463474 
    464475    /** 
    465      * This is a shortcut for echo $this->get_string(...);. To keep the naming stable with the actual 
    466      * l10n class, this is not called echo_string (Zend won't allow $l10n->echo().) 
     476     * This is a shortcut for echo $this->get_string(...);. 
     477     * 
     478     * To keep the naming stable with the actual l10n class, this is not called 
     479     * echo_string (Zend won't allow $l10n->echo().) 
    467480     * 
    468481     * @param string $stringid The string to translate. 
    …… 
    480493 
    481494    /** 
    482      * Load the specified l10n library. If loading the library failed, generate_error 
    483      * is called, otherwise the l10n db cache is populated accordingly. 
     495     * Load the specified l10n library. 
     496     * 
     497     * If loading the library failed, generate_error is called, otherwise the l10n 
     498     * db cache is populated accordingly. 
    484499     * 
    485500     * @param string $component The component for which to retrieve a string database. 
    …… 
    597612     * This method pulls available language and content type data out of 
    598613     * the HTTP Headers delivered by the browser and populates the member 
    599      * variables $_http_lang and $_http_content_type. q-parameters for 
    600      * prioritization are supported. 
     614     * variables $_http_lang and $_http_content_type. 
     615     * 
     616     * q-parameters for prioritization are supported. 
    601617     */ 
    602618    function _read_http_negotiation () 
    …… 
    728744 
    729745    /** 
    730      * This is a calling wrapper to the iconv library. See the PHP iconv() function 
    731      * for the exact parameter definitions. 
     746     * This is a calling wrapper to the iconv library. 
     747     * 
     748     * See the PHP iconv() function for the exact parameter definitions. 
    732749     * 
    733750     * @param string $source_charset The charset to convert from. 
    …… 
    786803 
    787804    /** 
    788      * Converts the given string to the current site charset. The charset should be 
    789      * specified explicitly, as autodetection is very very error prone (though sometimes 
    790      * you don't have a choice). 
     805     * Converts the given string to the current site charset. 
     806     * 
     807     * The charset should be specified explicitly, as autodetection is very 
     808     * very error prone (though sometimes you don't have a choice). 
    791809     * 
    792810     * @param string $string The string to convert. 
    …… 
    806824 
    807825    /** 
    808      * Charset-aware replacement of html_entity_decode. Uses Iconv to modify the 
    809      * HTML_ENTITIES translation tables. 
     826     * Charset-aware replacement of html_entity_decode. 
     827     * 
     828     * Uses Iconv to modify the HTML_ENTITIES translation tables. 
    810829     * 
    811830     * In addition, this will drop all numeric HTML entities. 

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

    r14391 r14392  
    3131    /** 
    3232     * The xml factory class 
    33      * @var object midcom_services_indexer_solrDocumentFactory 
     33     * @var midcom_services_indexer_solrDocumentFactory 
    3434     */ 
    3535    private $factory = null; 
    3636    /** 
    3737     * The http_request wrapper 
    38      * @var object midcom_services_indexer_solrRequest 
     38     * @var midcom_services_indexer_solrRequest 
    3939     */ 
    4040    private $request = null; 

  • trunk/midcom/midcom.core/midcom/services/rcs/handler/rcs.php

    r14328 r14392  
    2424    /** 
    2525     * Backend object 
    26      * @var object midcom_servcies_rcs_backend 
     26     * 
     27     * @var midcom_servcies_rcs_backend 
    2728     * @access private 
    2829     */ 
    …… 
    3132    /** 
    3233     * Pointer to the diff object 
     34     * 
    3335     * @access private 
    34      * @var object text_diff 
     36     * @var text_diff 
    3537     */ 
    3638     var $_diff = null; 

  • trunk/midcom/midcom.helper.datamanager/datamanager.php

    r14391 r14392  
    7979 * datamanager_datatype_", while the widget object names use "midcom_helper_ 
    8080 * datamanager_widget_" as prefix. If you want custom datatypes or widgets not 
    81  * given by Midcom, prefix them with "custom_", i.e. "midcom_helper_datamanager_ 
     81 * given by MidCOM, prefix them with "custom_", i.e. "midcom_helper_datamanager_ 
    8282 * datatype_custom_mydatatype". 
    8383 * 
    …… 
    11161116                $this->_update_nemein_rcs(); 
    11171117                $_MIDCOM->cache->invalidate($this->_storage->guid()); 
    1118                 debug_add("Invalidated Midcom Cache."); 
     1118                debug_add("Invalidated MidCOM Cache."); 
    11191119            } 
    11201120 

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

    r14390 r14392  
    5050 * it (otherwise properly) inside MidCOM application 
    5151 * 
    52  * @param string $xml reference to importable XML 
     52 * @param string &$xml reference to importable XML 
    5353 * @param boolean $use_force whether to use force 
    5454 * @return array of objects unserialized from XML (or false for failure) 
    …… 
    8686 * Workaround for Zend bug regarding object handling inside methods 
    8787 * 
    88  * @param string $xml reference to importable XML 
     88 * @param string &$xml reference to importable XML 
    8989 * @param boolean $use_force whether to use force 
    9090 * @return boolean indicating success/failure 

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

    r14390 r14392  
    9393     * This should be overridden in subclasses for more contextual handling of dependencies. 
    9494     * 
    95      * @param string $xml XML replication content 
     95     * @param string &$xml XML replication content 
    9696     * @param boolean $use_force Whether to force importing 
    9797     * @return boolean Whether importing was successful 

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

    r14322 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package midcom.helper.replicator 

  • trunk/midcom/net.nemein.discussion/helper_email_import.php

    r14329 r14392  
    478478     * Rewrites org_openpsa_mail object properties according to configuration 
    479479     * 
    480      * @param object $mail reference to org_openpsa_mail object 
     480     * @param object &$mail reference to org_openpsa_mail object 
    481481     * @return boolean indicating success/failure 
    482482     */ 

  • trunk/midcom/no.bergfald.rcs/rcs.php

    r14328 r14392  
    2626     * Backend object 
    2727     *  
    28      * @var object no_nu_versoning_backend 
     28     * @var no_nu_versoning_backend 
    2929     * @access private 
    3030     */ 
    …… 
    3535     *  
    3636     * @access private 
    37      * @var object text_diff 
     37     * @var text_diff 
    3838     */ 
    3939     var $_diff = null; 

  • trunk/midcom/no.odindata.quickform2/factory.php

    r14380 r14392  
    1515    /** 
    1616     * The schema to use. Public until the controller is loaded. 
    17      * @var array; 
     17     * @var array 
    1818     * @access public 
    1919     */ 
    …… 
    2121 
    2222    /** 
    23      * @var object midcom_helper_config 
     23     * @var midcom_helper_configuration 
    2424     */ 
    2525    var $config = null; 
    …… 
    3333    /** 
    3434     * Datamanager controller 
    35      * @var object midcom.helper.datamanager2 
     35     * @var midcom_helper_datamanager2controller 
    3636     */ 
    3737    var $_controller; 

  • trunk/midcom/org.openpsa.calendar/participant_midcomdba.php

    r14380 r14392  
    88 
    99/** 
    10  * Midcom wants this class present and QB etc use this, so keep logic here 
     10 * MidCOM wants this class present and QB etc use this, so keep logic here 
    1111 * @package org.openpsa.calendar 
    1212 */ 

  • trunk/midcom/org.openpsa.invoices/invoice.php

    r13025 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.openpsa.invoices 

  • trunk/midcom/org.openpsa.invoices/invoice_hour.php

    r4794 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.openpsa.invoices 

  • trunk/midcom/org.openpsa.projects/expense_midcomdba.php

    r14085 r14392  
    88 
    99/** 
    10  * Midcom wrapped access to the MgdSchema class, keep logic here 
     10 * MidCOM wrapped access to the MgdSchema class, keep logic here 
    1111 * 
    1212 * @package org.openpsa.projects 

  • trunk/midcom/org.openpsa.projects/hour_report_midcomdba.php

    r14085 r14392  
    88 
    99/** 
    10  * Midcom wrapped access to the MgdSchema class, keep logic here 
     10 * MidCOM wrapped access to the MgdSchema class, keep logic here 
    1111 * 
    1212 * @package org.openpsa.projects 

  • trunk/midcom/org.openpsa.projects/resource_midcomdba.php

    r14085 r14392  
    88 
    99/** 
    10  * Midcom wrapped access to the MgdSchema class, keep logic here 
     10 * MidCOM wrapped access to the MgdSchema class, keep logic here 
    1111 * 
    1212 * @package org.openpsa.projects 

  • trunk/midcom/org.openpsa.projects/task_midcomdba.php

    r14327 r14392  
    88 
    99/** 
    10  * Midcom wrapped access to the MgdSchema class, keep logic here 
     10 * MidCOM wrapped access to the MgdSchema class, keep logic here 
    1111 * 
    1212 * @package org.openpsa.projects 

  • trunk/midcom/org.openpsa.projects/task_status_midcomdba.php

    r4794 r14392  
    99 
    1010/** 
    11  * Midcom wrapped access to the MgdSchema class, keep logic here 
     11 * MidCOM wrapped access to the MgdSchema class, keep logic here 
    1212 * @package org.openpsa.projects 
    1313 */ 

  • trunk/midcom/org.openpsa.relatedto/relatedto.php

    r13625 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.openpsa.relatedto 

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

    r14180 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.openpsa.sales 

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

    r6154 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.openpsa.sales 

  • trunk/midcom/org.routamc.gallery/handler/view.php

    r14387 r14392  
    3333     * Photo shown on the page 
    3434     * 
    35      * @var org_routamc_photostream_photo $_photo 
     35     * @var org_routamc_photostream_photo_dba $_photo 
    3636     */ 
    3737    var $_photo; 

  • trunk/midcom/org.routamc.statusmessage/message.php

    r6148 r14392  
    99 
    1010/** 
    11  * Midcom wrapped base class, keep logic here 
     11 * MidCOM wrapped base class, keep logic here 
    1212 * 
    1313 * @package org.routamc.statusmessage