tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Source for file tangra_module_release_param.class.php

Documentation is available at tangra_module_release_param.class.php

  1. <?php
  2.  
  3. // $Id$
  4.  
  5. /**
  6.  * Contains class Tangra_Module_DBC
  7.  *
  8.  * @package  tangra_lib
  9.  * @subpackage  modules_manager
  10.  */
  11.  
  12.  
  13. /**
  14.  * Tangra_Module_Release_Param
  15.  *
  16.  * Represents release parameter
  17.  *
  18.  * @package  tangra_lib
  19.  * @subpackage  modules_manager
  20.  */
  21. class Tangra_Module_Release_Param extends Tangra_Class {
  22.     /**
  23.      * Parameter type required
  24.      *
  25.      */
  26.     const TYPE_REQUIRED = 1;
  27.     /**
  28.      * Parameter type hard optional
  29.      *
  30.      */
  31.     const TYPE_HARD_OPTIONAL = 2;
  32.     /**
  33.      * Parameter type soft optional
  34.      *
  35.      */
  36.     const TYPE_SOFT_OPTIONAL = 3;
  37.  
  38.     /**
  39.      * ID
  40.      *
  41.      * @var integer 
  42.      * @internal
  43.      */
  44.     private $id;
  45.     /**
  46.      * Parameter type ID
  47.      *
  48.      * @var integer 
  49.      * @internal
  50.      */
  51.     private $type;
  52.     /**
  53.      * Module release ID
  54.      *
  55.      * @var integer 
  56.      * @internal
  57.      */
  58.     private $module_release;
  59.     /**
  60.      * Name of the parameter
  61.      *
  62.      * @var string 
  63.      * @internal
  64.      */
  65.     private $name;
  66.     /**
  67.      * Description
  68.      *
  69.      * @var string 
  70.      * @internal
  71.      */
  72.     private $description;
  73.     /**
  74.      * Default value for parameter
  75.      *
  76.      * @var string 
  77.      * @internal
  78.      */
  79.     private $default_value;
  80.  
  81.  
  82.     /**
  83.      * Sets ID
  84.      *
  85.      * @param integer $id 
  86.      */
  87.     public function set_id($id) {
  88.         tangra_if_not_int_throw_e($id);
  89.  
  90.         $this->id = $id;
  91.     }
  92.  
  93.  
  94.     /**
  95.      * Gets ID
  96.      *
  97.      * @return integer 
  98.      */
  99.     public function get_id() {
  100.         return $this->id;
  101.     }
  102.  
  103.  
  104.     /**
  105.      * Sets type id
  106.      *
  107.      * @param integer $type 
  108.      */
  109.     public function set_type($type) {
  110.         tangra_if_not_int_throw_e($type);
  111.  
  112.         $this->type = $type;
  113.     }
  114.  
  115.  
  116.     /**
  117.      * Gets type id
  118.      *
  119.      * @return integer 
  120.      */
  121.     public function get_type() {
  122.         return $this->type;
  123.     }
  124.  
  125.  
  126.     /**
  127.      * Sets release ID
  128.      *
  129.      * @param integer $module_release 
  130.      * @internal
  131.      */
  132.     public function set_module_release($module_release) {
  133.         tangra_if_not_int_throw_e($module_release);
  134.  
  135.         $this->module_release = $module_release;
  136.     }
  137.  
  138.  
  139.     /**
  140.      * Gets release ID
  141.      *
  142.      * @return integer 
  143.      */
  144.     public function get_module_release() {
  145.         return $this->module_release;
  146.     }
  147.  
  148.  
  149.     /**
  150.      * Sets parameter name
  151.      *
  152.      * @param string $name 
  153.      */
  154.     public function set_name($name) {
  155.         $this->name = $name;
  156.     }
  157.  
  158.  
  159.     /**
  160.      * Gets parameter name
  161.      *
  162.      * @return string 
  163.      */
  164.     public function get_name() {
  165.         return $this->name;
  166.     }
  167.  
  168.  
  169.     /**
  170.      * Sets description
  171.      *
  172.      * @param string $description 
  173.      */
  174.     public function set_description($description) {
  175.         $this->description = $description;
  176.     }
  177.  
  178.  
  179.     /**
  180.      * Gets description
  181.      *
  182.      * @return string 
  183.      */
  184.     public function get_description() {
  185.         return $this->description;
  186.     }
  187.  
  188.  
  189.     /**
  190.      * Sets default value
  191.      *
  192.      * @param string $default_value 
  193.      */
  194.     public function set_default_value($default_value) {
  195.         $this->default_value = $default_value;
  196.     }
  197.  
  198.  
  199.     /**
  200.      * Gets default value
  201.      *
  202.      * @return unknown 
  203.      */
  204.     public function get_default_value() {
  205.         return $this->default_value;
  206.     }
  207. }