1: <?php
  2: 
  3: /**
  4:  * Class QModelConnectorParam
  5:  *
  6:  * Encapsulates a description of an editable ModelConnector parameter.
  7:  *
  8:  * For example, this class would be used to tell the QModelConnectorEditDlg that you can set the
  9:  * name of a control using a text box, or the visibility state of a control using boolean selector.
 10:  *
 11:  * You can currently specify a boolean value, a text value, an integer value, or a list of options.
 12:  *
 13:  * @property-read string $Category
 14:  * @property-read string $Name
 15:  */
 16: 
 17: class QModelConnectorParam extends QBaseClass {
 18:     /** Specifies a list of items to present to the user to select from. */
 19:     const SelectionList = 'list';
 20: 
 21:     const GeneralCategory = 'General';
 22: 
 23:     protected $strCategory;
 24:     protected $strName;
 25:     protected $strDescription;
 26:     protected $controlType;
 27:     protected $options;
 28: 
 29:     /** @var  QControl caching the created control */
 30:     protected $objControl;
 31: 
 32:     public function __construct($strCategory, $strName, $strDescription, $controlType, $options = null) {
 33:         $this->strCategory = QApplication::Translate($strCategory);
 34:         $this->strName  = QApplication::Translate($strName);
 35:         $this->strDescription = QApplication::Translate($strDescription);
 36:         $this->controlType = $controlType;
 37: 
 38:         $this->options = $options;
 39: 
 40:         if ($controlType == QModelConnectorParam::SelectionList && !$options) {
 41:             throw new QCallerException ('Selection list without a list of items to select.');
 42:         }
 43: 
 44:     }
 45: 
 46:     /**
 47:      * Called by the QModelConnectorEditDlg dialog. Creates a control that will allow the user to edit the value
 48:      * associated with this parameter, and caches that control so that its easy to get to.
 49:      *
 50:      * @param QControl|null $objParent
 51:      * @return null|QControl|QIntegerTextBox|QListBox|QRadioButtonList|QTextBox
 52:      */
 53:     public function GetControl ($objParent = null) {
 54:         if ($this->objControl) {
 55:             if ($objParent) {
 56:                 $this->objControl->SetParentControl($objParent);
 57:             }
 58:             return $this->objControl;
 59:         } elseif ($objParent) {
 60:             $this->objControl = $this->CreateControl($objParent);
 61:             return $this->objControl;
 62:         }
 63:         return null;
 64:     }
 65: 
 66:     /**
 67:      * Creates the actual control that will edit the value.
 68:      *
 69:      * @param QControl $objParent
 70:      * @return QIntegerTextBox|QListBox|QRadioButtonList|QTextBox
 71:      */
 72:     protected function CreateControl(QControl $objParent) {
 73:         switch ($this->controlType) {
 74:             case QType::Boolean:
 75:                 $ctl = new QRadioButtonList($objParent);
 76:                 $ctl->AddItem('True', true);
 77:                 $ctl->AddItem('False', false);
 78:                 $ctl->AddItem('None', null);
 79:                 $ctl->RepeatColumns = 3;
 80:                 break;
 81: 
 82:             case QType::String:
 83:                 $ctl = new QTextBox($objParent);
 84:                 break;
 85: 
 86:             case QType::Integer:
 87:                 $ctl = new QIntegerTextBox($objParent);
 88:                 break;
 89: 
 90:             case QType::ArrayType:  // an array the user will specify in a comma separated list
 91:                 $ctl = new QTextBox($objParent);
 92:                 break;
 93: 
 94:             case QModelConnectorParam::SelectionList: // a specific set of choices to present to the user
 95:                 $ctl = new QListBox($objParent);
 96: 
 97:                 foreach ($this->options as $key=>$val) {
 98:                     $ctl->AddItem ($val, $key === '' ? null : $key); // allow null item keys
 99:                 }
100:                 break;
101: 
102:             default: // i.e. QJsClosure, or other random items. Probably codegened, and not used much.
103:                 $ctl = new QTextBox($objParent);
104:                 break;
105: 
106:         }
107: 
108:         $ctl->Name = $this->strName;
109:         $ctl->ToolTip = $this->strDescription;
110:         return $ctl;
111: 
112:     }
113: 
114:     public function __get ($strName) {
115:         switch ($strName) {
116:             case 'Name':
117:                 return $this->strName;
118:                 break;
119: 
120:             case 'Category':
121:                 return $this->strCategory;
122:                 break;
123: 
124:             default:
125:                 try {
126:                     return parent::__get($strName);
127:                 } catch (QCallerException $objExc) {
128:                     $objExc->IncrementOffset();
129:                     throw $objExc;
130:                 }
131:         }
132:     }
133: 
134: }
135: 
136: