1: <?php
  2:     /**
  3:      * This file contains the QBlockControl class.
  4:      * 
  5:      * @package Controls
  6:      */
  7: 
  8:     /**
  9:      * This abstract class is designed to be a base for class for span and div controls. It adds additional drag and
 10:      * drop support to these objects, as well as templating.
 11:      *
 12:      * @package Controls
 13:      *
 14:      * @property string $Text is the Html that you want rendered
 15:      * @property string $Format is a sprintf string that the Text property will be sent to for further formatting.
 16:      * @property string $Template Path to the HTML template (.tpl.php) file (applicable in case a template is being used for Render)
 17:      * @property boolean $AutoRenderChildren Render the child controls of this control automatically
 18:      * @property string $TagName HTML tag to be used by the control (such as div or span)
 19:      * @property boolean $HtmlEntities hould htmlentities be used on the contents of this control
 20:      * @property boolean $DropTarget Is this a drop target?
 21:      * @property string $HorizontalAlign
 22:      * @property string $VerticalAlign
 23:      * @property integer $ResizeHandleMinimum
 24:      * @property integer $ResizeHandleMaximum
 25:      * @property string $ResizeHandleDirection
 26:      */
 27:     abstract class QBlockControl extends QControl {
 28:         ///////////////////////////
 29:         // Private Member Variables
 30:         ///////////////////////////
 31: 
 32:         // APPEARANCE
 33:         /** @var string The text on the control */
 34:         protected $strText = null;
 35:             /** @var string The format specifier for rendering the control  */
 36:         protected $strFormat = null;
 37:         /** @var string Path to the HTML template (.tpl.php) file (applicable in case a template is being used for Render) */
 38:         protected $strTemplate = null;
 39:         /** @var bool Render the child controls of this control automatically? */
 40:         protected $blnAutoRenderChildren = false;
 41:         /** @var string HTML tag to be used by the control (such as div or span) */
 42:         protected $strTagName = null;
 43:         /** @var bool Should htmlentities be used on the contents of this control? */
 44:         protected $blnHtmlEntities = true;
 45: 
 46:         // BEHAVIOR
 47:         /** @var bool Is it a drop target? */
 48:         protected $blnDropTarget = false;
 49: 
 50:         // Move Targets and Drop Zones
 51:         protected $objMovesControlsArray = array();
 52:         protected $objDropsControlsArray = array();
 53:         protected $objDropsGroupingsArray = array();
 54:         protected $objIsDropZoneFor = array();
 55: 
 56:         public function AddControlToMove($objTargetControl = null) {        
 57:             $this->strJavaScripts = __JQUERY_EFFECTS__;
 58:             if($objTargetControl && $objTargetControl->ControlId != $this->ControlId) {
 59:                 QApplication::ExecuteJavascript(sprintf('var pos_%s = $j("#%s").offset()', $objTargetControl->ControlId, $objTargetControl->ControlId));
 60:                 QApplication::ExecuteJavascript(sprintf('$j("#%s").on("drag",  function (ev, ui) { p = $j("#%s").offset(); p.left = pos_%s.left + ui.position.left; p.top = pos_%s.top + ui.position.top; $j("#%s").offset(p); } );', $this->strControlId,  $objTargetControl->ControlId,  $objTargetControl->ControlId,  $objTargetControl->ControlId, $objTargetControl->ControlId ));
 61:                 $this->objMovesControlsArray[$objTargetControl->ControlId] = true;
 62: 
 63:                 // TODO:
 64:                 // Replace ExecuteJavascript with this:
 65:                 //$this->AddAttributeScript('qcubed', 'ctrlToMove', $objTargetControl->ControlId);
 66:             }
 67:             return;
 68:         }
 69: 
 70:         public function RemoveControlToMove(QControl $objTargetControl) {
 71:             unset($this->objMovesControlsArray[$objTargetControl->ControlId]);
 72:         }
 73: 
 74:         public function RemoveAllControlsToMove() {
 75:             $this->objMovesControlsArray = array();
 76:             $this->RemoveAllDropZones();
 77:         }
 78: 
 79:         public function AddDropZone($objParentObject) {
 80:             $this->strJavaScripts = __JQUERY_EFFECTS__;
 81:             $this->objDropsControlsArray[$objParentObject->ControlId] = true;
 82:             $objParentObject->DropTarget = true;
 83:             $objParentObject->objIsDropZoneFor[$this->ControlId] = true;            
 84:         }
 85: 
 86:         public function RemoveDropZone($objParentObject) {
 87:             if ($objParentObject instanceof QForm) {
 88:                 $this->objDropsControlsArray[$objParentObject->FormId] = false;
 89:             } else if ($objParentObject instanceof QBlockControl) {
 90:                 $this->objDropsControlsArray[$objParentObject->ControlId] = false;
 91:                 $objParentObject->objIsDropZoneFor[$this->ControlId] = false;
 92:             } else
 93:                 throw new QCallerException('ParentObject must be either a QForm or QBlockControl object');
 94:         }
 95: 
 96:         public function RemoveAllDropZones() {
 97:             QApplication::ExecuteControlCommand($this->strControlId, 'draggable', "option", "revert", "invalid");
 98: 
 99:             foreach ($this->objDropsControlsArray as $strControlId => $blnValue) {
100:                 if ($blnValue) {
101:                     $objControl = $this->objForm->GetControl($strControlId);
102:                     if ($objControl)
103:                         $objControl->objIsDropZoneFor[$this->ControlId] = false;
104:                 }
105:             }
106:             $this->objDropsControlsArray = array();
107:         }
108: 
109:         /**
110:          * Returns the End Script of the Control which is sent to the client when the control's Render is complete
111:          * @return string The JS EndScript for the control
112:          */
113:         public function GetEndScript() {
114:             $strToReturn = parent::GetEndScript();
115:             
116:             // DROP ZONES
117:             foreach ($this->objDropsControlsArray as $strKey => $blnIsDropZone) {
118:                 if ($blnIsDropZone) {
119:                     QApplication::ExecuteControlCommand($strKey, 'droppable');
120:                 }
121:             }
122: 
123:             foreach ($this->objIsDropZoneFor as $strKey => $blnIsDropZone) {
124:                 if ($blnIsDropZone) {
125:                     $objControl = $this->objForm->GetControl($strKey);
126:                     if ($objControl && ($objControl->strRenderMethod)) {
127:                         QApplication::ExecuteControlCommand($this->strControlId, 'droppable', 'option', 'accept', '#' . $strKey);
128:                     }
129:                 }
130:             }
131: 
132:             return $strToReturn;
133:         }
134: 
135:         //////////
136:         // Methods
137:         //////////
138:         /**
139:          * Public function (to be overridden in child classes) to Parse the POST data recieved by control
140:          */
141:         public function ParsePostData() {}
142: 
143: 
144:         /**
145:          * Returns the HTML of the QControl
146:          * @return string The HTML string
147:          */
148:         protected function GetControlHtml() {
149: 
150:             $strToReturn = $this->RenderTag($this->strTagName,
151:                 null,
152:                 null,
153:                 $this->GetInnerHtml());
154: 
155: //          if ($this->blnDropTarget)
156: //              $strToReturn .= sprintf('<span id="%s_ctldzmask" style="position:absolute;"><span style="font-size: 1px">&nbsp;</span></span>', $this->strControlId);
157: 
158:             return $strToReturn;
159:         }
160: 
161:         /**
162:          * Return the inner html between the tags.
163:          *
164:          * @return string
165:          */
166:         protected function GetInnerHtml() {
167:             if ($this->strFormat) {
168:                 $strText = sprintf($this->strFormat, $this->strText);
169:             }
170:             else {
171:                 $strText = $this->strText;
172:             }
173: 
174:             if ($this->blnHtmlEntities) {
175:                 $strText = QApplication::HtmlEntities($strText);
176:             }
177: 
178:             $strTemplateEvaluated = '';
179:             if ($this->strTemplate) {
180:                 global $_CONTROL;
181:                 $objCurrentControl = $_CONTROL;
182:                 $_CONTROL = $this;
183:                 $strTemplateEvaluated = $this->EvaluateTemplate($this->strTemplate);
184:                 $_CONTROL = $objCurrentControl;
185:             }
186: 
187:             $strText .= $strTemplateEvaluated;
188: 
189:             if ($this->blnAutoRenderChildren) {
190:                 $strText .= $this->RenderChildren(false);
191:             }
192:             return $strText;
193:         }
194: 
195:         /**
196:          * Public function to be overrriden by child classes
197:          *
198:          * It is used to determine if the input fed into the control is valid or not.
199:          * The rules are written in this function only. If the control is set for Validation,
200:          * this function is automatically called on postback.
201:          * @return bool Whether or not the input inside the control are valid
202:          */
203:         public function Validate() {return true;}
204: 
205:         /////////////////////////
206:         // Public Properties: GET
207:         /////////////////////////
208:         /**
209:          * PHP __get magic method implementation
210:          * @param string $strName Name of the property
211:          *
212:          * @return mixed
213:          * @throws Exception|QCallerException
214:          */
215:         public function __get($strName) {
216:             switch ($strName) {
217:                 // APPEARANCE
218:                 case "Text": return $this->strText;
219:                 case "Format": return $this->strFormat;
220:                 case "Template": return $this->strTemplate;
221:                 case "AutoRenderChildren": return $this->blnAutoRenderChildren;
222:                 case "TagName": return $this->strTagName;
223:                 case "HtmlEntities": return $this->blnHtmlEntities;
224: 
225:                 // BEHAVIOR
226:                 case "DropTarget": return $this->blnDropTarget;
227: 
228:                 default:
229:                     try {
230:                         return parent::__get($strName);
231:                     } catch (QCallerException $objExc) {
232:                         $objExc->IncrementOffset();
233:                         throw $objExc;
234:                     }
235:             }
236:         }
237: 
238:         /////////////////////////
239:         // Public Properties: SET
240:         /////////////////////////
241:         /**
242:          * PHP __set magic method implementation
243:          * @param string $strName Property Name
244:          * @param string $mixValue Property Value
245:          *
246:          * @return mixed
247:          * @throws Exception|QCallerException|QInvalidCastException
248:          */
249:         public function __set($strName, $mixValue) {
250:             switch ($strName) {
251:                 // APPEARANCE
252:                 case "Text":
253:                     try {
254:                         if ($this->strText !== ($mixValue = QType::Cast($mixValue, QType::String))) {
255:                             $this->blnModified = true;
256:                             $this->strText = $mixValue;
257:                         }
258:                         break;
259:                     } catch (QInvalidCastException $objExc) {
260:                         $objExc->IncrementOffset();
261:                         throw $objExc;
262:                     }
263: 
264:                 case "Format":
265:                     try {
266:                         if ($this->strFormat !== ($mixValue = QType::Cast($mixValue, QType::String))) {
267:                             $this->blnModified = true;
268:                             $this->strFormat = $mixValue;
269:                         }
270:                         break;
271:                     } catch (QInvalidCastException $objExc) {
272:                         $objExc->IncrementOffset();
273:                         throw $objExc;
274:                     }
275: 
276:                 case "Template":
277:                     try {
278:                         $this->blnModified = true;
279:                         if ($mixValue) {
280:                             if (file_exists($strPath = $this->GetTemplatePath($mixValue))) {
281:                                 $this->strTemplate = QType::Cast($strPath, QType::String);
282:                             } else {
283:                                 throw new QCallerException('Could not find template file: ' . $mixValue);
284:                             }
285:                         } else {
286:                             $this->strTemplate = null;
287:                         }
288:                         break;
289:                     } catch (QInvalidCastException $objExc) {
290:                         $objExc->IncrementOffset();
291:                         throw $objExc;
292:                     }
293: 
294:                 case "AutoRenderChildren":
295:                     try {
296:                         if ($this->blnAutoRenderChildren !== ($mixValue = QType::Cast($mixValue, QType::Boolean))) {
297:                             $this->blnModified = true;
298:                             $this->blnAutoRenderChildren = $mixValue;
299:                         }
300:                         break;
301:                     } catch (QInvalidCastException $objExc) {
302:                         $objExc->IncrementOffset();
303:                         throw $objExc;
304:                     }
305: 
306:                 case "TagName":
307:                     try {
308:                         if ($this->strTagName !== ($mixValue = QType::Cast($mixValue, QType::String))) {
309:                             $this->blnModified = true;
310:                             $this->strTagName = $mixValue;
311:                         }
312:                         break;
313:                     } catch (QInvalidCastException $objExc) {
314:                         $objExc->IncrementOffset();
315:                         throw $objExc;
316:                     }
317: 
318:                 case "HtmlEntities":
319:                     try {
320:                         if ($this->blnHtmlEntities !== ($mixValue = QType::Cast($mixValue, QType::Boolean))) {
321:                             $this->blnModified = true;
322:                             $this->blnHtmlEntities = $mixValue;
323:                         }
324:                         break;
325:                     } catch (QInvalidCastException $objExc) {
326:                         $objExc->IncrementOffset();
327:                         throw $objExc;
328:                     }
329: 
330:                 case "DropTarget":
331:                     try {
332:                         if ($this->blnDropTarget !== ($mixValue = QType::Cast($mixValue, QType::Boolean))) {
333:                             $this->blnModified = true;
334:                             $this->blnDropTarget = $mixValue;
335:                         }
336:                         break;
337:                     } catch (QInvalidCastException $objExc) {
338:                         $objExc->IncrementOffset();
339:                         throw $objExc;
340:                     }
341: 
342: 
343:                 default:
344:                     try {
345:                         parent::__set($strName, $mixValue);
346:                     } catch (QCallerException $objExc) {
347:                         $objExc->IncrementOffset();
348:                         throw $objExc;
349:                     }
350:                     break;
351:             }
352:         }
353: 
354:     }
355: 
356:     $_CONTROL = null;