Changeset 14130

Show
Ignore:
Timestamp:
12/29/07 23:20:37 (8 months ago)
Author:
flack
Message:

various spelling and phpdoc fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/midcom/build/installMidcom.php

    r13424 r14130  
    169169    } 
    170170    /** 
    171      * returns a list of subdirectories and files as an assosiative  
     171     * returns a list of subdirectories and files as an associative  
    172172     * array 
    173173     * dirname => dirname  
  • trunk/midcom/build/installMidcomCore.php

    r13572 r14130  
    232232    } 
    233233    /** 
    234      * returns a list of subdirectories and files as an assosiative  
     234     * returns a list of subdirectories and files as an associative  
    235235     * array 
    236236     * dirname => dirname  
  • trunk/midcom/midcom.admin.settings/editor.php

    r14084 r14130  
    119119     * Loads and prepares the schema database. 
    120120     * 
    121      * Special treatement is done for the name field, which is set readonly for non-admins 
     121     * Special treatment is done for the name field, which is set readonly for non-admins 
    122122     * if the simple_name_handling config option is set. (using an auto-generated urlname based 
    123123     * on the title, if it is missing.) 
  • trunk/midcom/midcom.core/midcom/application.php

    r14084 r14130  
    22912291        } 
    22922292        // This is necessary, as the internal date representation is not HTTP 
    2293         // standard compilant. :-( 
     2293        // standard compliant. :-( 
    22942294        $lastmod = strtotime($snippet->revised); 
    22952295 
  • trunk/midcom/midcom.core/midcom/baseclasses/components/interface.php

    r14087 r14130  
    230230     * This is used during initialization when loading the default configurations 
    231231     * from the filesystem ($prefix/config/$name.inc) and the snippetdirs 
    232      * ($GLOBALS['midcom_config']['midcom_sgconfig_basedir']/$component/$name).  
     232     * ($GLOBALS['midcom_config']['midcom_sgconfig_basedir']/$component/$name). 
    233233     * They will be merged and placed into the 
    234234     * component data store under a key with the same name then the snippet as 
     
    671671     * Relays the get_node call to the NAP instance. 
    672672     * 
    673      * @return Array A NAP compilant NODE structure. 
     673     * @return Array A NAP compliant NODE structure. 
    674674     */ 
    675675    public function get_node() 
     
    682682     * Relays the get_leaves call to the NAP instance. 
    683683     * 
    684      * @return Array An Array of NAP compilant leaf structures. 
     684     * @return Array An Array of NAP compliant leaf structures. 
    685685     */ 
    686686    public function get_leaves() 
     
    790790     * indicating root page access. If the GUID is invalid, null will be returned. 
    791791     * 
    792      * This call is realyed to the component using the event handler _on_resolve_permalink(). 
     792     * This call is relayed to the component using the event handler _on_resolve_permalink(). 
    793793     * Before that it will deduce the active configuration for the given topic. 
    794794     * 
     
    960960 
    961961    /** 
    962      * Verif an indexer document's permissions. This is used for custom, advanced access control 
     962     * Verify an indexer document's permissions. This is used for custom, advanced access control 
    963963     * within a components domain. 
    964964     * 
     
    966966     * been prepared by the framework. 
    967967     * 
    968      * Usally, you want to limit the visibility of a 
     968     * Usually, you want to limit the visibility of a 
    969969     * document in the search result. You can do this by returning false in this function, the indexer 
    970970     * will then skip this object before returning the resultset to the callee. 
     
    10061006     * indicating root page access. If the GUID is invalid, null will be returned. 
    10071007     * 
    1008      * This call is realyed to the component using the event handler _on_resolve_permalink(). 
     1008     * This call is relayed to the component using the event handler _on_resolve_permalink(). 
    10091009     * Before that it will deduce the active configuration for the given topic. 
    10101010     * 
     
    10141014     * The hard way is setting the no_cache flag in cases where you need full flexibility, but 
    10151015     * this should be avoided for the sake of performance if somehow possible. The more 
    1016      * sophisticated alternative is therefore to selectivly invalidate all GUIDs that have 
     1016     * sophisticated alternative is therefore to selectively invalidate all GUIDs that have 
    10171017     * their Permalink lookup affected. 
    10181018     * 
  • trunk/midcom/midcom.core/midcom/baseclasses/components/navigation.php

    r13987 r14130  
    111111     * Leaf listing function, the default implementation returns an empty array indicating 
    112112     * no leaves. Note, that the active leaf index set by the other parts of the component 
    113      * must match one leav out of this list. 
     113     * must match one leaf out of this list. 
    114114     * 
    115115     * Here are some code fragments, that you usually connect through some kind of 
     
    165165     * </code> 
    166166     * 
    167      * @return Array NAP compilant list of leaves. 
     167     * @return Array NAP compliant list of leaves. 
    168168     */ 
    169169    public function get_leaves() 
     
    199199     * @param Array $toolbar Set this parameter in child classes calling this base method to add a toolbar to the default node listing. 
    200200     *   This parameter is not set by the framework and can safely be omitted in the average base class. 
    201      * @return Array NAP compilant node declaration 
     201     * @return Array NAP compliant node declaration 
    202202     */ 
    203203    public function get_node($toolbar = null) 
     
    207207            return null; 
    208208        } 
    209              
     209 
    210210        return array ( 
    211211            MIDCOM_NAV_URL => '', 
     
    226226     * everything in case you need to do some custom initializations as well. 
    227227     * 
    228      * @param MidgardTopic $topic The topic to pocess. 
     228     * @param MidgardTopic $topic The topic to process. 
    229229     * @param bool Indicating success. 
    230230     */ 
  • trunk/midcom/midcom.core/midcom/core/collector.php

    r13625 r14130  
    1818 * and midcom_helper__dbfactory::exec_collector(). 
    1919 * 
    20  * Normally you should never have to create an instance of this type direectly, 
     20 * Normally you should never have to create an instance of this type directly, 
    2121 * instead use the get_new_mc() method available in the MidCOM DBA API or the 
    2222 * midcom_helper__dbfactory::new_collector() method which is still available. 
     
    133133        else 
    134134        { 
    135             // Validate the class, we check for a single callback representativly only 
     135            // Validate the class, we check for a single callback representatively only 
    136136            if (! in_array('_on_prepare_new_collector', get_class_methods($classname))) 
    137137            { 
     
    161161        $this->_mc = new midgard_collector($baseclass, $domain, $value); 
    162162        $this->_real_class = $classname; 
    163          
     163 
    164164        // MidCOM's collector always uses the GUID as the key for ACL purposes 
    165165        $this->_mc->set_key_property('guid'); 
     
    175175 
    176176    /** 
    177      * The initialization routin executes the _on_prepare_new_collector callback on the class. 
     177     * The initialization routine executes the _on_prepare_new_collector callback on the class. 
    178178     * This cannot be done in the constructor due to the reference to $this that is used. 
    179179     */ 
     
    219219        return $this->_mc->execute(); 
    220220    } 
    221      
     221 
    222222    /** 
    223223     * Resets some internal variables for re-execute 
     
    294294                // TODO: Implement 
    295295            } 
    296              
     296 
    297297            // Register the GUID as loaded in this request 
    298298            $_MIDCOM->cache->content->register($object_guid); 
     
    312312        /** 
    313313         * PONDER: Should we implement the moving window limit/offset handling here as well ? 
    314          * probably it's not worth the effort since we're not actually instantiating objects  
     314         * probably it's not worth the effort since we're not actually instantiating objects 
    315315         * so many of the inefficencies related to that are avoided. 
    316316         * @see midcom_core_querybuilder::execute_windowed 
     
    371371        return $newresult; 
    372372    } 
    373      
     373 
    374374    function get_subkey($key, $property) 
    375375    { 
     
    381381        return $this->_mc->get_subkey($key, $property); 
    382382    } 
    383      
     383 
    384384    function get($key) 
    385385    { 
     
    391391        return $this->_mc->get($key); 
    392392    } 
    393      
     393 
    394394    function destroy() 
    395395    { 
     
    488488 
    489489    /** 
    490      * Creates a new logical group within the query. They are set in parantheses in the final 
     490     * Creates a new logical group within the query. They are set in parentheses in the final 
    491491     * SQL and will thus be evaluated with precedence over the normal out-of-group constraints. 
    492492     * 
    493493     * While the call lets you decide whether all constraints within the group are AND'ed or OR'ed, 
    494      * only OR constraints make logcially sense in this context, which is why this proxy function 
     494     * only OR constraints make logically sense in this context, which is why this proxy function 
    495495     * sets 'OR' as the default operator. 
    496496     * 
     
    543543 
    544544    /** 
    545      * Returns only objects that are availble in the specified language. This will 
     545     * Returns only objects that are available in the specified language. This will 
    546546     * disable the automatic fallback to the default language which would be in place 
    547547     * otherwise. 
     
    554554        $this->_mc->set_lang($language); 
    555555    } 
    556      
     556 
    557557    function set_key_property($property, $value = null) 
    558558    { 
     
    563563        return false; 
    564564    } 
    565      
     565 
    566566    function add_value_property($property) 
    567567    { 
  • trunk/midcom/midcom.core/midcom/core/privilege.php

    r14084 r14130  
    259259     * - A check against the list of registered privileges to ensure the existence of the 
    260260     *   privilege itselef. 
    261      * - A check for a valid and existing assignee, this includes a class existance check for classname restrictions 
     261     * - A check for a valid and existing assignee, this includes a class existence check for classname restrictions 
    262262     *   for SELF privileges. 
    263263     * - A check for an existing content object GUID (this implicitly cheks for midgard:read as well). 
  • trunk/midcom/midcom.core/midcom/core/querybuilder.php

    r14086 r14130  
    9494 * and midcom_helper__dbfactory::exec_query_builder(). 
    9595 * 
    96  * Normally you should never have to create an instance of this type direectly, 
     96 * Normally you should never have to create an instance of this type directly, 
    9797 * instead use the get_new_qb() method available in the MidCOM DBA API or the 
    9898 * midcom_helper__dbfactory::new_query_builder() method which is still available. 
     
    225225        else 
    226226        { 
    227             // Validate the class, we check for a single callback representativly only 
     227            // Validate the class, we check for a single callback representatively only 
    228228            if (! in_array('_on_prepare_new_query_builder', get_class_methods($classname))) 
    229229            { 
     
    261261 
    262262    /** 
    263      * The initialization routin executes the _on_prepare_new_querybuilder callback on the class. 
     263     * The initialization routine executes the _on_prepare_new_querybuilder callback on the class. 
    264264     * This cannot be done in the constructor due to the reference to $this that is used. 
    265265     */ 
     
    769769 
    770770    /** 
    771      * Creates a new logical group within the query. They are set in parantheses in the final 
     771     * Creates a new logical group within the query. They are set in parentheses in the final 
    772772     * SQL and will thus be evaluated with precedence over the normal out-of-group constraints. 
    773773     * 
    774774     * While the call lets you decide whether all constraints within the group are AND'ed or OR'ed, 
    775      * only OR constraints make logcially sense in this context, which is why this proxy function 
     775     * only OR constraints make logically sense in this context, which is why this proxy function 
    776776     * sets 'OR' as the default operator. 
    777777     * 
     
    824824 
    825825    /** 
    826      * Returns only objects that are availble in the specified language. This will 
     826     * Returns only objects that are available in the specified language. This will 
    827827     * disable the automatic fallback to the default language which would be in place 
    828828     * otherwise. 
  • trunk/midcom/midcom.core/midcom/exec/config-test.php

    r13424 r14130  
    387387if ($result != 0) 
    388388{ 
    389     println('External Utility: ImageMagick', ERROR, 'The existance ImageMagick toolkit could not be verified, it is required for all kinds of image processing in MidCOM.');  
     389    println('External Utility: ImageMagick', ERROR, 'The existence ImageMagick toolkit could not be verified, it is required for all kinds of image processing in MidCOM.');  
    390390} 
    391391else 
  • trunk/midcom/midcom.core/midcom/helper/_styleloader.php

    r14084 r14130  
    658658 
    659659    /** 
    660      * Gets the component styledir assosiated with the topics 
     660     * Gets the component styledir associated with the topics 
    661661     * component. 
    662662     * 
  • trunk/midcom/midcom.core/midcom/helper/nav.php

    r14087 r14130  
    307307     * will treat topic and article guids specially: In both cases the system will 
    308308     * translate it using the topic id into a node id and scan only that part of the 
    309      * tree non-recursivly. 
     309     * tree non-recursively. 
    310310     * 
    311311     * A full scan of the NAP data is only done if another MidgardObject is used. 
  • trunk/midcom/midcom.core/midcom/services/_sessioning.php

    r13625 r14130  
    130130     * 
    131131     * Returns null if the key 
    132      * is non-existent. Note, that this is not necessarily a valid non-existance 
     132     * is non-existent. Note, that this is not necessarily a valid non-existence 
    133133     * check, as the sessioning system does allow null values. Use the exists function 
    134134     * if unsure. 
     
    160160     * Removes the value associated with the specified key. Returns null if the key 
    161161     * is non-existent or the value of the key just removed otherwise. Note, that 
    162      * this is not necessarily a valid non-existance check, as the sessioning 
     162     * this is not necessarily a valid non-existence check, as the sessioning 
    163163     * system does allow null values. Use the exists function if unsure. 
    164164     * 
  • trunk/midcom/midcom.core/midcom/services/cache/backend.php

    r14087 r14130  
    271271     *  
    272272     * @param string $key The key to check for. 
    273      * @return bool Indicating existance. 
     273     * @return bool Indicating existence. 
    274274     */ 
    275275    function _exists($key) { die ("The method " . __CLASS__ . "::" . __FUNCTION__ . " must be implemented."); } 
     
    374374     *  
    375375     * @param string $key The key to check for. 
    376      * @return bool Indicating existance. 
     376     * @return bool Indicating existence. 
    377377     */ 
    378378    function exists($key) 
  • trunk/midcom/midcom.core/midcom/services/cache/backend/dba.php

    r13625 r14130  
    108108        $this->_filename = "{$this->_cache_dir}{$this->_name}.{$this->_handler}"; 
    109109         
    110         // Check for file existance by opening it once for write access. 
     110        // Check for file existence by opening it once for write access. 
    111111        if (! file_exists($this->_filename)) 
    112112        { 
  • trunk/midcom/midcom.core/midcom/services/cache/backend/flatfile.php

    r13625 r14130  
    4747        $this->_dirname = "{$this->_cache_dir}{$this->_name}/"; 
    4848         
    49         // Check for file existance. 
     49        // Check for file existence. 
    5050        if (! file_exists($this->_dirname)) 
    5151        { 
  • trunk/midcom/midcom.core/midcom/services/cache/module/memcache.php

    r13625 r14130  
    137137 
    138138    /** 
    139      * Checks for the existance of a key in the cache. 
     139     * Checks for the existence of a key in the cache. 
    140140     *  
    141141     * @param string $data_group The Data Group to look in. 
    142142     * @param string $key The key to look up. 
    143      * @return bool Indicating Existance 
     143     * @return bool Indicating existence 
    144144     */ 
    145145    function exists($data_group, $key) 
  • trunk/midcom/midcom.core/midcom/services/cache/module/phpscripts.php

    r13682 r14130  
    5151     
    5252    /** 
    53      * Initializes the cache module, verifying the existance of the script cache  
     53     * Initializes the cache module, verifying the existence of the script cache  
    5454     * directory. 
    5555     */ 
  • trunk/midcom/midcom.core/midcom/services/dbclassloader.php

    r14087 r14130  
    3737 * An example declaration looks like this: 
    3838 * 
    39  * <pre> 
     39 * <code> 
    4040 * Array 
    4141 * ( 
     
    4545 *     'midcom_class_name' => 'midcom_baseclasses_database_article' 
    4646 * ) 
    47  * </pre> 
     47 * </code> 
    4848 * 
    4949 * As for the parameters: 
     
    5555 * and dashes are allowed). 
    5656 * 
    57  * <i>old_class_name</i> is a compatibilty value as well, and should take the name of the 
     57 * <i>old_class_name</i> is a compatibility value as well, and should take the name of the 
    5858 * original Midgard class that was used to work, with this type. If there is no such type, 
    5959 * set it to null which is the default if and only if this key is omitted in the declaration. 
    60  * If specified the class is checked for existance when the file is being loaded. 
     60 * If specified the class is checked for existence when the file is being loaded. 
    6161 * 
    6262 * <i>new_class_name</i> is the MgdSchema class name from that you want to use. This argument 
     
    7575 * is recommended that you take advantage of this feature for performance reasons: 
    7676 * 
    77  * <pre> 
     77 * <code> 
    7878 * Array 
    7979 * ( 
     
    8484 *     //... 
    8585 * ), 
    86  * </pre> 
     86 * </code> 
    8787 * 
    8888 * Place a simple text file with exactly the declarations into the config directory of your 
     
    100100 * subclass constructor looks like this: 
    101101 * 
    102  * <pre> 
     102 * <code> 
    103103 * class midcom_baseclasses_database_article 
    104104 *     extends __midcom_baseclasses_database_article 
     
    111111 *     // ... 
    112112 * } 
    113  * </pre> 
     113 * </code> 
    114114 * 
    115115 * Be sure to take and pass the $id parameter to the parent class, it will automatically load 
     
    125125 * For example: 
    126126 * 
    127  * <pre> 
     127 * <code> 
    128128 * class midcom_baseclasses_database_article 
    129129 *     extends __midcom_baseclasses_database_article 
     
    152152 *     } 
    153153 * } 
    154  * </pre> 
     154 * </code> 
    155155 * 
    156156 * As you can see, this is not that hard. The only rule is that you always have to return either 
     
    202202 
    203203    /** 
    204      * Temporary variable during class cosntruction, stores the 
     204     * Temporary variable during class construction, stores the 
    205205     * class definition that is currently processed. 
    206206     * 
     
    441441     * member. 
    442442     * 
    443      * It will translate component and filename into a full path and delivere
     443     * It will translate component and filename into a full path and deliver
    444444     * the contents verbatim. 
    445445     * 
     
    467467     * @param string $component The name of the component that is assigned to handle the 
    468468     *     classes. 
    469      * @return string The code for these classes sourrounded by php opening and closing tags. 
     469     * @return string The code for these classes surrounded by php opening and closing tags. 
    470470     */ 
    471471    function _process_class_definition_list($definition_list, $definition_source, $component) 
     
    484484 
    485485    /** 
    486      * Generates a small block at the end of the script which registeres the original definitions 
     486     * Generates a small block at the end of the script which registers the original definitions 
    487487     * with ourselves, so that we don't have to eval this all the time. 
    488488     * 
     
    524524     * require this information to be able to load the required components on-demand. 
    525525     * 
    526      * @param Array $data The list of classes which have beeen loaded along with the metainformation. 
     526     * @param Array $data The list of classes which have been loaded along with the metainformation. 
    527527     */ 
    528528    function _register_loaded_classes($data) 
     
    745745            $target_property = $reflector->get_link_target($up_property); 
    746746            /** 
    747              * Taken out from the generated code as this will cause infite loop in ACL resolving, using direct QB in stead 
     747             * Taken out from the generated code as this will cause infinite loop in ACL resolving, using direct QB in stead 
    748748             * (when instantiating the parent ACLs will be checked in any case) 
    749749             * 
     
    776776            $target_class = $reflector->get_link_name($parent_property); 
    777777            /** 
    778              * Taken out from the generated code as this will cause infite loop in ACL resolving, using direct QB in stead 
     778             * Taken out from the generated code as this will cause infinite loop in ACL resolving, using direct QB in stead 
    779779             * (when instantiating the parent ACLs will be checked in any case) 
    780780             * 
     
    983983        } 
    984984 
    985         // Add the generateor metadata revision 
     985        // Add the generator metadata revision 
    986986        $revision = substr($this->_cvs_revision, 11, -2); 
    987987        $this->_class_string .= "    var \$__midcom_generator__ = 'midcom_services_dbclassloader';\n"; 
     
    11941194     * 
    11951195     * @param string $classname The name of the MidCOM DBA class that must be available. 
    1196      * @return bool Indicating success. False is retured only if you are requesting unknown 
     1196     * @return bool Indicating success. False is returned only if you are requesting unknown 
    11971197     *     classes and the like. Component loading failure will result in an HTTP 500, as 
    11981198     *     always. 
  • trunk/midcom/midcom.core/midcom/services/indexer/document.php

    r13945 r14130  
    603603 
    604604    /** 
    605      * This is a small helper that converts HTML to plain text (relativly simple): 
     605     * This is a small helper that converts HTML to plain text (relatively simple): 
    606606     * 
    607607     * Basically, JavaScript blocks and 
  • trunk/midcom/midcom.core/midcom/services/session.php

    r13625 r14130  
    9595     *  
    9696     * Returns null if the key 
    97      * is non-existent. Note, that this is not necessarily a valid non-existance  
     97     * is non-existent. Note, that this is not necessarily a valid non-existence  
    9898     * check, as the sessioning system does allow null values. Use the exists function 
    9999     * if unsure. 
     
    136136     * Removes the value associated with the specified key. Returns null if the key 
    137137     * is non-existent or the value of the key just removed otherwise. Note, that  
    138      * this is not necessarily a valid non-existance check, as the sessioning  
     138     * this is not necessarily a valid non-existence check, as the sessioning  
    139139     * system does allow null values. Use the exists function if unsure. 
    140140         *  
  • trunk/midcom/midcom.helper.datamanager/helpers_select_lists.php

    r14084 r14130  
    7979 
    8080/** 
    81  * Lists all groups recursivly, using four spaces to indent subgroups. 
     81 * Lists all groups recursively, using four spaces to indent subgroups. 
    8282 * 
    8383 * A no-selection element is added ontop of the list having an empty 
  • trunk/midcom/midcom.helper.datamanager2/baseclasses/filter.php

    r10966 r14130  
    7070    /** 
    7171     * Actual callback. Be aware, that QF might call this more then once for a single schema 
    72      * field, since it calls it recursivly and form-element-wise. 
     72     * field, since it calls it recursively and form-element-wise. 
    7373     * 
    7474     * @param mixed $input The form values which should be filtered. 
  • trunk/midcom/midcom.helper.datamanager2/type/images.php

    r14087 r14130  
    128128     * 
    129129     * The array is indexed by attachment identifier and contains Arrays containing image 
    130      * identifier and derived image name consecutivly (without any special indexes). 
     130     * identifier and derived image name consecutively (without any special indexes). 
    131131     * 
    132132     * Updates are done on load of the types' data and on every attachment add/delete 
  • trunk/midcom/midcom.helper.datamanager2/type/mnrelation.php

    r14082 r14130  
    4747 * '_' matches exactly one character. 
    4848 * 
    49  * When starting up, the type will only validate the existance of the mapping class. The 
     49 * When starting up, the type will only validate the existence of the mapping class. The 
    5050 * members specified will not be checked for performance reasons. In case something 
    5151 * wrong is specified there, it will surface during runtime, as invalid mapping entries 
  • trunk/midcom/midcom.helper.replicator/helpers.php

    r14105 r14130  
    11<?php 
    22/** 
    3 * @package midcom.helper.replicator 
    4 * @author The Midgard Project, http://www.midgard-project.org 
    5 * @version $Id: viewer.php 3975 2006-09-06 17:36:03Z bergie $ 
    6 * @copyright The Midgard Project, http://www.midgard-project.org 
    7 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
    8 */ 
     3 * @package midcom.helper.replicator 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @version $Id: viewer.php 3975 2006-09-06 17:36:03Z bergie $ 
     6 * @copyright The Midgard Project, http://www.midgard-project.org 
     7 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     8 */ 
    99 
    1010/** 
     
    1313 * Manifests as "Wrong parameter count for serialize()" when you call 
    1414 * it (otherwise properly) inside MidCOM application 
    15  *  
    16  * @package midcom.helper.replicator 
     15 * 
    1716 * @param midgard_object $object reference to an object 
    1817 * @return string object serialized (or false in case of failure) 
     
    2928 *  1. API has changed between 1.8.2 and 1.8.3 
    3029 *  2. see midcom_helper_replicator_serialize 
    31  *  
    32  * @package midcom.helper.replicator 
     30 * 
    3331 * @param midgard_attachment $object reference to attachment object 
    3432 * @return string blob serialized (or false in case of failure) 
     
    4947 * Workaround for Zend bug regarding object handling inside me