Changeset 14327

Show
Ignore:
Timestamp:
01/08/08 21:24:27 (8 months ago)
Author:
flack
Message:

some small PHPdoc fixes and a lot of spelling (mostly apostrophes)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/build/installMidcom.php

    r14130 r14327  
    88 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
    99 *  
    10  * Creates the midcom directory and it's subdirectories and  
     10 * Creates the midcom directory and its subdirectories and  
    1111 * makes symlinks to the files in question. 
    1212 *  

  • trunk/midcom/build/installMidcomCore.php

    r14130 r14327  
    88 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
    99 *  
    10  * Creates the midcom directory and it's subdirectories and  
     10 * Creates the midcom directory and its subdirectories and  
    1111 * makes symlinks to the files in question. 
    1212 *  

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

    r14083 r14327  
    4444 
    4545/**#@+  
    46  * URL's of Gmail. 
     46 * URLs of Gmail. 
    4747 * @var string  
    4848 */ 

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

    r14182 r14327  
    18011801        /** 
    18021802         * Used to prefix the stylenames to make sure they are unique 
    1803          * and do not clash with stylenames on the users' page. 
     1803         * and do not clash with stylenames on the user's page. 
    18041804         */ 
    18051805        var $stylePrefix; 

  • trunk/midcom/fi.hut.loginbroker/handler/index.php

    r14182 r14327  
    265265        if (!$this->_check_user($data)) 
    266266        { 
    267             // The method should generate it's own errors but here we trap anyway 
     267            // The method should generate its own errors but here we trap anyway 
    268268            return false; 
    269269        } 
    …… 
    271271        if (!$this->_login_user($data)) 
    272272        { 
    273             // The method should generate it's own errors but here we trap anyway 
     273            // The method should generate its own errors but here we trap anyway 
    274274            return false; 
    275275        } 

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

    r14179 r14327  
    119119 * 
    120120 * That way, object owners can read the object, even if the read access is 
    121  * prohibited for a users group for example. Without the explicit 
     121 * prohibited for a user's group for example. Without the explicit 
    122122 * user default specification it would get inherited from there. 
    123123 * 

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

    r14179 r14327  
    262262     *   for SELF privileges. 
    263263     * - A check for an existing content object GUID (this implicitly checks for midgard:read as well). 
    264      * - Enough privileges of the current user to update the objects privileges (the user 
     264     * - Enough privileges of the current user to update the object's privileges (the user 
    265265     *   must have midgard:update and midgard:privileges for this to succeed). 
    266266     * - A valid privilege value. 

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

    r5840 r14327  
    2222echo "<p>Current grace period is {$grace_days} days, use ?days=x to set to other value</p>\n"; 
    2323 
    24 // 1 second beofre midnight $grace_days ago 
     24// 1 second before midnight $grace_days ago 
    2525$cut_off = mktime(23, 59, 59, date('n'), date('j')-$grace_days, date('Y')); 
    2626foreach ($_MIDGARD['schema']['types'] as $mgdschema => $dummy) 

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

    r14002 r14327  
    201201     * This is an array containing a list of watches that need to be executed at the end 
    202202     * of any given request. The array is indexed by artificial keys constructed out of the 
    203      * watched objects class type and guid values. The array always contain the object 
     203     * watched object's class type and guid values. The array always contain the object 
    204204     * instance in the first element, and all components that need to be notified in the 
    205205     * subsequent keys. 

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

    r14276 r14327  
    390390    /** 
    391391     * Internal cache of the effective privileges of users on content objects, this is 
    392      * an associative array using a combination of the user identifier and the objects' 
     392     * an associative array using a combination of the user identifier and the object's 
    393393     * guid as index. The privileges for the anonymous user use the magic 
    394394     * EVERYONE as user identifier. 

  • trunk/midcom/midcom.core/midcom/services/auth/sessionmgr.php

    r14087 r14327  
    404404 
    405405    /** 
    406      * This function is called by the framework whenever a users' password is updated. It will 
     406     * This function is called by the framework whenever a user's password is updated. It will 
    407407     * synchronize all active login sessions of that user to the new password. 
    408408     * 
    409409     * Access to this function is restricted to midcom_core_user. 
    410410     * 
    411      * @param midcom_core_user $user A reference to the user object which has been udpated. 
     411     * @param midcom_core_user $user A reference to the user object which has been updated. 
    412412     * @param string $new The new password (plain text). 
    413413     */ 
    …… 
    432432 
    433433    /** 
    434      * This function is called by the framework whenever a users' username is updated. It will 
     434     * This function is called by the framework whenever a user's username is updated. It will 
    435435     * synchronize all active login sessions of that user to the new username. 
    436436     * 
    437437     * Access to this function is restricted to midcom_core_user. 
    438438     * 
    439      * @param midcom_core_user $user A reference to the user object which has been udpated. 
     439     * @param midcom_core_user $user A reference to the user object which has been updated. 
    440440     * @param string $new The new username. 
    441441     */ 
    …… 
    466466     * 'unknown' is returned in cases where you have insufficient permissions. 
    467467     * 
    468      * @param midcom_core_user $user A reference to the user object which has been udpated. 
     468     * @param midcom_core_user $user A reference to the user object which has been updated. 
    469469     * @return string One of 'online', 'offline' or 'unknown', indicating the current online 
    470470     *     state. 

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

    r14179 r14327  
    563563 
    564564    /** 
    565      * This method tries to pull the users preferred language and 
     565     * This method tries to pull the user's preferred language and 
    566566     * character set out of a cookie named "midcom_services_i18n". 
    567567     */ 

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

    r14139 r14327  
    1212 * This is a class geared at indexing attachments. It requires you to "assign" the  
    1313 * attachment to a topic, which is used as TOPIC_URL for permission purposes. In addition 
    14  * you may set another MidgardObject as source object, it's GUID is stored in the  
     14 * you may set another MidgardObject as source object, its GUID is stored in the  
    1515 * __SOURCE field of the index. 
    1616 *  
    …… 
    2626 *  
    2727 * Where $attachment is the attachment to be indexed and $object is the object the object 
    28  * is associated with. The corresponding topic will be detected using the objects' GUID 
     28 * is associated with. The corresponding topic will be detected using the object's GUID 
    2929 * through NAP. If this fails, you have to set the members $topic_guid, $topic_url and  
    3030 * $component manually.  

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

    r13725 r14327  
    3232    /** 
    3333     * Class of the current page per each context.  
    34      * Typically these are thesame as the schema name of the current object's Datamanager schema.  
     34     * Typically these are the same as the schema name of the current object's Datamanager schema.  
    3535     * This can be used for changing site styling based on body class="" etc. 
    3636     * 

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

    r14140 r14327  
    382382     */ 
    383383    /** 
    384      * Get a list of the objects history 
     384     * Get a list of the object's history 
    385385     * @param string objectid (usually the guid) 
    386386     * @return array list of revisions and revision comment. 

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

    r14084 r14327  
    5252 * Note, that since the introduction of the create method, all datatypes must be 
    5353 * able to be initialized without a storage object, leading in an empty value 
    54  * and (in turn) an empty form element. The viewport must not neccesserily be 
     54 * and (in turn) an empty form element. The viewport must not necessarily be 
    5555 * operational, but the form interface must. 
    5656 * 
    …… 
    5959 * The basic datatype requires at least two configuration options: 
    6060 * 
    61  * <i>location</i> referrs to the storage location of the data. This can be either 
     61 * <i>location</i> refers to the storage location of the data. This can be either 
    6262 * a valid member field of the storage object (e.g. "abstract"), "parameter" or 
    6363 * "attachment". The latter two will define the name of the parameter or attachment 
    …… 
    7272 * 
    7373 * Datatypes authors are strongly encouraged to define defaults for both of these 
    74  * configuration parameters, so that trival configurations can be made easily. The 
     74 * configuration parameters, so that trivial configurations can be made easily. The 
    7575 * default storage location should be either a parameter or an attachment, as this 
    7676 * is the only way to ensure multiple definitions of the same type will work out 
    …… 
    530530        //$this->_datamanager->append_error("Validating $field_description<br>\n"); 
    531531        foreach ($validation_rules as $rule => $params ) { 
    532             /* is this a selfmade rule? If so, you're responsible for making the class available youreself! */ 
     532            /* is this a selfmade rule? If so, you're responsible for making the class available yourself! */ 
    533533            $object = null; 
    534534            $function = null; 

  • trunk/midcom/midcom.helper.datamanager2/callback/select/grouplister.php

    r14139 r14327  
    2424 *   in the midcom_db_group type, defaults to name. 
    2525 * 
    26  * <b>Example usage to manage a users groups:</b> 
     26 * <b>Example usage to manage a user's groups:</b> 
    2727 * 
    2828 * Use the following DM2 configuration within the person schema: 

  • trunk/midcom/midcom.helper.datamanager2/callback/select/personlister.php

    r14139 r14327  
    2424 *   in the midcom_db_person type, defaults to name. 
    2525 * 
    26  * <b>Example usage to manage a users persons:</b> 
     26 * <b>Example usage to manage a user's persons:</b> 
    2727 * 
    2828 * Use the following DM2 configuration within the person schema: 

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

    r14139 r14327  
    188188 
    189189    /** 
    190      * Transforms the current objects' state into a CSV string representation. Escaping 
     190     * Transforms the current object's state into a CSV string representation. Escaping 
    191191     * and other encoding is done by the caller, you just return the string. 
    192192     * 
    …… 
    201201 
    202202    /** 
    203      * Transforms the current objects' state into HTML representation. This is used for displaying 
     203     * Transforms the current object's state into HTML representation. This is used for displaying 
    204204     * type contents in an automatic fashion. 
    205205     * 

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

    r13625 r14327  
    1616 * operations cannot be undone. 
    1717 * 
    18  * The type can manage an arbitrary number of objects. Each objects is identified 
     18 * The type can manage an arbitrary number of objects. Each object is identified 
    1919 * by a GUID. It provides management functions for existing child objects which allow you to  
    2020 * add, delete and update them in all variants. These functions are executed immediately on the  

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

    r14139 r14327  
    3030    /** 
    3131     * The privilege record encapsulated by this type (note that this does not  
    32      * neccecarily is an already persisted privilege). 
     32     * necessarily is an already persisted privilege). 
    3333     *  
    3434     * This member may be null in case that we do not yet have a storage object. 
    …… 
    123123 
    124124    /** 
    125      * Loades the privilege from the DB if and only if a storage object is already present 
     125     * Loads the privilege from the DB if and only if a storage object is already present 
    126126     * and we have sufficient privileges. 
    127127     */ 

  • trunk/midcom/midcom.helper.datamanager2/widget/captcha.php

    r14140 r14327  
    2727 * is stored. This session key is made persistent using a hidden request variable. Every 
    2828 * passphrase is only valid for a single submission call. Every successful submit will 
    29  * invalidate the passphrase in the users' session thus triggering a new captcha being 
     29 * invalidate the passphrase in the user's session thus triggering a new captcha being 
    3030 * generated. 
    3131 * 
    …… 
    3838 * Due to the nature of the way how the captcha passphrase is passed to the captcha 
    3939 * image server, it is currently not possible to have more then one captcha per 
    40  * unique REQUEST_URI whithin the users PHP Session space. 
     40 * unique REQUEST_URI within the user's PHP Session space. 
    4141 * 
    4242 * <b>Integration Guide:</b> 

  • trunk/midcom/midcom.helper.datamanager2/widget/downloads.php

    r14139 r14327  
    1717 * 
    1818 * All processing is done during the on_submit handlers, enforcing immediate update of the 
    19  * associated storage objects. No other solition is possible, since we need to transfer 
     19 * associated storage objects. No other solution is possible, since we need to transfer 
    2020 * uploaded files somehow through multiple requests. 
    2121 * 
    …… 
    2323 * directly and thus has no post-processing capabilities whatsoever. 
    2424 * 
    25  * The type will show a tabluar view of all uploaded attachments. Existing attachments have 
     25 * The type will show a tabular view of all uploaded attachments. Existing attachments have 
    2626 * an editable tile and can be deleted or replaced. A single new upload line is displayed 
    2727 * always. There is no preview, but there is a download link. 

  • trunk/midcom/midcom.helper.datamanager2/widget/image.php

    r14140 r14327  
    1717 * 
    1818 * All processing is done during the on_submit handlers, enforcing immediate update of the 
    19  * associated storage objects. No other solition is possible, since we need to transfer 
     19 * associated storage objects. No other solution is possible, since we need to transfer 
    2020 * uploaded files somehow through multiple requests. 
    2121 * 

  • trunk/midcom/midcom.helper.datamanager2/widget/images.php

    r13997 r14327  
    1717 * 
    1818 * All processing is done during the on_submit handlers, enforcing immediate update of the 
    19  * associated storage objects. No other solition is possible, since we need to transfer 
     19 * associated storage objects. No other solution is possible, since we need to transfer 
    2020 * uploaded files somehow through multiple requests. 
    2121 * 
    22  * The type will show a tabluar view of all uploaded images. Existing images have 
     22 * The type will show a tabular view of all uploaded images. Existing images have 
    2323 * an editable tile and can be deleted or replaced. A single new upload line is displayed 
    2424 * always. There is no preview, but there is a download link. 
    …… 
    3232 * <b>Implementation notes:</b> 
    3333 * 
    34  * The construnciton of the widget is relatively complex, it relies on a combination of 
     34 * The construction of the widget is relatively complex, it relies on a combination of 
    3535 * static and input elements to do its work. It should be fairly customizable using CSS. 
    3636 * 

  • trunk/midcom/midcom.helper.datamanager2/widget/tags.php

    r14139 r14327  
    100100 
    101101    /** 
    102      * Objects id/guid which is to be tagged 
     102     * Object's id/guid which is to be tagged 
    103103     * 
    104104     * @var string 

  • trunk/midcom/midcom.helper.datamanager2/widget/video.php

    r14140 r14327  
    1717 * 
    1818 * All processing is done during the on_submit handlers, enforcing immediate update of the 
    19  * associated storage objects. No other solition is possible, since we need to transfer 
     19 * associated storage objects. No other solution is possible, since we need to transfer 
    2020 * uploaded files somehow through multiple requests. 
    2121 * 

  • trunk/midcom/midcom.helper.imagepopup/viewer.php

    r13617 r14327  
    99 
    1010/** 
    11  * This is the class that defines which url's should be handled by this module.  
     11 * This is the class that defines which URLs should be handled by this module.  
    1212 *  
    1313 * @package midcom.helper.imagepopup 

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

    r14322 r14327  
    384384        if (!$skip_children) 
    385385        { 
    386             // Then objects parameters 
     386            // Then object's parameters 
    387387            $object_parameters = $this->serialize_parameters($object); 
    388388            if ($object_parameters === false) 
    …… 
    396396            unset($object_parameters); 
    397397     
    398             // And lastly objects attachments 
     398            // And lastly object's attachments 
    399399            $object_attachments = $this->serialize_attachments($object); 
    400400            if ($object_attachments === false) 
    …… 
    408408            unset($object_attachments); 
    409409        } 
    410         // Always serialize objects privileges 
     410        // Always serialize object's privileges 
    411411        $object_privileges = $this->serialize_privileges($object); 
    412412        if ($object_privileges === false) 

  • trunk/midcom/midcom.helper.xml/objectmapper.php

    r14139 r14327  
    8080        } 
    8181 
    82         // set the objects values to the ones from xml. 
     82        // set the object's values to the ones from xml. 
    8383        foreach (get_object_vars($object) as $field_name => $val) 
    8484        { 
    …… 
    220220        { 
    221221            debug_push(__CLASS__, __FUNCTION__); 
    222             debug_add("This function must get an arrat as it's parameter not: " . gettype($array)); 
    223             $this->errstr = "This function must get an array as it's parameter not: " . gettype($array); 
     222            debug_add("This function must get an array as its parameter not: " . gettype($array)); 
     223            $this->errstr = "This function must get an array as its parameter not: " . gettype($array); 
    224224            debug_pop(); 
    225225            return false; 
    …… 
    273273        { 
    274274            debug_push(__CLASS__, __FUNCTION__); 
    275             debug_add("This function must get an object as it's parameter not: " . gettype($object)); 
    276             $this->errstr = "This function must get an object as it's parameter not: " . gettype($object); 
     275            debug_add("This function must get an object as its parameter not: " . gettype($object)); 
     276            $this->errstr = "This function must get an object as its parameter not: " . gettype($object); 
    277277            debug_pop(); 
    278278            return false; 

  • trunk/midcom/midcom.helper.xml/tests/test_objectmapper.php

    r2791 r14327  
    7676        $this->assertTrue(array_key_exists($class, $array), "The array should have the objectclass as it's first key"); 
    7777         
    78         $this->assertTrue(array_key_exists($class, $_MIDGARD['schema']['types']), "The array should have the objectclass as it's first key: $class"); 
     78        $this->assertTrue(array_key_exists($class, $_MIDGARD['schema']['types']), "The array should have the objectclass as its first key: $class"); 
    7979         
    8080 

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

    r14084 r14327  
    309309            /** 
    310310             * The object might have valid reasons for returning empty value here, but we can't know if it's 
    311              * beacause it's valid or because the get_parent* methods have not been overridden in the actually 
     311             * because it's valid or because the get_parent* methods have not been overridden in the actually 
    312312             * used class 
    313313             */ 

  • trunk/midcom/midgard.admin.sitewizard/viewer.php

    r5061 r14327  
    11<?php 
    2  
    32/** 
    43 * @package midgard.admin.sitewizard 

  • trunk/midcom/midgard.admin.wizards/viewer.php

    r14179 r14327  
    229229 
    230230    /** 
    231      * Populates the node toolbar depending on the users rights. 
     231     * Populates the node toolbar depending on the user's rights. 
    232232     * 
    233233     * @access protected 

  • trunk/midcom/midgard.webdav.styles/viewer.php

    r14139 r14327  
    132132 
    133133    /** 
    134      * Populates the node toolbar depending on the users rights. 
     134     * Populates the node toolbar depending on the user's rights. 
    135135     * 
    136136     * @access protected 

  • trunk/midcom/net.fernmark.pedigree/viewer.php

    r5985 r14327  
    117117 
    118118    /** 
    119      * Populates the node toolbar depending on the users rights. 
     119     * Populates the node toolbar depending on the user's rights. 
    120120     * 
    121121     * @access protected 

  • trunk/midcom/net.nehmer.account/midcom/interfaces.php

    r13219 r14327  
    2424 * 
    2525 * <b>register_allow_type:</b> Use this to explicitly limit the account types that can 
    26  * be regeisterd to. This must be a subset of the type listing found in the account schema. 
     26 * be registered to. This must be a subset of the type listing found in the account schema. 
    2727 * 
    2828 * <b>fallback_type:</b> Set this to avoid having to place each user into the same group. 
    29  * If a users' group cannot be determined and this option is set, it is used as a fallback 
     29 * If a user's group cannot be determined and this option is set, it is used as a fallback 
    3030 * type. 
    3131 * 

  • trunk/midcom/net.nehmer.account/viewer.php

    r14179 r14327  
    484484 
    485485    /** 
    486      * Populates the toolbars depending on the users rights. 
     486     * Populates the toolbars depending on the user's rights. 
    487487     * 
    488488     * @access protected 

  • trunk/midcom/net.nehmer.blog/viewer.php

    r14250 r14327  
    1717 * @package net.nehmer.blog 
    1818 */ 
    19  
    2019class net_nehmer_blog_viewer extends midcom_baseclasses_components_request 
    2120{ 
    …… 
    251250 
    252251    /** 
    253      * Populates the node toolbar depending on the users rights. 
     252     * Populates the node toolbar depending on the user's rights. 
    254253     * 
    255254     * @access protected 

  • trunk/midcom/net.nehmer.branchenbuch/viewer.php

    r3333 r14327  
    1616 * @package net.nehmer.branchenbuch 
    1717 */ 
    18  
    1918class net_nehmer_branchenbuch_viewer extends midcom_baseclasses_components_request 
    2019{ 

  • trunk/midcom/net.nehmer.buddylist/viewer.php

    r12474 r14327  
    1616 * @package net.nehmer.buddylist 
    1717 */ 
    18  
    1918class net_nehmer_buddylist_viewer extends midcom_baseclasses_components_request 
    2019{ 

  • trunk/midcom/net.nehmer.comments/viewer.php

    r13164 r14327  
    1515 * @package net.nehmer.comments 
    1616 */ 
    17  
    1817class net_nehmer_comments_viewer extends midcom_baseclasses_components_request 
    1918{ 
    …… 
    5857     
    5958    /** 
    60      * Populates the node toolbar depending on the users rights. 
     59     * Populates the node toolbar depending on the user's rights. 
    6160     * 
    6261