1: <?php
  2: /*****
  3:  * A QDataGridLegacyColumn that contains checkboxes
  4:  * Inspired by Hunter Jensen's work at <http://www.qcodo.com/forums/topic.php/3267>
  5:  * 
  6:  * @author Ryan Peters
  7:  * @copyright ICOM Productions 2010
  8:  * @license MIT
  9:  * @name QCheckBoxColumn
 10:  */
 11: 
 12: class QCheckBoxLegacyColumn extends QDataGridLegacyColumn
 13: {
 14:     protected $objDataGrid;
 15:     protected $blnHtmlEntities = false;
 16:     protected $chkSelectAll;
 17:     protected $colIndex = -1;
 18:     protected $objCheckboxCallback = null;
 19:     protected $strCheckboxCallbackFunc = null;
 20:     protected $strPrimaryKey = 'Id';
 21: 
 22:     /**
 23:      * Creates a QDataGridLegacyColumn of checkboxes
 24:      *
 25:      * @param string    $strName               The header to give the column, shown as the label for the Select All checkbox
 26:      * @param QDataGridLegacy $dataGrid              The parent DataGrid. This does not add the column to that datagrid
 27:      * @param mixed     $objOverrideParameters Same as QDataGridLegacy
 28:      */
 29:     public function __construct($strName = '', QDataGridLegacy $dataGrid, $objOverrideParameters = null)
 30:     {
 31:         $this->objDataGrid = $dataGrid;
 32:         
 33:         $arrParentArgs = func_get_args();
 34:         
 35:         //change the QDataGridLegacy argument we get, and pass the parent constructor the HTML parameter it expects
 36:         $arrParentArgs[1] = '<?=$_COLUMN->chkSelected_Render($_ITEM) ?>';
 37:         if (version_compare(PHP_VERSION, '5.1.6', '>=')) 
 38:             return call_user_func_array(array($this, 'QDataGridLegacyColumn::__construct'), $arrParentArgs);
 39:         else
 40:         {
 41:             $parent_class=get_parent_class($this);
 42:             return call_user_func_array(array($parent_class, '__construct'), $arrParentArgs);
 43:         }
 44:     }
 45:     
 46:     /**
 47:      * Returns the index of this column in the parent datagrid
 48:      *
 49:      * @return int The index of the column, or -1 if not found
 50:      *
 51:      */
 52:     protected function GetColIndex()
 53:     {
 54:         //cached, to improve performance
 55:         if($this->colIndex == -1)
 56:         {
 57:             $columns = $this->objDataGrid->GetAllColumns();
 58:             foreach($columns as $index=>$col)
 59:                 //=== so that we don't spent CPU time comparing properties, and nesting too deep
 60:                 if($col === $this)
 61:                     $this->colIndex = $index;   
 62:         }
 63:         return $this->colIndex;
 64:     }
 65:     
 66:     
 67:     /**
 68:      * Sets the callback method for when a checkbox is created. Used for initializing the checkbox state
 69:      *
 70:      * @param Object $objParent The object the callback function belongs to
 71:      * @param string $strFuncName The name of the function to call back
 72:      * @return void
 73:      *
 74:      */
 75:     public function SetCheckboxCallback($objParent, $strFuncName)
 76:     {
 77:         $this->objCheckboxCallback = $objParent;
 78:         $this->strCheckboxCallbackFunc = $strFuncName;
 79:     }
 80:     
 81:     // Render the Select All checkbox to be displayed in the datagrid header row
 82:     public function chkSelectAll_Render($blnWithLabel = false) {
 83:         $colIndex = $this->GetColIndex();
 84:         
 85:         $controlId = 'chkSelectAll' . $colIndex . $this->objDataGrid->ControlId ;
 86:         
 87:         $this->chkSelectAll = $this->objDataGrid->GetChildControl($controlId);
 88:         
 89:         if(null === $this->chkSelectAll) {
 90:             
 91:             $this->chkSelectAll = new QCheckBox($this->objDataGrid, $controlId);
 92:             $this->chkSelectAll->Name = QApplication::Translate('Select All');
 93:             
 94:             $colIndex = $this->GetColIndex();
 95:             $strControlIdStart = 'chkSelect' . $colIndex.$this->objDataGrid->ControlId.'n';
 96:             $strControlIdStartLen = strlen($strControlIdStart);
 97:             
 98:             //Since a QDataGridLegacyColumn isn't a control, we can't include external js files, or have EndScripts
 99:             //so we'll just have to include all the code in the onclick itself
100:             //hopefully this won't result in much duplication, since there shouldn't be too many
101:             //of these on a single form
102:             $strJavascript = "var datagrid = document.getElementById('{$this->objDataGrid->ControlId}');var selectAll = document.getElementById('{$this->chkSelectAll->ControlId}');var childInputs = datagrid.getElementsByTagName('input');for(var i = 0; i < childInputs.length; i++){var subid = childInputs[i].id.substring($strControlIdStartLen, 0);if(subid == '$strControlIdStart')childInputs[i].checked = selectAll.checked;}";
103:             
104:             $this->chkSelectAll->AddAction(new QClickEvent(), new QJavaScriptAction($strJavascript));
105:         }
106:         
107:         $strOutput = $this->chkSelectAll->Render(false);
108:         
109:         if ($blnWithLabel) {
110:             $strOutput = QHtml::RenderTag('label', null,  $this->strName . ' ' . $strOutput);
111:         }
112:         
113:         return $strOutput;
114:     }
115:     
116:     public function chkSelected_Render($_ITEM) {
117:         $intId = $_ITEM->{$this->strPrimaryKey};
118:         $colIndex = $this->GetColIndex();
119:         $strControlId = 'chkSelect' . $colIndex . $this->objDataGrid->ControlId . 'n' . $intId;
120:         
121:         //Don't re-render an existing checkbox
122:         $chkSelected = $this->objDataGrid->GetChildControl($strControlId);
123:         if (!$chkSelected) {
124:             $chkSelected = new QCheckBox($this->objDataGrid, $strControlId);
125:             //callback so the creator can set up the checkbox checked state
126:             if(null !== $this->objCheckboxCallback && null !== $this->strCheckboxCallbackFunc)
127:             {
128:                 $funcName = $this->strCheckboxCallbackFunc;
129:                 $this->objCheckboxCallback->$funcName($_ITEM, $chkSelected);
130:             }
131:             
132:             //remember the Item ID this checkbox is for and it's original state
133:             $chkSelected->ActionParameter = $intId.','.($chkSelected->Checked?1:0);
134:         }
135:         return $chkSelected->Render(false);
136:     }
137: 
138:     /**
139:      * Convert a checkbox id to its corresponding item id
140:      *
141:      * @param $strCheckId
142:      *
143:      * @return string
144:      */
145:     public function chkIdToItemId ($strCheckId) {
146:         $colIndex = $this->GetColIndex();
147:         $strControlIdPrefix = 'chkSelect' . $colIndex . $this->objDataGrid->ControlId . 'n';
148:         
149:         $len = strlen ($strControlIdPrefix);
150:         return substr ($strCheckId, $len);
151:     }
152: 
153:     /**
154:      * Returns an array of items for the selected rows, loaded using the specified class's Load($id) method
155:      *
156:      * @param string $strClass   The class name of the object type to return
157:      * @param bool   $blnIndex   Whether to spend extra time indexing the array by Id
158:      * @param null   $objClauses QQClause expression
159:      *
160:      * @return array An array of selected Items
161:      */
162:     public function GetSelectedItems($strClass, $blnIndex = true, $objClauses = null)
163:     {
164:         $itemIds = $this->GetSelectedIds();
165:         
166:         //load these items, using QQ::In so that it's a single DB hit
167:         $idQQNode = QQN::$strClass()->{$this->strPrimaryKey};
168:         $conditions = QQ::In($idQQNode, $itemIds);
169:         $items = call_user_func(array($strClass, 'QueryArray'), $conditions, $objClauses);
170:         
171:         //Use the item's Id as the index, if desired.
172:         if($blnIndex)
173:         {
174:             $newitems = array();
175:             foreach($items as $item)
176:                 $newitems[$item->{$this->strPrimaryKey}] = $item;
177:             return $newitems;
178:         }
179:         
180:         return $items;
181:     }
182:     
183:     /**
184:      * Returns an array of the Ids of the items selected. Note this only includes rendered controls.
185:      *
186:      * @return array An array of selected Ids
187:      *
188:      */
189:     public function GetSelectedIds()
190:     {
191:         //because of formstate, this will even include ones not currently displayed.
192:         $childControls = $this->objDataGrid->GetChildControls();
193:         
194:         $colIndex = $this->GetColIndex();
195:         $strSubId = 'chkSelect' . $colIndex.$this->objDataGrid->ControlId .'n';
196:         
197:         $itemIds = array();
198:         foreach ($childControls as $objControl) {
199:             //if it's a checkbox for this column
200:             if ($objControl instanceof QCheckBox && substr($objControl->ControlId, 0, strlen($strSubId)) == $strSubId) {
201:                 if ($objControl->Checked) {
202:                     $arrParams = explode(',', $objControl->ActionParameter);
203:                     $id = $arrParams[0];
204:                     $itemIds[$id] = $id;
205:                 }
206:             }
207:         }
208:         return $itemIds;
209:     }
210: 
211: 
212:     /**
213:      * Returns an array of changed ids.
214:      *
215:      * @param bool $blnRemember
216:      *
217:      * @return bool[] Key is the object Id, value is the new check state (bln)
218:      */
219:     public function GetChangedIds($blnRemember = false)
220:     {
221:         //because of formstate, this will even include ones not currently displayed.
222:         $childControls = $this->objDataGrid->GetChildControls();
223:         
224:         $colIndex = $this->GetColIndex();
225:         $strSubId = 'chkSelect' . $colIndex.$this->objDataGrid->ControlId .'n';
226:         
227:         $itemIds = array();
228:         foreach ($childControls as $objControl) 
229:         {
230:             //if it's a checkbox for this column
231:             if($objControl instanceof QCheckBox && substr($objControl->ControlId, 0, strlen($strSubId)) == $strSubId)
232:             {
233:                 $arrParams = explode(',',$objControl->ActionParameter);
234:                 $id = $arrParams[0];
235:                 $wasChecked = $arrParams[1] == 1;
236:                 if($wasChecked != $objControl->Checked)
237:                     $itemIds[$id] = $objControl->Checked;
238:                 if($blnRemember)
239:                     $objControl->ActionParameter = $id.','.($objControl->Checked?1:0);
240:             }
241:         }
242:         
243:         return $itemIds;
244:     }
245:     
246:     /**
247:      * Considers the current state to be the new baseline
248:      *
249:      * @return void
250:      *
251:      */
252:     public function AcceptChanges()
253:     {
254:         $this->GetChangedIds(true);
255:     }
256:     
257:     public function SetSelectAllCheckbox($value)
258:     {
259:         $colIndex = $this->GetColIndex();
260:         
261:         $controlId = 'chkSelectAll' . $colIndex.$this->objDataGrid->ControlId ;
262:         $checkbox = $this->objDataGrid->GetChildControl($controlId);
263:         if(null === $checkbox)
264:             throw new exception('Select All Checkbox not found');
265:         $checkbox->Checked = $value;
266:     }
267:     
268:     public function SetCheckbox($itemId, $value)
269:     {
270:         $colIndex = $this->GetColIndex();
271:         $controlId = 'chkSelect' . $colIndex.$this->objDataGrid->ControlId .'n'.$itemId;
272:         $checkbox = $this->objDataGrid->GetChildControl($controlId);
273:         if(null === $checkbox)
274:             return;
275:         $checkbox->Checked = $value;
276:     }
277:     
278:     public function __get($strName) {
279:         switch ($strName) {
280:             case "PrimaryKey": 
281:                 return $this->strPrimaryKey;
282:             default:
283:             try {
284:                 return parent::__get($strName);
285:             } catch (QCallerException $objExc) {
286:                 $objExc->IncrementOffset();
287:                 throw $objExc;
288:             }
289:         }
290:     }
291: 
292:     /**
293:      * Override method to perform a property "Set"
294:      * This will set the property $strName to be $mixValue
295:      *
296:      * @param string $strName  Name of the property to set
297:      * @param string $mixValue New value of the property
298:      *
299:      * @return mixed
300:      * @throws Exception|QCallerException
301:      */
302:     public function __set($strName, $mixValue) {
303:         switch ($strName) {
304:             ///////////////////
305:             // Member Variables
306:             ///////////////////
307:             case 'PrimaryKey':
308:                 /**
309:                  * Sets the value for strPrimaryKey 
310:                  * @param integer $mixValue
311:                  * @return string
312:                  */
313:                 try {
314:                     return ($this->strPrimaryKey = QType::Cast($mixValue, QType::String));
315:                 } catch (QCallerException $objExc) {
316:                     $objExc->IncrementOffset();
317:                     throw $objExc;
318:                 }
319:             default:
320:                 try {
321:                     return parent::__set($strName, $mixValue);
322:                 } catch (QCallerException $objExc) {
323:                     $objExc->IncrementOffset();
324:                     throw $objExc;
325:             }
326:         }
327:     }
328: 
329: }