Changeset 14081

Show
Ignore:
Timestamp:
12/21/07 18:36:17 (10 months ago)
Author:
flack
Message:

add missing phpdoc

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/midcom/midcom.helper.schemaapi/field.php

    r5029 r14081  
    11<?php 
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
    28 
    3 class midcom_helper_schemaapi_field  
     9class midcom_helper_schemaapi_field 
    410{ 
    511    protected $name; 
     
    915    protected $type; 
    1016 
    11     public function __construct ( $name, $storage, $title )  
     17    public function __construct ( $name, $storage, $title ) 
    1218    { 
    1319        $this->name = $name; 
     
    1622    } 
    1723 
    18     
     24 
    1925    public function set_type ( $type ) { 
    2026 
     
    2834    public function asArray(  ) { 
    2935        $ret = array(  ); 
    30         $ret[$this->name] = array(  
     36        $ret[$this->name] = array( 
    3137                'title' => $this->title, 
    3238                'storage' => $this->storage, 
     
    3642                //'widget_config' => $this->widget->get_config( ) , 
    3743                ); 
    38         if ( count ( $this->widget->get_config(  ) ) > 0  )  
     44        if ( count ( $this->widget->get_config(  ) ) > 0  ) 
    3945        { 
    4046            $ret[$this->name]['widget_config'] = $this->widget->get_config(  ); 
    4147        } 
    42         if ( count ( $this->type->get_config(  ) ) )  
     48        if ( count ( $this->type->get_config(  ) ) ) 
    4349        { 
    4450            $ret[$this->name]['type_config'] = $this->type->get_config(  ); 
  • trunk/midcom/midcom.helper.schemaapi/schema.php

    r5029 r14081  
    11<?php 
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
    29require_once 'field.php'; 
    310require_once 'supertype.php'; 
    4 class midcom_helper_schemaapi_schema  
     11class midcom_helper_schemaapi_schema 
    512{ 
    613 
     
    916    protected $fields = array(  ); 
    1017 
    11     public function __construct(  )  
     18    public function __construct(  ) 
    1219    { 
    1320 
    1421    } 
    1522 
    16     public function asString (  )  
     23    public function asString (  ) 
    1724    { 
    1825        $out = array(  ); 
    19         $out[$this->name] = array (  
     26        $out[$this->name] = array ( 
    2027                'description' => $this->description, 
    2128                'fields' => $this->fields, 
     
    3340    } 
    3441 
    35     public function set_description( $desc )  
     42    public function set_description( $desc ) 
    3643    { 
    3744        $this->description = $desc; 
    3845    } 
    3946 
    40     public function get_description(  )  
     47    public function get_description(  ) 
    4148    { 
    4249        return $this->description; 
     
    4451    /** 
    4552     * adds a field to the fieldarray 
    46      * @param midcom_helper_schemaapi_field  
     53     * @param midcom_helper_schemaapi_field 
    4754     */ 
    48     public function add_field( $field )  
     55    public function add_field( $field ) 
    4956    { 
    5057        $this->fields = array_merge(  $this->fields ,$field->asArray(  )); 
     
    5865            $class =<<<EOF 
    5966<?php 
    60 class midcom_helper_schemaapi_widget_$widget extends midcom_helper_schemaapi_supertype  
     67class midcom_helper_schemaapi_widget_$widget extends midcom_helper_schemaapi_supertype 
    6168{ 
    6269 
     
    7986            $class =<<<EOF 
    8087<?php 
    81 class midcom_helper_schemaapi_type_$type extends midcom_helper_schemaapi_supertype  
     88class midcom_helper_schemaapi_type_$type extends midcom_helper_schemaapi_supertype 
    8289{ 
    8390 
     
    8693        parent::__construct( "$type" ); 
    8794    } 
    88      
     95 
    8996} 
    9097?> 
  • trunk/midcom/midcom.helper.schemaapi/supertype.php

    r5029 r14081  
    11<?php 
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
    29/** 
    310 * Types and widgets use the same overarching interface so no need for different classes there. 
     
    916    public function __construct( $name ) 
    1017    { 
    11         $this->name = $name;     
     18        $this->name = $name; 
    1219    } 
    1320 
    14     public function get_name(  )  
     21    public function get_name(  ) 
    1522    { 
    1623        return $this->name; 
    1724    } 
    1825 
    19     public function get_config(  )  
     26    public function get_config(  ) 
    2027    { 
    2128        return $this->config; 
  • trunk/midcom/midcom.helper.schemaapi/type/date.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_type_date extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_type_date extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
     
    714        parent::__construct( "date" ); 
    815    } 
    9      
     16 
    1017} 
    1118?> 
  • trunk/midcom/midcom.helper.schemaapi/type/number.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_type_number extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_type_number extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
     
    714        parent::__construct( "number" ); 
    815    } 
    9      
     16 
    1017} 
    1118?> 
  • trunk/midcom/midcom.helper.schemaapi/type/password.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_type_password extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_type_password extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
     
    714        parent::__construct( "password" ); 
    815    } 
    9      
     16 
    1017} 
    1118?> 
  • trunk/midcom/midcom.helper.schemaapi/type/text.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_type_text extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8class midcom_helper_schemaapi_type_text extends midcom_helper_schemaapi_supertype 
    39{ 
    410 
     
    713        parent::__construct( "text" ); 
    814    } 
    9      
     15 
    1016} 
    1117?> 
  • trunk/midcom/midcom.helper.schemaapi/widget/jsdate.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_widget_jsdate extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_widget_jsdate extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
  • trunk/midcom/midcom.helper.schemaapi/widget/password.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_widget_password extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_widget_password extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
  • trunk/midcom/midcom.helper.schemaapi/widget/text.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_widget_text extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_widget_text extends midcom_helper_schemaapi_supertype 
    310{ 
    411 
  • trunk/midcom/midcom.helper.schemaapi/widget/tinymce.php

    r5029 r14081  
    11<?php 
    2 class midcom_helper_schemaapi_widget_tinymce extends midcom_helper_schemaapi_supertype  
     2/** 
     3 * @package midcom.helper.schemaapi 
     4 * @author The Midgard Project, http://www.midgard-project.org 
     5 * @copyright The Midgard Project, http://www.midgard-project.org 
     6 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 
     7 */ 
     8 
     9class midcom_helper_schemaapi_widget_tinymce extends midcom_helper_schemaapi_supertype 
    310{ 
    411