Changeset 15253

Show
Ignore:
Timestamp:
02/26/08 13:00:43 (6 months ago)
Author:
flack
Message:

some spelling/phpdoc cleanups

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r15104 r15253  
    2626{ 
    2727    /** 
    28      * The schema (not the schema <i>database!</i>) to use for operation. This variable will always contain a parsed 
    29      * representation of the schema, so that one can swiftly switch between individual schemas 
    30      * of the Database. 
     28     * The schema (not the schema <i>database!</i>) to use for operation. 
     29     * 
     30     * This variable will always contain a parsed representation of the schema, 
     31     * so that one can swiftly switch between individual schemas of the Database. 
    3132     * 
    3233     * This member is initialized by-reference. 
    …… 
    6768     * This is the renderer that quickform will use. 
    6869     * 
    69      * <i>It is set using the set_renderer() or create_renderer calls.</i> 
     70     * <i>It is set using the set_renderer() or create_renderer() calls.</i> 
    7071     * 
    7172     * If the configuration option 'default_renderer' (and possibly 'default_renderer_src') 
    …… 
    427428        } 
    428429 
    429         // Translate the requred note 
     430        // Translate the required note 
    430431        $this->form->setRequiredNote 
    431432        ( 
    …… 
    666667 
    667668    /** 
    668      * This helper function adds all rules and filters which are deducable from the schema 
     669     * This helper function adds all rules and filters which are deducible from the schema 
    669670     * to the form. It recognizes the following schema options: 
    670671     * 
    …… 
    767768    /** 
    768769     * Set the value of a formelement. 
     770     * 
    769771     * @param string $key the form field name 
    770772     * @param string $value the new value to set 
    …… 
    779781 
    780782    /** 
    781      * Creates an instance of the renderer set in the system configuration. This is called 
    782      * during the initialize code and will make the renderer available immediately after startup. 
     783     * Creates an instance of the renderer set in the system configuration. 
     784     * 
     785     * This is called during the initialize code and will make the renderer 
     786     * available immediately after startup. 
    783787     */ 
    784788    function _create_default_renderer() 
    …… 
    867871            || $exitcode == 'next') 
    868872        { 
    869             // Validate the from. 
     873            // Validate the form. 
    870874            if (! $this->form->validate()) 
    871875            { 
    …… 
    882886     * Use this function to get the values of submitted form without going through 
    883887     * a storage backend. 
     888     * 
    884889     * @return array the submitted values. 
    885      * 
    886890     */ 
    887891    function get_submit_values(  ) 
    …… 
    892896    /** 
    893897     * Call this before any output is made. It will process the form results, if applicable, 
    894      * and return an according exit code. This indicates which (if any) submit button was pressed. 
    895      * If 'editing' is returned, this means that either there was not data submitted yet, or that 
     898     * and return an according exit code. 
     899     * 
     900     * This indicates which (if any) submit button was pressed. If 'editing' is 
     901     * returned, this means that either there was not data submitted yet, or that 
    896902     * form validation has failed. 
    897903     * 

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

    r14806 r15253  
    3434 
    3535    /** 
    36      * This field contains the reason for the failed validation. The string can be safely 
    37      * assumed to be localized, and is only valid if a validation has failed previously. 
    38      * This field will be cleared prior to a new validation attempt. You may use simple 
    39      * inline HTML in these errors. 
     36     * This field contains the reason for the failed validation. 
     37     * 
     38     * The string can be safely assumed to be localized, and is only valid if a 
     39     * validation has failed previously. This field will be cleared prior to a 
     40     * new validation attempt. You may use simple inline HTML in these errors. 
    4041     * 
    4142     * @var string 
    …… 
    4647     * This variable contains configuration data which is not directly related to the 
    4748     * operation of the type, but required for the operation of external tools like the 
    48      * storage manager. The type should never touch this variable, which is controlled 
     49     * storage manager. 
     50     * 
     51     * The type should never touch this variable, which is controlled 
    4952     * by a corresponding getter/setter pair. 
    5053     * 
    …… 
    5760 
    5861    /** 
    59      * The name field holds the name of the field the datatype is encapsulating. This 
    60      * maps to the schema's field name. You should never have to change them. 
     62     * The name field holds the name of the field the datatype is encapsulating. 
     63     * 
     64     * This maps to the schema's field name. You should never have to change them. 
    6165     * 
    6266     * @var string 
    …… 
    6569 
    6670    /** 
    67      * A reference to the storage object that this type is using. Use this for attachment 
    68      * management. The variable may be null until actual processing starts. It may also 
    69      * change during the lifetime of a type. You should therefore be careful. 
     71     * A reference to the storage object that this type is using. 
     72     * 
     73     * Use this for attachment management. The variable may be null until 
     74     * actual processing starts. It may also change during the lifetime 
     75     * of a type. You should therefore be careful. 
    7076     * 
    7177     * @var midcom_helper_datamanager2_storage 
    …… 
    9096     * @param string $name The name of the field to which this type is bound. 
    9197     * @param Array $config The configuration data which should be used to customize the type. 
    92      * @param midcom_helper_datamanager2_storage $storage A reference to the storage object to use. 
     98     * @param midcom_helper_datamanager2_storage &$storage A reference to the storage object to use. 
    9399     * @return boolean Indicating success. If this is false, the type will be unusable. 
    94100     */ 
    …… 
    128134     * object is used by-reference. 
    129135     * 
    130      * @var midcom_helper_datamanager2_storage $storage A reference to the storage object to use. 
     136     * @var midcom_helper_datamanager2_storage &$storage A reference to the storage object to use. 
    131137     */ 
    132138    function set_storage(&$storage) 
    …… 
    149155    /** 
    150156     * Converts from storage format to "operational" format, which might include 
    151      * more information then the pure storage format. Depending on the $serialized_storage member, 
    152      * the framework will automatically deal with deserializaiton of the information. 
     157     * more information then the pure storage format. 
     158     * 
     159     * Depending on the $serialized_storage member, the framework will 
     160     * automatically deal with deserialization of the information. 
    153161     * 
    154162     * This function must be overwritten. 
    …… 
    162170 
    163171    /** 
    164      * Converts from "operational" format to from storage format. Depending on the $serialized_storage member, 
    165      * the framework will automatically deal with deserializaiton of the information. 
     172     * Converts from "operational" format to from storage format. 
     173     * 
     174     * Depending on the $serialized_storage member, the framework will 
     175     * automatically deal with deserialization of the information. 
    166176     * 
    167177     * This function must be overwritten. 
    …… 
    188198 
    189199    /** 
    190      * Transforms the current object's state into a CSV string representation. Escaping 
    191      * and other encoding is done by the caller, you just return the string. 
     200     * Transforms the current object's state into a CSV string representation. 
     201     * 
     202     * Escaping and other encoding is done by the caller, you just return the string. 
    192203     * 
    193204     * This function must be overwritten. 
    …… 
    201212 
    202213    /** 
    203      * Transforms the current object's state into HTML representation. This is used for displaying 
    204      * type contents in an automatic fashion. 
     214     * Transforms the current object's state into HTML representation. 
     215     * 
     216     * This is used for displaying type contents in an automatic fashion. 
    205217     * 
    206218     * This function must be overwritten. 
    …… 
    214226 
    215227    /** 
    216      * Transforms the current objects' state into 'raw' representation. Usually  
    217      * the convert_to_storage -method returns suitable value, but in some datatypes 
    218      * (like privilege, blobs-based ones and tags), convert_to_storage does database 
    219      * IO directly and returns less usefull data. 
     228     * Transforms the current objects' state into 'raw' representation. 
     229     * Usually the convert_to_storage -method returns suitable value, but in 
     230     * some datatypes (like privilege, blobs-based ones and tags), 
     231     * convert_to_storage does database IO directly and returns less useful data. 
    220232     * 
    221233     * @see convert_to_storage 
    …… 
    255267 
    256268    /** 
    257      * Gets an external configuration option referenced by its key. Besides other parts 
    258      * in the datamanager framework, nobody should ever have to touch this information. 
     269     * Gets an external configuration option referenced by its key. 
     270     * 
     271     * Besides other parts in the datamanager framework, nobody should ever 
     272     * have to touch this information. 
    259273     * 
    260274     * @param string $key The key by which this configuration option is referenced. 
    …… 
    271285 
    272286    /** 
    273      * Sets an external configuration option. Besides other parts 
    274      * in the datamanager framework, nobody should ever have to touch this information. 
     287     * Sets an external configuration option. 
     288     * 
     289     * Besides other parts in the datamanager framework, nobody should ever 
     290     * have to touch this information. 
    275291     * 
    276292     * @param string $key The key by which this configuration option is referenced. 
    …… 
    284300    /** 
    285301     * Checks whether the current user has the given privilege on the storage backend. 
    286      * The storage backend is resposible for the actual execution of this operation, 
     302     * 
     303     * The storage backend is responsible for the actual execution of this operation, 
    287304     * so this is merely a shortcut. 
    288305     * 

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

    r14329 r15253  
    8686            return false; 
    8787        } 
    88          
     88 
    8989        if ($this->_initialize_dependencies) 
    9090        { 
    9191            $this->_add_external_html_elements(); 
    9292        } 
    93          
     93 
    9494        return true; 
    9595    } 
    …… 
    282282        echo $this->_type->value->format($format); 
    283283    } 
     284 
    284285} 
    285286 

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

    r14329 r15253  
    1111 * Datamanager 2 simple checkbox / radiobox select widget. 
    1212 * 
    13  * It can only be bound to a select type (or subclass thereof), and inherits the confguration 
     13 * It can only be bound to a select type (or subclass thereof), and inherits the configuration 
    1414 * from there as far as possible. 
    1515 * 

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

    r14338 r15253  
    1111 * Datamanager 2 simple select widget. 
    1212 * 
    13  * It can only be bound to a select type (or subclass thereof), and inherits the confguration 
     13 * It can only be bound to a select type (or subclass thereof), and inherits the configuration 
    1414 * from there as far as possible. 
    1515 * 
    …… 
    6262     * @var array 
    6363     */ 
    64  
    6564    var $jsevents = null; 
    6665 

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

    r14329 r15253  
    1111 * Datamanager 2 sorting widget. 
    1212 * 
    13  * It can only be bound to a select type (or subclass thereof), and inherits the confguration 
     13 * It can only be bound to a select type (or subclass thereof), and inherits the configuration 
    1414 * from there as far as possible. 
    1515 *