Changeset 14380

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

PHPdoc and spelling again

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/midcom/fi.hut.loginbroker/callbacks/prototypes.php

    r14217 r14380  
    164164     * and password to $request_data['password'] 
    165165     * 
    166      * @param $username username to use 
    167      * @param $request_data request data, see key 'property_map' for more interesting info 
    168      * @param $iteration this is 1 if this is the first callback to be called, callbacks must check this and not create new person if this is > 1 
     166     * @param string $username username to use 
     167     * @param array &$request_data request data, see key 'property_map' for more interesting info 
     168     * @param int $iteration this is 1 if this is the first callback to be called, callbacks must check this and not create new person if this is > 1 
    169169     * @return boolean indicating success (do note that processing of callbacks etc is aborted if someone returns failure) 
    170170     */ 
    …… 
    195195     * 
    196196     * @see fi_hut_loginbroker_callbacks_prototype_create::create() 
    197      * @param $username username to use 
    198      * @param $request_data request data, see key 'property_map' for more interesting info 
    199      * @param $iteration this is 1 if this is the first callback to be called, callbacks must check this and not create new person if this is > 1 
     197     * @param string $username username to use 
     198     * @param array &$request_data request data, see key 'property_map' for more interesting info 
     199     * @param int $iteration this is 1 if this is the first callback to be called, callbacks must check this and not create new person if this is > 1 
    200200     */ 
    201201    function update($username, &$request_data, $iteration) 

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

    r14331 r14380  
    767767     * 
    768768     * @access public 
    769      * @param $id string   Root ul id. 
     769     * @param string $id root ul id 
    770770     */ 
    771771    function set_root_element_id($id) 

  • trunk/midcom/midcom.admin.styleeditor/handler/file.php

    r12791 r14380  
    112112     * Rewrite a filename to URL safe form 
    113113     * 
    114      * @param $filename string file name to rewrite 
     114     * @param string $filename file name to rewrite 
    115115     * @return string rewritten filename 
    116116     */ 

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

    r14335 r14380  
    487487    /** 
    488488     * This public helper post-processes the initial information as set by the constructor. 
    489      * It fills all missing fields with sensible defaults, see the class introdction for 
    490      * deatils. 
     489     * It fills all missing fields with sensible defaults, see the class introduction for 
     490     * details. 
    491491     */ 
    492492    public function _prepare_request_switch() 
    …… 
    529529 
    530530    /** 
    531      * CAN_HANDLE Phase interface, checks against all registered handlers if a vaild 
     531     * CAN_HANDLE Phase interface, checks against all registered handlers if a valid 
    532532     * one can be found. You should not need to override this, instead, use the 
    533533     * HANDLE Phase for further checks. 

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

    r14340 r14380  
    762762     *   the manifest will be ignored and an error is logged. 
    763763     * 
    764      *  @param $manifest object the manifest object to load. 
     764     *  @param object $manifest the manifest object to load. 
    765765     */ 
    766766    function load_manifest($manifest) 

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

    r14329 r14380  
    352352     * Where $gamma is a positive floating point number, e.g. 1.2 
    353353     * 
    354      * @param $gamma Gamma adjustment value. 
     354     * @param float $gamma Gamma adjustment value. 
    355355     * @return boolean true on success. 
    356356     */ 
    …… 
    378378 
    379379    /** 
    380      * This function converts the image to the specified image format. It must be a suiteable 
     380     * This function converts the image to the specified image format. It must be a suitable 
    381381     * extension to use with the Imagemagick convert utility. The file will not be renamed, 
    382382     * you have to do this yourself. 
    …… 
    575575     * and less then 360; if omitted, a NULL operation is done. 
    576576     * 
    577      * @param $rotate Degrees of rotation clockwise, negative amounts possible 
     577     * @param float $rotate Degrees of rotation clockwise, negative amounts possible 
    578578     * @return boolean true on success. 
    579579     */ 

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

    r14338 r14380  
    232232    /** 
    233233     * Deletes one element 
    234      * @param $id the element id 
     234     * @param string $id the element id 
    235235     */ 
    236236    public function delete($id) 

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

    r14329 r14380  
    1414 * 
    1515 * A document consists of a number of fields, each field has different properties 
    16  * when handled by the indexer (exact behavoir depends, as always, on the indexer 
     16 * when handled by the indexer (exact behavior depends, as always, on the indexer 
    1717 * backend in use). On retrieval, this field information is lost, all fields being 
    1818 * of the same type (naturally). The core indexer backend supports these field 
    …… 
    4545 * @todo The Type field is not yet handled properly. 
    4646 */ 
    47  
    4847class midcom_services_indexer_document 
    4948{ 
    …… 
    8887 
    8988    /** 
    90      * Two letter language code of the document contnet 
     89     * Two letter language code of the document content 
    9190     * 
    9291     * This field is optional. 
    …… 
    230229     * This is optional. 
    231230     * 
    232      * @var string. 
     231     * @var string 
    233232     */ 
    234233    var $topic_url = ''; 
    …… 
    249248 
    250249    /** 
    251      * Security mechainsm used to determine the availability of a search result. 
     250     * Security mechanism used to determine the availability of a search result. 
    252251     * Can be one of: 
    253252     * 
    254253     * - 'default': Use only built-in processing (topic and metadata visibility checks), this is, as you might have guessed, the default. 
    255254     * - 'component': Invoke the _on_check_document_visible component interface method of the component after doing default checks. 
    256      *   This security class absolutely requires the document to contain a vaild topic GUID, otherwise access control will fail anyway. 
     255     *   This security class absolutely requires the document to contain a valid topic GUID, otherwise access control will fail anyway. 
    257256     * - 'function:$function_name': Invoke the globally available function $function_name, its signature is <i>boolean $function_name ($document, $topic)</i>, 
    258257     *   if you don't change the document during the check, you don't need to pass by-reference, so this is up to you. The topic passed is the 
    …… 
    342341    /** 
    343342     * Add a date field. A timestamp is expected, which is automatically 
    344      * converted to a suiteable ISO timestamp before storage. 
     343     * converted to a suitable ISO timestamp before storage. 
    345344     * 
    346345     * Direct specification of the ISO timestamp is not yet possible due 
    …… 
    365364     * This is useful because the date fields are not in a readable format, 
    366365     * it can't even be determined that they were a date in the first place. 
    367      * so the _TS field is quite useful if you need the orginal value for the 
     366     * so the _TS field is quite useful if you need the original value for the 
    368367     * timestamp. 
    369368     * 

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

    r14133 r14380  
    4646    /** 
    4747     * Constructor 
    48      * @param $config the midcom_config array 
    49      * @param $midcom midcom_application reference. 
     48     * @param array $config the midcom_config 
     49     * @param midcom_application $midcom midcom_application reference. 
    5050     */ 
    5151    function midcom_services_rcs($config) 
    …… 
    7575    /** 
    7676     * Create or update the RCS file for the object. 
    77      * @param $object the midgard object to be saved 
    78      * @param $message the update message to save (optional) 
     77     * @param object &$object the midgard object to be saved 
     78     * @param string $message the update message to save (optional) 
    7979     */ 
    8080    function update(&$object, $message = null) 

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

    r14086 r14380  
    3131     * @return boolean true if save succeeded. 
    3232     * @throws MIDCOM_ERRCRIT on serious errors. 
    33      * @param $comment the message to be saved with the object. 
     33     * @param string $comment the message to be saved with the object. 
    3434     */ 
    3535    function update(&$object, $comment) 

  • trunk/midcom/midcom.helper.datamanager2/controller/ajax.php

    r14329 r14380  
    7676     
    7777    /** 
    78      * This function wraps AJAX processing completely. If component wishes to do post-processing after an edit, save or preview 
     78     * This function wraps AJAX processing completely.  
     79     *  
     80     * If component wishes to do post-processing after an edit, save or preview 
    7981     * state in this call it must set the <i>exit</i> parameter to <i>false</i>. 
    8082     * <i>view</i> state simply returns processing to component. 
    …… 
    248250 
    249251    /** 
    250      * This function wraps the form manager processing. Ifprocessing is successful, (that is, 
     252     * This function wraps the form manager processing. If processing is successful, (that is, 
    251253     * only 'save'). If editing was successful, the form is frozen in case you want 
    252254     * to display it again (usually you want to redirect to the view target). 

  • trunk/midcom/midcom.helper.datamanager2/controller/nullstorage.php

    r14329 r14380  
    6565 
    6666    /** 
    67      * This function wraps the form manager processing. Ifprocessing is successful, (that is, 
     67     * This function wraps the form manager processing. If processing is successful, (that is, 
    6868     * not 'cancel' or 'edit'). 
    6969     * 

  • trunk/midcom/midcom.helper.datamanager2/controller/simple.php

    r14329 r14380  
    4848 
    4949    /** 
    50      * This function wraps the form manager processing. Ifprocessing is successful, (that is, 
    51      * only 'save'). If editing was successful, the form is frozen in case you want 
    52      * to display it again (usually you want to redirect to the view target). 
     50     * This function wraps the form manager processing.  
     51     *  
     52     * If processing is successful, (that is, only 'save'). If editing was successful, the form  
     53     * is frozen in case you want to display it again (usually you want to redirect to the view  
     54     * target). 
    5355     * 
    5456     * There are several possible return values: 

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

    r14329 r14380  
    120120     * Initializes the Form manager with a list of types for a given schema. 
    121121     * 
    122      * @param midcom_helper_datamanager2_schema $schema The schema to use for processing. This 
     122     * @param midcom_helper_datamanager2_schema &$schema The schema to use for processing. This 
    123123     *     variable is taken by reference. 
    124      * @param Array $types A list of types matching the passed schema, used as a basis for the 
     124     * @param Array &$types A list of types matching the passed schema, used as a basis for the 
    125125     *     form types. This variable is taken by reference. 
    126126     */ 
    …… 
    569569     * Sets the form's renderer based on an existing renderer instance. 
    570570     * 
    571      * @param mixed $renderer A prepared HTML_QuickForm_Renderer (or subclass thereof) instance. 
     571     * @param mixed &$renderer A prepared HTML_QuickForm_Renderer (or subclass thereof) instance. 
    572572     * @return void 
    573573     */ 
    …… 
    666666    /** 
    667667     * This helper function adds all rules and filters which are deducable from the schema 
    668      * to the form. It recognizes the follwing schema options: 
     668     * to the form. It recognizes the following schema options: 
    669669     * 
    670670     * - required: Adds a required rule to the form, bound to the given element. 
    …… 
    766766    /** 
    767767     * Set the value of a formelement. 
    768      * @param $key the form field name 
    769      * @param $value the new value to set 
     768     * @param string $key the form field name 
     769     * @param string $value the new value to set 
    770770     */ 
    771771    function set_value( $key, $value ) 

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

    r14329 r14380  
    2828     * Initializes the Form manager with a list of types for a given schema. 
    2929     * 
    30      * @param midcom_helper_datamanager2_schema $schema The schema to use for processing. This 
     30     * @param midcom_helper_datamanager2_schema &$schema The schema to use for processing. This 
    3131     *     variable is taken by reference. 
    32      * @param Array $types A list of types matching the passed schema, used as a basis for the 
     32     * @param Array &$types A list of types matching the passed schema, used as a basis for the 
    3333     *     form types. This variable is taken by reference. 
    3434     */ 

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

    r14329 r14380  
    2323     * Initializes the Form manager with a list of types for a given schema. 
    2424     * 
    25      * @param midcom_helper_datamanager2_schema $schema The schema to use for processing. This 
     25     * @param midcom_helper_datamanager2_schema &$schema The schema to use for processing. This 
    2626     *     variable is taken by reference. 
    27      * @param Array $types A list of types matching the passed schema, used as a basis for the 
     27     * @param Array &$types A list of types matching the passed schema, used as a basis for the 
    2828     *     form types. This variable is taken by reference. 
    2929     */ 
    …… 
    7373        /* The idea: 
    7474         * 
    75          * First, we construct the regular foorm, to allow for a call to process_form. 
     75         * First, we construct the regular form, to allow for a call to process_form. 
    7676         * In process_form, we then process the page switch. There we will have to 
    77          * reconstruct the formn with the new page elements, along with all hidden 
     77         * reconstruct the form with the new page elements, along with all hidden 
    7878         * values. The trick here is to rebuild the form with all unseen fields added 
    7979         * as hidden elements in a way so that the reconstructed form can create 

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

    r14140 r14380  
    135135 
    136136    /** 
    137      * The operations to add to the form. This is a simple array of commands, valid entries 
    138      * are 'save', 'cancel', 'next' and 'previous', 'edit' is forbidden, other values are not 
    139      * interpreted by the DM infrastructure. 
     137     * The operations to add to the form.  
     138     *  
     139     * This is a simple array of commands, valid entries are 'save', 'cancel', 'next' and  
     140     * 'previous', 'edit' is forbidden, other values are not interpreted by the DM infrastructure. 
    140141     * 
    141142     * @var Array 
    …… 
    161162 
    162163    /** 
    163      * Custom data filter rules. This is a list of arrays. Each array defines a single callback, 
    164      * a field list according to HTML_QuickForm::applyFilter along with a snippet or file location 
     164     * Custom data filter rules.  
     165     *  
     166     * This is a list of arrays. Each array defines a single callback, 
     167     * a field list according to HTML_QuickForm::applyFilter() along with a snippet or file location 
    165168     * that should be auto-loaded in case the function is missing. 
    166169     * 
    …… 
    170173 
    171174    /** 
    172      * Construct a schema, takes a schema snippet URI resolveable through the 
     175     * Construct a schema, takes a schema snippet URI resolvable through the 
    173176     * midcom_get_snippet_content() helper function. 
    174177     * 
    175      * @param mixed $schemapath Either the path or the already loaded schema database 
     178     * @param mixed $schemadb Either the path or the already loaded schema database 
    176179     *     to use. 
    177180     * @param string $name The name of the Schema to use. It must be a member in the 
    …… 
    200203     * already in memory, or from a URL resolvable by midcom_get_snippet_content. 
    201204     * 
    202      * @param mixed $schemapath Either the path or the already loaded schema database 
     205     * @param mixed $schemadb Either the path or the already loaded schema database 
    203206     *     to use. 
    204207     * @see midcom_get_snippet_content() 
    …… 
    316319    /** 
    317320     * This function adds a new field to the schema, appending it at the end of the 
    318      * current field listing. This is callable after the construction of the object, 
    319      * to allow you to add additional fields like component required fields to the list. 
     321     * current field listing.  
     322     *  
     323     * This is callable after the construction of the object, to allow you to add  
     324     * additional fields like component required fields to the list. 
    320325     * 
    321326     * This can also be used to merge schemas together. 

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

    r14329 r14380  
    5252     * to take care of linking to the right storage object, where applicable. 
    5353     * 
    54      * @param midcom_helper_datamanager2_schema $schema The data schema to use for processing. 
     54     * @param midcom_helper_datamanager2_schema &$schema The data schema to use for processing. 
    5555     */ 
    5656    function midcom_helper_datamanager2_storage(&$schema) 
    …… 
    9191     * generate_error is called. 
    9292     * 
    93      * @param Array $types A reference to an array of types matching the schema definition. 
     93     * @param Array &$types A reference to an array of types matching the schema definition. 
    9494     * @return boolean Indicating success. 
    9595     */ 
    …… 
    163163     * generate_error is called. 
    164164     * 
    165      * @param Array $types A reference to an array of types matching the schema definition. 
     165     * @param Array &$types A reference to an array of types matching the schema definition. 
    166166     */ 
    167167    function load(&$types) 

  • trunk/midcom/midcom.helper.datamanager2/storage/midgard.php

    r12676 r14380  
    3232     * destroy the reference. 
    3333     * 
    34      * @param midcom_helper_datamanager2_schema $schema The data schema to use for processing. 
     34     * @param midcom_helper_datamanager2_schema &$schema The data schema to use for processing. 
    3535     * @param MidCOMDBAObject $object A reference to the DBA object to user for Data I/O. 
    3636     */ 

  • trunk/midcom/midcom.helper.datamanager2/storage/null.php

    r10966 r14380  
    4141     * TODO 
    4242     * 
    43      * @param midcom_helper_datamanager2_schema $schema The data schema to use for processing. 
    44      * @param Array $defaults The defaults to use as "artificial" storage. This can be ommitted 
     43     * @param midcom_helper_datamanager2_schema &$schema The data schema to use for processing. 
     44     * @param Array $defaults The defaults to use as "artificial" storage. This can be omitted 
    4545     *     safely. 
    4646     */ 

  • trunk/midcom/midcom.helper.datamanager2/storage/tmp.php

    r10966 r14380  
    2828     * Start up the storage manager and bind it to a given temporary object. 
    2929     * 
    30      * @param midcom_helper_datamanager2_schema $schema The data schema to use for processing. 
    31      * @param Array $defaults The defaults to use as "artificial" storage. This can be ommitted 
     30     * @param midcom_helper_datamanager2_schema &$schema The data schema to use for processing. 
     31     * @param Array $defaults The defaults to use as "artificial" storage. This can be omitted 
    3232     *     safely. 
    3333     * @param midcom_core_temporary_object $object The temporary object to use. 

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

    r14329 r14380  
    838838     * Rewrite a filename to URL safe form 
    839839     * 
    840      * @param $filename string file name to rewrite 
    841      * @param $force_single_extension boolean force file to single extension (defaults to true) 
     840     * @param string $filename file name to rewrite 
     841     * @param boolean $force_single_extension force file to single extension (defaults to true) 
    842842     * @return string rewritten filename 
    843843     */ 
    …… 
    869869     * Creates a working copy to filesystem from given attachment object 
    870870     * 
    871      * @param $att the attachment object to copy 
     871     * @param object $att the attachment object to copy 
    872872     * @return string tmp file name (or false on failure) 
    873873     */ 

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

    r14329 r14380  
    5555 * <b>Available configuration options:</b> 
    5656 * 
    57  * - boolean keep_original controls whether you want to keep the orginally uploaded 
     57 * - boolean keep_original controls whether you want to keep the originally uploaded 
    5858 *   file available. This option is disabled by default. 
    5959 * - string filter_chain The filter chain used to render the main image. This chain 
    6060 *   empty (null) by default. 
    6161 * - Array derived_images A list of derived images to construct from the main image. 
    62  *   This option consists of a list of identfier/filter chain declarations. They will 
     62 *   This option consists of a list of identifier/filter chain declarations. They will 
    6363 *   be constructed in order, each using a fresh copy of the (initially type-converted) 
    6464 *   original image. This options may be null (the default) indicating no derived 
    …… 
    111111 
    112112    /** 
    113      * The maximum witdh/height (in this order) of the thumbnail to be auto-created. 
     113     * The maximum width/height (in this order) of the thumbnail to be auto-created. 
    114114     * 
    115115     * The passed values will be given to the rescale function of the imagefilter. 
    …… 
    117117     * to set the height parameter to zero (auto_thumbnail => Array(100,0)). 
    118118     * 
    119      * @var array. 
     119     * @var array 
    120120     */ 
    121121    var $auto_thumbnail = null; 
    …… 
    184184     * image. All attachments still listed here after a set_image call will 
    185185     * be deleted. This keeps attachment GUIDs stable during updates but also 
    186      * adds resilence against against changed type configuration. 
     186     * adds resilience against against changed type configuration. 
    187187     * 
    188188     * @access private 
    …… 
    307307 
    308308    /** 
    309      * Preparation operations for recrete_xxx() 
     309     * Preparation operations for recreate_xxx() 
    310310     */ 
    311311    function _prepare_recreate($force = false) 
    …… 
    367367     * 
    368368     * @param string $direction direction to rotate to 
    369      * @return boolean indicating success/faiilure 
     369     * @return boolean indicating success/failure 
    370370     */ 
    371371    function rotate($direction) 
    …… 
    438438     * Applies a filter to image identifier 
    439439     * 
    440      * @param string $identifierthe image identifier to apply to 
     440     * @param string $identifier the image identifier to apply to 
    441441     * @param string $filter the midcom_helper_imagefilter filter chain to apply 
    442442     * @return boolean indicating success/failure 
    …… 
    509509     * Overwrites image content from file, recalculates size etc 
    510510     * 
    511      * @param $identifier image identifier to update 
    512      * @param $file file to use 
     511     * @param string $identifier image identifier to update 
     512     * @param string $file file to use 
    513513     * @return boolean indicating success/failure 
    514514     */ 

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

    r14329 r14380  
    633633     * 
    634634     * @param string $direction direction to rotate to 
    635      * @return boolean indicating success/faiilure 
     635     * @return boolean indicating success/failure 
    636636     */ 
    637637    function rotate($images_identifier, $direction) 

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

    r14329 r14380  
    3434 
    3535    /** 
    36      * Preparation operations for recrete_xxx() 
     36     * Preparation operations for recreate_xxx() 
    3737     */ 
    3838    function _prepare_recreate($force = true) 

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

    r14329 r14380  
    5555 * <b>Available configuration options:</b> 
    5656 * 
    57  * - boolean keep_original controls whether you want to keep the orginally uploaded 
     57 * - boolean keep_original controls whether you want to keep the originally uploaded 
    5858 *   file available. This option is disabled by default. 
    5959 * - string filter_chain The filter chain used to render the main image. This chain 
    6060 *   empty (null) by default. 
    6161 * - Array derived_images A list of derived images to construct from the main image. 
    62  *   This option consists of a list of identfier/filter chain declarations. They will 
     62 *   This option consists of a list of identifier/filter chain declarations. They will 
    6363 *   be constructed in order, each using a fresh copy of the (initially type-converted) 
    6464 *   original image. This options may be null (the default) indicating no derived 
    …… 
    111111 
    112112    /** 
    113      * The maximum witdh/height (in this order) of the thumbnail to be auto-created. 
     113     * The maximum width/height (in this order) of the thumbnail to be auto-created. 
    114114     * 
    115115     * The passed values will be given to the rescale function of the imagefilter. 
    …… 
    117117     * to set the height parameter to zero (auto_thumbnail => Array(100,0)). 
    118118     * 
    119      * @var array. 
     119     * @var array 
    120120     */ 
    121121    var $auto_thumbnail = null; 
    …… 
    190190     * image. All attachments still listed here after a set_image call will 
    191191     * be deleted. This keeps attachment GUIDs stable during updates but also 
    192      * adds resilence against against changed type configuration. 
     192     * adds resilience against against changed type configuration. 
    193193     * 
    194194     * @access private 
    …… 
    315315 
    316316    /** 
    317      * Preparation operations for recrete_xxx() 
     317     * Preparation operations for recreate_xxx() 
    318318     */ 
    319319    function _prepare_recreate($force = false) 
    …… 
    372372     * 
    373373     * @param string $direction direction to rotate to 
    374      * @return boolean indicating success/faiilure 
     374     * @return boolean indicating success/failure 
    375375     */ 
    376376    function rotate($direction) 
    …… 
    443443     * Applies a filter to image identifier 
    444444     * 
    445      * @param string $identifierthe image identifier to apply to 
     445     * @param string $identifier the image identifier to apply to 
    446446     * @param string $filter the midcom_helper_imagefilter filter chain to apply 
    447447     * @return boolean indicating success/failure 
    …… 
    514514     * Overwrites image content from file, recalculates size etc 
    515515     * 
    516      * @param $identifier image identifier to update 
    517      * @param $file file to use 
     516     * @param string $identifier image identifier to update 
     517     * @param string $file file to use 
    518518     * @return boolean indicating success/failure 
    519519     */ 

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

    r14329 r14380  
    4848 
    4949    /** 
    50      * The name field holds the name of the field the widget is encapsulating. This 
    51      * maps to the schema's field name. You should never have to change them. 
     50     * The name field holds the name of the field the widget is encapsulating.  
     51     *  
     52     * This maps to the schema's field name. You should never have to change them. 
    5253     * 
    5354     * @var string 
    …… 
    5758 
    5859    /** 
    59      * A reference to the schema field we should draw. Description texts etc. are taken from here. 
     60     * A reference to the schema field we should draw.  
     61     *  
     62     * Description texts etc. are taken from here. 
    6063     * 
    6164     * @var Array 
    …… 
    6568 
    6669    /** 
    67      * The schema (not the schema <i>database!</i>) to use for operation. This variable will always contain a parsed 
    68      * representation of the schema, so that one can swiftly switch between individual schemas 
    69      * of the Database. 
     70     * The schema (not the schema <i>database!</i>) to use for operation.  
     71     *  
     72     * This variable will always contain a parsed representation of the schema, so that  
     73     * one can swiftly switch between individual schemas of the Database. 
    7074     * 
    7175     * This member is initialized by-reference. 
    …… 
    8589 
    8690    /** 
    87      * This is the Namespace to use for all HTML/CSS/JS elements. It is deduced by the formmanager 
    88      * and tries to be as smart as possible to work safely with more then one form on a page. 
    89      * 
    90      * You have to prefix all elements which must be unique using this string (it includes a trailing 
    91      * underscore). 
     91     * This is the Namespace to use for all HTML/CSS/JS elements.  
     92     *  
     93     * It is deduced by the formmanager and tries to be as smart as possible to work safely with  
     94     * more then one form on a page. 
     95     * 
     96     * You have to prefix all elements which must be unique using this string (it includes a  
     97     * trailing underscore). 
    9298     * 
    9399     * @var string 
    …… 
    121127     * @param string $name The name of the field to which this widget is bound. 
    122128     * @param Array $config The configuration data which should be used to customize the widget. 
    123      * @param midcom_helper_datamanager2_schema $schema A reference to the full schema object. 
     129     * @param midcom_helper_datamanager2_schema &$schema A reference to the full schema object. 
    124130     * @param midcom_helper_datamanager2_type $type A reference to the type to which we are bound. 
    125131     * @param string $namespace The namespace to use including the trailing underscore. 
    …… 
    164170 
    165171    /** 
    166      * This function, is called  before the configuration keys are merged into the types 
     172     * This function is called  before the configuration keys are merged into the types 
    167173     * configuration. 
    168174     */ 
    …… 
    182188 
    183189    /** 
    184      * Gets an external configuration option referenced by its key. Besides other parts 
    185      * in the datamanager framework, nobody should ever have to touch this information. 
     190     * Gets an external configuration option referenced by its key.  
     191     *  
     192     * Besides other parts in the datamanager framework, nobody should ever have to  
     193     * touch this information. 
    186194     * 
    187195     * @param string $key The key by which this configuration option is referenced. 
    …… 
    198206 
    199207    /** 
    200      * Sets an external configuration option. Besides other parts 
    201      * in the datamanager framework, nobody should ever have to touch this information. 
     208     * Sets an external configuration option.  
     209     *  
     210     * Besides other parts in the datamanager framework, nobody should ever have to  
     211     * touch this information. 
    202212     * 
    203213     * @param string $key The key by which this configuration option is referenced. 
    …… 
    223233 
    224234    /** 
    225      * Returns the default value for this field as required by HTML_Quickform. You 
    226      * may either return a single value for simple types, or an array of form field name / value 
    227      * pairs in case of composite types. A value of null