Changeset 14391

Show
Ignore:
Timestamp:
01/12/08 17:15:59 (8 months ago)
Author:
flack
Message:

PHPdoc and spelling fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r14328 r14391  
    3030  */ 
    3131 
    32 // Write full path to this istallation directory 
     32// Write full path to this installation directory 
    3333// example: '/home/user/public_html/contacts' (linux) 
    3434// 

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

    r14335 r14391  
    2727  */ 
    2828 
    29 // Write full path to this istallation directory 
     29// Write full path to thisinstallation directory 
    3030// example: '/home/user/public_html/contacts' (linux) 
    3131//          

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

    r14390 r14391  
    11<?php 
    22/** 
     3 * Constants for the MidCOM System 
     4 *  
    35 * @package midcom 
    46 * @author The Midgard Project, http://www.midgard-project.org 
    …… 
    79 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
    810 */ 
    9   
    10 // Constants for the MidCOM System 
    1111 
    1212/**#@+ 

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

    r14381 r14391  
    211211 
    212212    /** 
    213      * List of all classes which have been loaded. This list only contains the class 
    214      * definitions that have been used to construct the actual helper classes. 
     213     * List of all classes which have been loaded.  
     214     *  
     215     * This list only contains the class definitions that have been used to  
     216     * construct  the actual helper classes. 
    215217     * 
    216218     * @var Array 
    …… 
    220222 
    221223    /** 
    222      * A mapping storing which component handles which class. This is used to ensure that 
    223      * all MidCOM DBA main classes are loaded when casting MgdSchema objects to DBA objects. 
    224      * Especially important for the generic by-GUID object getter. 
     224     * A mapping storing which component handles which class.  
     225     *  
     226     * This is used to ensure that all MidCOM DBA main classes are loaded when  
     227     * casting  MgdSchema objects to DBA objects. Especially important for the  
     228     * generic by-GUID object getter. 
    225229     * 
    226230     * @var Array 
    …… 
    238242 
    239243    /** 
    240      * this is the main class loader function. It takes a component/filename pair as 
     244     * This is the main class loader function. It takes a component/filename pair as 
    241245     * arguments, the first specifying the place to look for the latter. 
    242246     * 
    …… 
    312316 
    313317    /** 
    314      * This helper function validates a class definition list for correctness. Any 
    315      * error will be logged and false is returned.. 
     318     * This helper function validates a class definition list for correctness.  
     319     *  
     320     * Any error will be logged and false is returned. 
    316321     * 
    317322     * Where possible, missing elements are completed with sensible defaults. 
    …… 
    417422    /** 
    418423     * Little helper which converts a component / filename combination into a fully 
    419      * qualified path/filename. The filename is assigned to the $_class_definition_filename 
    420      * member variable of this class. 
     424     * qualified path/filename.  
     425     *  
     426     * The filename is assigned to the $_class_definition_filename member variable of this class. 
    421427     * 
    422428     * @param string $component The name of the component for which the class file has to be loaded. The path must 
    …… 
    438444    /** 
    439445     * This helper function loads a class definition file from the disk and 
    440      * returns its contents. The source must be stored in the $_class_definition_filename 
     446     * returns its contents.  
     447     *  
     448     * The source must be stored in the $_class_definition_filename 
    441449     * member. 
    442      * 
     450     *  
    443451     * It will translate component and filename into a full path and delivers 
    444452     * the contents verbatim. 
    …… 
    517525    /** 
    518526     * Simple helper that adds a list of classes to the loaded classes listing. 
     527     *  
    519528     * This function is called from the cached files, which contain a copy of the 
    520529     * class definition at their bottom to avoid eval'ing it again at each run. 

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

    r14380 r14391  
    1414 
    1515/** 
    16  * Solr implementation of the indexer backend. This works by communicating with solr 
    17  * over http requests. It uses the same tcphost and tcpport settings as the old TCP indexer used. 
     16 * Solr implementation of the indexer backend.  
     17 *  
     18 * This works by communicating with solr over http requests. It uses the same tcphost  
     19 * and tcpport settings as the old TCP indexer used. 
    1820 * 
    1921 * @package midcom.services 

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

    r14390 r14391  
    6262     * 
    6363     * @access protected 
    64      * @var midcom_service_i18n 
     64     * @var midcom_services_i18n 
    6565     */ 
    6666    var $_i18n = null; 
    …… 
    7777 
    7878    /** 
    79      * The Resource Identifier of this document. Must be UTF-8 on assignment 
    80      * already. 
     79     * The Resource Identifier of this document.  
     80     *  
     81     * Must be UTF-8 on assignment already. 
    8182     * 
    8283     * This field is mandatory. 
    …… 
    9697 
    9798    /** 
    98      * The GUID of the topic the document is assigned to. May be empty for 
    99      * non-midgard resources. 
     99     * The GUID of the topic the document is assigned to.  
     100     *  
     101     * May be empty for non-midgard resources. 
    100102     * 
    101103     * This field is mandatory. 
    …… 
    106108 
    107109    /** 
    108      * The name of the component responsible for the document. May be empty for 
    109      * non-midgard resources. 
     110     * The name of the component responsible for the document.  
     111     *  
     112     * May be empty for non-midgard resources. 
    110113     * 
    111114     * This field is mandatory. 
    …… 
    209212    /** 
    210213     * An additional tag indicating the source of the document for use by the 
    211      * component doing the indexing. This value is not indexed and should not be 
    212      * used by anybody except the component doing the indexing. 
     214     * component doing the indexing.  
     215     *  
     216     * This value is not indexed and should not be used by anybody except the  
     217     * component doing the indexing. 
    213218     * 
    214219     * This is optional. 
    …… 
    219224 
    220225    /** 
    221      * The full path to the topic that houses the document. For external resources, 
    222      * this should be either a MidCOM topic, to which this resource is associated or 
    223      * some "directory" after which you could filter. You may also leave 
    224      * it empty prohibiting it to appear on any topic-specific search. 
     226     * The full path to the topic that houses the document.  
     227     *  
     228     * For external resources, this should be either a MidCOM topic, to which this  
     229     * resource is associated or some "directory" after which you could filter.  
     230     * You may also leave it empty prohibiting it to appear on any topic-specific search. 
    225231     * 
    226232     * The value should be fully qualified, as returned by MIDCOM_NAV_FULLURL, including 
    …… 
    609615     * 
    610616     * Don't replace with an empty string but with a space, so that constructs like 
    611      * &lt;li&gt;torben&lt;/li&gt;&lt;li&gt;nehmer&lt;/li&gt; are recognized correctly. 
     617     * <li>torben</li><li>nehmer</li> are recognized correctly. 
    612618     * While this might result in double-spaces between words, this is better then 
    613619     * loosing the word boundaries entirely. 
    …… 
    684690     * base class. 
    685691     * 
    686      * @param midcom_helper_datamanager2_datamanager $datamanager A 
     692     * @param midcom_helper_datamanager2_datamanager &$datamanager A 
    687693     *     reference to the datamanager2 instance. 
    688694     * @param string $name The name of the field that should be queried 
    …… 
    698704     * Checks whether the given document is an instance of given document type. 
    699705     * 
    700      * This is equivalent to the is_a object hirarchy check, except that it 
     706     * This is equivalent to the is_a object hierarchy check, except that it 
    701707     * works with MidCOM documents. 
    702708     * 
    …… 
    704710     * @see _set_type() 
    705711     * @param string $document_type The base type to search for. 
    706      * @return boolean Indicationg relationship. 
     712     * @return boolean Indicating relationship. 
    707713     */ 
    708714    function is_a($document_type) 
    …… 
    822828     * Heuristics to determine how to convert given timestamp to local unixtime 
    823829     * 
    824      * @see $this->read_metadata_from_object 
     830     * @see read_metadata_from_object() 
    825831     * @param string $stamp ISO or unix datetime 
    826832     * @return unixtime 
    …… 
    840846     * Get person by given ID, caches results. 
    841847     * 
    842      * @see $this->read_metadata_from_object 
     848     * @see read_metadata_from_object() 
    843849     * @param string $id GUID or ID to get person for 
    844850     * @return midcom_db_person object 
    …… 
    866872     * Gets person name for given ID (in case it's imploded_wrapped of multiple GUIDs it will use the first) 
    867873     * 
    868      * @see $this->read_metadata_from_object 
     874     * @see read_metadata_from_object() 
    869875     * @param string $id GUID or ID to get person for 
    870876     * @return string $author->name 

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

    r13625 r14391  
    117117 
    118118    /** 
    119      * The constructor initializes the memebervariables and invokes 
     119     * The constructor initializes the member variables and invokes 
    120120     * _process_datamanager, which will read and process the information 
    121121     * out of that instance. 
    122122     * 
    123123     * The document is ready for indexing after construction. On any 
    124      * critical error, generate_error ist triggered. 
    125      * 
    126      * @param midcom_helper_datamanager2_datamanager $datamanager The fully initialized datamanager2 instance to use 
     124     * critical error, generate_error is triggered. 
     125     * 
     126     * @param midcom_helper_datamanager2_datamanager &$datamanager The fully initialized datamanager2 instance to use 
    127127     */ 
    128128    function midcom_services_indexer_document_datamanager2(&$datamanager) 

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

    r14087 r14391  
    629629     * @param string $cache_id key to use in cache, must be generated with generate_cache_id 
    630630     * @param string $data data to store in cache 
    631      * @see $this->generate_cache_id 
     631     * @see generate_cache_id() 
    632632     */ 
    633633    function store($cache_id, $data) 

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

    r14381 r14391  
    18151815     * This method populates the Array $data with the current field information. 
    18161816     * 
    1817      * @see $midcom_helper_datamanager::data 
     1817     * @see $data 
    18181818     * @access private 
    18191819     */ 

  • trunk/midcom/midcom.helper.dm2config/config.php

    r14385 r14391  
    2727 *    </code> 
    2828 * 4. Remember to include midcom.helper.dm2config as a requirement in 
    29  *    _config/manifest.inc_ and to set it in $this->_autoload_libraries in 
    30  *    _midcom/interfaces.php_ 
     29 *    <i>config/manifest.inc</i> and to set it in $this->_autoload_libraries in 
     30 *    <i>midcom/interfaces.php</i> 
    3131 * 
    3232 * @package midcom.helper.dm2config 
    …… 
    113113     * @param string $handler_id    Name of the handler 
    114114     * @param Array  $args          Variable arguments 
    115      * @param Array  $data          Miscellaneous output data 
     115     * @param Array  &$data          Miscellaneous output data 
    116116     * @return boolean              Indicating success 
    117117     */ 

  • trunk/midcom/net.nehmer.branchenbuch/handler/addentry.php

    r14385 r14391  
    275275     * Internal Helper encapsulating the index call. 
    276276     * 
    277      * @param midcom_helper_datamanager2_datamanager $datamanager The DM2 instance to index. 
     277     * @param midcom_helper_datamanager2_datamanager &$datamanager The DM2 instance to index. 
    278278     */ 
    279279    function _index(&$datamanager) 
    …… 
    290290 
    291291    /** 
    292      * This is a helper which adds the specfied catgory to the _category_list. It computes 
     292     * This is a helper which adds the specified category to the _category_list. It computes 
    293293     * all members that could be helpful for display. 
    294294     * 
    …… 
    296296     * @param string $parent_prefix The string to use as prefix in front of the name to generate 
    297297     *     the full category name. This is faster then using the get_full_name function of the 
    298      *     branchen class. If you need any separators like ': ', you nedd to add them yourself. 
     298     *     branchen class. If you need any separators like ': ', you need to add them yourself. 
    299299     */ 
    300300    function _add_category_to_list($category, $parent_prefix = '') 

  • trunk/midcom/net.nehmer.branchenbuch/handler/categories.php

    r14385 r14391  
    186186 
    187187    /** 
    188      * This is a helper which adds the specfied catgory to the _category_list. It computes 
     188     * This is a helper which adds the specified category to the _category_list. It computes 
    189189     * all members that could be helpful for display. 
    190190     * 
    …… 
    195195     * @param string $parent_prefix The string to use as prefix in front of the name to generate 
    196196     *     the full category name. This is faster then using the get_full_name function of the 
    197      *     branchen class. If you need any separators like ': ', you nedd to add them yourself. 
     197     *     branchen class. If you need any separators like ': ', you need to add them yourself. 
    198198     */ 
    199199    function _add_category_to_list($category, $listalpha, $parent_prefix = '') 

  • trunk/midcom/net.nehmer.branchenbuch/handler/entries.php

    r14385 r14391  
    130130     * Internal Helper encapsulating the index call. 
    131131     * 
    132      * @param midcom_helper_datamanager2_datamanager $datamanager The DM2 instance to index. 
     132     * @param midcom_helper_datamanager2_datamanager &$datamanager The DM2 instance to index. 
    133133     */ 
    134134    function _index(&$datamanager) 

  • trunk/midcom/net.nemein.tag/handler.php

    r14381 r14391  
    418418     * Reads machine tag string from content and returns it, the string is removed from content on the fly 
    419419     * 
    420      * @param string $content reference to content 
     420     * @param string &$content reference to content 
    421421     * @return string string of tags, empty for no tags 
    422422     */ 
    …… 
    442442     * Gets list of machine tags linked to the object with a context 
    443443     * 
    444      * @return array of maching tags and values, tag is key, value is value 
     444     * @return array of matching tags and values, tag is key, value is value 
    445445     */ 
    446446    function get_object_machine_tags_in_context(&$object, $context) 
    …… 
    622622     * 
    623623     * @see net_nemein_tag_handler::tag_object() 
    624      * @param string $from_string string to parse tags from 
    625      * @return array of correct format 
     624     * @param string $from_string String to parse tags from 
     625     * @return array Array of correct format 
    626626     */ 
    627627    function string2tag_array($from_string) 

  • trunk/midcom/net.nemein.teams/admin.php

    r11965 r14391  
    11<?php 
    22/** 
    3  * @package net.nemein.team 
     3 * @package net.nemein.teams 
    44 * @author The Midgard Project, http://www.midgard-project.org 
    55 * @copyright The Midgard Project, http://www.midgard-project.org 

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

    r13109 r14391  
    11<?php 
    22/** 
    3  * @package net.nemein.team  
     3 * @package net.nemein.teams 
    44 * @author The Midgard Project, http://www.midgard-project.org 
    55 * @copyright The Midgard Project, http://www.midgard-project.org 

  • trunk/midcom/net.nemein.teams/navigation.php

    r14086 r14391  
    99 
    1010/** 
    11  * net.nemein.team NAP interface class 
     11 * net.nemein.teams NAP interface class 
    1212 * 
    1313 * See the individual member documentations about special NAP options in use.