| 1 |
<?php |
| 2 |
/** |
| 3 |
* @version $ Id; blocks.php 21-03-2012 03:22:10 Ahmed Said $ |
| 4 |
*/ |
| 5 |
|
| 6 |
/** |
| 7 |
* No direct access. |
| 8 |
*/ |
| 9 |
defined('ABSPATH') or die("Access denied"); |
| 10 |
|
| 11 |
// Blocks Database tables. |
| 12 |
require_once CJTOOLBOX_TABLES_PATH . '/blocks.php'; |
| 13 |
require_once CJTOOLBOX_TABLES_PATH . '/block-pins.php'; |
| 14 |
// MYSQL Queue Driver. |
| 15 |
require_once CJTOOLBOX_INCLUDE_PATH . '/db/mysql/queue-driver.inc.php'; |
| 16 |
|
| 17 |
/** |
| 18 |
* Provide simple access (read or write) to all Blocks data. |
| 19 |
* |
| 20 |
* @author Ahmed Said |
| 21 |
* @version 6 |
| 22 |
*/ |
| 23 |
class CJTBlocksModel { |
| 24 |
|
| 25 |
/** |
| 26 |
* |
| 27 |
*/ |
| 28 |
const MAX_REVISIONS_PER_BLOCK = 10; |
| 29 |
|
| 30 |
/** |
| 31 |
* put your comment there... |
| 32 |
* |
| 33 |
* @var mixed |
| 34 |
*/ |
| 35 |
protected $dbDriver = null; |
| 36 |
|
| 37 |
/** |
| 38 |
* put your comment there... |
| 39 |
* |
| 40 |
*/ |
| 41 |
public function __construct() { |
| 42 |
// Initialize CTTTable MYSQL Driver. |
| 43 |
$this->dbDriver = new CJTMYSQLQueueDriver($GLOBALS['wpdb']); |
| 44 |
} |
| 45 |
|
| 46 |
/** |
| 47 |
* put your comment there... |
| 48 |
* |
| 49 |
* @param mixed $block |
| 50 |
* @param mixed $forceAddCodeBlock |
| 51 |
*/ |
| 52 |
public function add($block, $forceAddCodeBlock = false) { |
| 53 |
// Make sure it array and not stdClass as it has been used from various areas! |
| 54 |
$block = (array) $block; |
| 55 |
// Create Tables objects. |
| 56 |
$blocks = new CJTBlocksTable($this->dbDriver); |
| 57 |
$codeFile = new CJTBlockFilesTable($this->dbDriver); |
| 58 |
// Get new id if not specified. |
| 59 |
if (!isset($block['id']) || !$block['id']) { |
| 60 |
$block['id'] = $blocks->getNextId(); |
| 61 |
} |
| 62 |
// Backward compatibility for old block style |
| 63 |
// that has code field inside blocks table. |
| 64 |
/// if passed create master code file for the code field. |
| 65 |
if ($forceAddCodeBlock || isset($block['code'])) { |
| 66 |
// Cache code for MASTER file. |
| 67 |
$codeFile->set('code', $block['code']); |
| 68 |
unset($block['code']); // If it passed it mist be removed from blocks data(avoid field not found) |
| 69 |
// Add code files. |
| 70 |
$codeFile->set('blockId', $block['id']) |
| 71 |
->set('id', 1) |
| 72 |
->set('name', 'Master') |
| 73 |
->save(true, true); |
| 74 |
} |
| 75 |
// Add new block. |
| 76 |
$blocks->insert($block); |
| 77 |
// Return Newly added block id. |
| 78 |
return $block['id']; |
| 79 |
} |
| 80 |
|
| 81 |
/** |
| 82 |
* put your comment there... |
| 83 |
* |
| 84 |
* @param mixed $blockId |
| 85 |
* @param mixed $activeFileId |
| 86 |
*/ |
| 87 |
public function addRevision($blockId, $activeFileId) { |
| 88 |
// Create Tables objects. |
| 89 |
$blocks = new CJTBlocksTable($this->dbDriver); |
| 90 |
$pins = new CJTBlockPinsTable($this->dbDriver); |
| 91 |
$codeFile = new CJTBlockFilesTable($this->dbDriver); |
| 92 |
// We allow only up to self::MAX_REVISIONS_PER_BLOCK revisions per |
| 93 |
// block code files So that a single block may has up to |
| 94 |
// self::MAX_REVISIONS_PER_BLOCK * count(codeFiles) |
| 95 |
$revisions['fields'] = array('id'); |
| 96 |
$revisions['filters'] = array('type' => 'revision', 'parent' => $blockId, 'masterFile' => $activeFileId); |
| 97 |
$revisions = $blocks->get(null, $revisions['fields'], $revisions['filters']); |
| 98 |
// If revisions reached self::MAX_REVISIONS_PER_BLOCK delete first one. |
| 99 |
if (count($revisions) == self::MAX_REVISIONS_PER_BLOCK) { |
| 100 |
$this->delete(array_shift($revisions)->id); |
| 101 |
} |
| 102 |
// Get block data. |
| 103 |
$block['fields'] = array('id', 'lastModified', 'pinPoint', 'links', 'expressions'); |
| 104 |
// get() developed to return multiple blocks, fetch the first. |
| 105 |
$result = $blocks->get($blockId, $block['fields']); |
| 106 |
$block = reset($result); |
| 107 |
// Set other fields. |
| 108 |
$block->location = $block->state = ''; |
| 109 |
$block->parent = $blockId; |
| 110 |
$block->type = 'revision'; |
| 111 |
$block->created = current_time('mysql'); |
| 112 |
$block->owner = get_current_user_id(); |
| 113 |
$block->masterFile = $activeFileId; // Only the revisioned code file would be exists and must be |
| 114 |
// used as the masterFile! |
| 115 |
$block->id = $blocks->getNextId(); // Get new id for revision rrecord. |
| 116 |
// Add block data. |
| 117 |
$blocks->insert($block); |
| 118 |
// Get block pins and insert pins for the revision block. |
| 119 |
$blockPins = $pins->get($blockId); |
| 120 |
if (!empty($blockPins)) { |
| 121 |
$pins->insertRaw($block->id, $blockPins); |
| 122 |
} |
| 123 |
// Revision current ActiveFileId code record. |
| 124 |
// Simply, get a copy of it from the target block |
| 125 |
// and assign the copy to the new created block revision. |
| 126 |
$codeFile->set('id', $activeFileId) |
| 127 |
->set('blockId', $blockId) |
| 128 |
->load() |
| 129 |
->set('blockId', $block->id) |
| 130 |
->save(true, true); |
| 131 |
} |
| 132 |
|
| 133 |
/** |
| 134 |
* Put your comments here... |
| 135 |
* |
| 136 |
* |
| 137 |
* @return |
| 138 |
*/ |
| 139 |
public function dbDriver() { |
| 140 |
return $this->dbDriver; |
| 141 |
} |
| 142 |
|
| 143 |
/** |
| 144 |
* put your comment there... |
| 145 |
* |
| 146 |
* @param mixed $ids |
| 147 |
*/ |
| 148 |
public function delete($ids) { |
| 149 |
// Allow single or multiple Ids to be passed. |
| 150 |
if (!is_array($ids)) { |
| 151 |
$ids = array($ids); |
| 152 |
} |
| 153 |
// Create Tables objects. |
| 154 |
$blocks = new CJTBlocksTable($this->dbDriver); |
| 155 |
$pins = new CJTBlockPinsTable($this->dbDriver); |
| 156 |
$codeFile = new CJTBlockFilesTable($this->dbDriver); |
| 157 |
// Get blocks revisions. |
| 158 |
$revisions['fields'] = array('id'); |
| 159 |
$revisions['filters']['parent'] = $ids; |
| 160 |
$revisions['type'] = 'revision'; |
| 161 |
$revisions['result'] = $blocks->get(null, $revisions['fields'], $revisions['filters']); |
| 162 |
// Revisions ids used as revision key. |
| 163 |
$revisions = array_keys($revisions['result']); |
| 164 |
// Delete all revisions for all "DELETED" blocks |
| 165 |
// only if there is at least one revision. |
| 166 |
if (!empty($revisions)) { |
| 167 |
$blocks->delete($revisions); |
| 168 |
$pins->delete($revisions); |
| 169 |
// Delete code files. |
| 170 |
$this->dbDriver->delete(sprintf('DELETE FROM #__cjtoolbox_block_files WHERE blockId IN(%s)', implode(',', $revisions))); |
| 171 |
} |
| 172 |
// Delete linked templates. |
| 173 |
$linkedOnlyTemplatesQuery = 'DELETE FROM #__cjtoolbox_block_templates WHERE blockId IN(%s)'; |
| 174 |
$this->dbDriver->delete(sprintf($linkedOnlyTemplatesQuery, implode(',', $ids))); |
| 175 |
// Delete associated parameters. |
| 176 |
$mdlParams = new CJT_Models_Parameters(); |
| 177 |
$mdlParams->delete($ids); |
| 178 |
// Delete form. |
| 179 |
$mdlForm = new CJT_Models_Forms(); |
| 180 |
$mdlForm->delete($ids); |
| 181 |
// Delete blocks. |
| 182 |
$blocks->delete($ids); |
| 183 |
$pins->delete($ids); |
| 184 |
// Delete code files. |
| 185 |
$this->dbDriver->delete(sprintf('DELETE FROM #__cjtoolbox_block_files WHERE blockId IN(%s)', implode(',', $ids))); |
| 186 |
// Chaining! |
| 187 |
return $this; |
| 188 |
} |
| 189 |
|
| 190 |
/** |
| 191 |
* put your comment there... |
| 192 |
* |
| 193 |
* @param mixed $id |
| 194 |
* @param mixed $fields |
| 195 |
*/ |
| 196 |
public function getBlock($id, $filters = array(), $fields = array('*'), $useDefaultBackupFltr = true) { |
| 197 |
$blocks = $this->getBlocks($id, $filters, $fields, OBJECT_K, array(), $useDefaultBackupFltr); |
| 198 |
$block = !empty($blocks) ? reset($blocks) : null; |
| 199 |
return $block; |
| 200 |
} |
| 201 |
|
| 202 |
/** |
| 203 |
* put your comment there... |
| 204 |
* |
| 205 |
* @param mixed $ids |
| 206 |
*/ |
| 207 |
public function getBlocks($ids = array(), $filters = array(), $fields = array('*'), $returnType = OBJECT_K, $orderBy = array(), $useDefaultBackupFltr = true) { |
| 208 |
// initialize. |
| 209 |
$blocks = array(); |
| 210 |
$returnCodeFile = isset($filters['returnCodeFile']) && ($filters['returnCodeFile'] == true); |
| 211 |
unset($filters['returnCodeFile']); |
| 212 |
// Create Tables objects. |
| 213 |
$blocksTable = new CJTBlocksTable($this->dbDriver); |
| 214 |
$pinsTable = new CJTBlockPinsTable($this->dbDriver); |
| 215 |
$blockFiles = new CJTBlockFilesTable($this->dbDriver); |
| 216 |
// Read blocks. |
| 217 |
$blocks = $blocksTable->get($ids, $fields, $filters, $returnType, $orderBy, $useDefaultBackupFltr); |
| 218 |
// Get only pins for retrieved blocks. |
| 219 |
$ids = array_keys($blocks); |
| 220 |
$pins = empty($ids) ? array() : $pinsTable->get($ids); |
| 221 |
// Push pins into blocks. |
| 222 |
foreach ($pins as $pin) { |
| 223 |
// Use pin name as object member. |
| 224 |
// Each pin is an array. |
| 225 |
// e.g blocks[ID]->pages[] = PAGE-ID. |
| 226 |
$blocks[$pin->blockId]->{$pin->pin}[] = $pin->value; |
| 227 |
} |
| 228 |
// Get active file code. |
| 229 |
// There always should be active file unless that the |
| 230 |
// requested block is never switched by current author before. |
| 231 |
// However we'll do that only if filters['returnCodeFile'] set to TRUE. |
| 232 |
if ($returnCodeFile) { |
| 233 |
foreach ($ids as $id) { |
| 234 |
if(!$activeFileId = $this->getCurrentAuthorBlockActiveFileId($id)) { |
| 235 |
// If first time use masterFile ID as he default. |
| 236 |
$activeFileId = $blocks[$id]->masterFile; |
| 237 |
} |
| 238 |
// Retreive code for block code file. |
| 239 |
$codeFile = (array) $blockFiles->setData(array('blockId' => $id, 'id' => $activeFileId)) |
| 240 |
->load() |
| 241 |
->getData(); |
| 242 |
unset($codeFile['description']); |
| 243 |
$blocks[$id]->file = (object) $codeFile; |
| 244 |
// Also return the active file id withing the set. |
| 245 |
$blocks[$id]->activeFileId = $activeFileId; |
| 246 |
} |
| 247 |
} |
| 248 |
return $blocks; |
| 249 |
} |
| 250 |
|
| 251 |
/** |
| 252 |
* put your comment there... |
| 253 |
* |
| 254 |
* @param mixed $blockId |
| 255 |
* @param mixed $authorId |
| 256 |
*/ |
| 257 |
public function getAuthorBlockActiveFileId($blockId, $authorId = null) { |
| 258 |
// Get author active file for the requested block. |
| 259 |
$activeFileId = (int) get_user_meta($authorId, "cjt_block_active_file_{$blockId}", true); |
| 260 |
// Query block active file. |
| 261 |
return $activeFileId; |
| 262 |
} |
| 263 |
|
| 264 |
/** |
| 265 |
* put your comment there... |
| 266 |
* |
| 267 |
* @param mixed $blockId |
| 268 |
* @param mixed $authorId |
| 269 |
*/ |
| 270 |
public function getCurrentAuthorBlockActiveFileId($blockId) { |
| 271 |
return $this->getAuthorBlockActiveFileId($blockId, get_current_user_id()); |
| 272 |
} |
| 273 |
|
| 274 |
/** |
| 275 |
* put your comment there... |
| 276 |
* |
| 277 |
* @param mixed $id |
| 278 |
*/ |
| 279 |
public function getInfo($id) { |
| 280 |
// Info fields. |
| 281 |
$infoFields = array('name', 'id', 'owner', 'created', 'lastModified'); |
| 282 |
// Get info fields from db. |
| 283 |
$blocksTable = new CJTBlocksTable($this->dbDriver); |
| 284 |
$info = $blocksTable->get($id, $infoFields); |
| 285 |
// Get user object from id. |
| 286 |
$info = reset($info); |
| 287 |
$info->owner = get_userdata($info->owner); |
| 288 |
// Set shortcode name. |
| 289 |
$info->shortcode = "[cjtoolbox name='{$info->name}']"; |
| 290 |
return $info; |
| 291 |
} |
| 292 |
|
| 293 |
/** |
| 294 |
* put your comment there... |
| 295 |
* |
| 296 |
*/ |
| 297 |
public function getOrder() { |
| 298 |
return get_option('meta-box-order_cjtoolbox'); |
| 299 |
} |
| 300 |
|
| 301 |
/** |
| 302 |
* put your comment there... |
| 303 |
* |
| 304 |
*/ |
| 305 |
public function save() { |
| 306 |
$this->dbDriver->processQueue(); |
| 307 |
} |
| 308 |
|
| 309 |
/** |
| 310 |
* put your comment there... |
| 311 |
* |
| 312 |
* @param mixed $order |
| 313 |
*/ |
| 314 |
public function setOrder($order) { |
| 315 |
$orderOptionName = 'meta-box-order_cjtoolbox'; |
| 316 |
// Update user order so That jQuery sortable Plugin will display them in correct orders! |
| 317 |
update_user_option(get_current_user_id(), $orderOptionName, $order, true); |
| 318 |
// Update CENTRALIZED order in the options table! |
| 319 |
update_option($orderOptionName, $order); |
| 320 |
} |
| 321 |
|
| 322 |
/** |
| 323 |
* put your comment there... |
| 324 |
* |
| 325 |
* @param mixed $block |
| 326 |
*/ |
| 327 |
public function update($block, $updatePins) { |
| 328 |
// To be used by array_intersect_key. |
| 329 |
$block = (array) $block; |
| 330 |
// Create Tables objects. |
| 331 |
$blocks = new CJTBlocksTable($this->dbDriver); |
| 332 |
$pins = new CJTBlockPinsTable($this->dbDriver); |
| 333 |
// Update block pins if requested. |
| 334 |
if ($updatePins) { |
| 335 |
// Isolate block pins freom native block data. |
| 336 |
$pinsData = array_intersect_key($block, array_flip(array('pages', 'posts', 'categories'))); |
| 337 |
$pins->update($block['id'], $pinsData); |
| 338 |
} |
| 339 |
// Update code file |
| 340 |
if (isset($block['activeFileId'])) { |
| 341 |
$codeFile = new CJTBlockFilesTable($this->dbDriver); |
| 342 |
$codeFile->set('blockId', $block['id']) |
| 343 |
->set('id', $block['activeFileId']) |
| 344 |
->set('code', $block['code']) |
| 345 |
->save(); |
| 346 |
} |
| 347 |
// Isolate block fields. |
| 348 |
$blockData = array_intersect_key($block, $blocks->getFields()); |
| 349 |
$blocks->update($blockData); |
| 350 |
} |
| 351 |
|
| 352 |
} // End class. |
