/
BlockController.php
905 lines (799 loc) · 28.5 KB
/
BlockController.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
<?php
namespace Concrete\Core\Block;
use Concrete\Core\Area\Area;
use Concrete\Core\Backup\ContentExporter;
use Concrete\Core\Backup\ContentImporter;
use Concrete\Core\Entity\Block\BlockType\BlockType;
use Concrete\Core\Block\View\BlockViewTemplate;
use Concrete\Core\File\Tracker\FileTrackableInterface;
use Concrete\Core\Legacy\BlockRecord;
use Concrete\Core\Page\Controller\PageController;
use Concrete\Core\Page\Type\Type;
use Concrete\Core\Permission\Checker;
use Concrete\Core\Statistics\UsageTracker\AggregateTracker;
use Concrete\Core\StyleCustomizer\Inline\StyleSet;
use Config;
use Database;
use Events;
use Package;
use Page;
use Concrete\Core\Error\ErrorList\ErrorList;
class BlockController extends \Concrete\Core\Controller\AbstractController
{
public $headerItems = []; // blockrecord
public $blockViewRenderOverride;
protected $record;
protected $helpers = ['form'];
protected $block;
protected $bID;
protected $btDescription = "";
protected $btName = "";
protected $btHandle = "";
protected $btIsInternal = 0;
protected $btSupportsInlineAdd = false;
protected $btIgnorePageThemeGridFrameworkContainer = false;
protected $btSupportsInlineEdit = false;
protected $btCopyWhenPropagate = 0;
protected $btIncludeAll = 0;
/** @var string | int */
protected $btInterfaceWidth = "400";
/** @var string | int */
protected $btInterfaceHeight = "400";
protected $btHasRendered = false;
protected $btCacheBlockRecord = true;
protected $btCacheBlockOutput = false;
protected $btCacheBlockOutputLifetime = 0;
protected $btCacheBlockOutputOnPost = false;
protected $btCacheBlockOutputForRegisteredUsers = false;
protected $bActionCID;
protected $btExportPageColumns = [];
protected $btExportFileColumns = [];
protected $btExportPageTypeColumns = [];
protected $btExportPageFeedColumns = [];
protected $btExportFileFolderColumns = [];
protected $btWrapperClass = '';
protected $btDefaultSet;
protected $identifier;
/** @var null|string */
protected $btTable = null;
protected $btID;
/**
* @internal
* Note: do not rely on these being here. These are going to be moved.
*/
public static $btTitleFormats = ['h1' => 'H1', 'h2' => 'H2', 'h3' => 'H3', 'h4' => 'H4', 'h5' => 'H5', 'h6' => 'H6', 'p' => 'Normal'];
/**
* Set this to true if the data sent to the save/performSave methods can contain NULL values that should be persisted.
*
* @var bool
*/
protected $supportSavingNullValues = false;
public function getBlockTypeInSetName()
{
return $this->getBlockTypeName();
}
public function getBlockTypeExportPageColumns()
{
return $this->btExportPageColumns;
}
public function getIdentifier()
{
return $this->identifier;
}
public function getBlockTypeWrapperClass()
{
return $this->btWrapperClass;
}
/**
* Installs the current block's DB xml file. If a block needs to do more than this, this should be overridden.
* <code>
* public function install($path) {
* $this->doMySpecialInstallMethod();
* $this->doSecondSpecialInstallMethod();
* parent::install($path);
* }
* </code>.
*
* There are several different possible return values:
* Returns FALSE if $btTable is set but no db.xml file exists.
* Otherwise returns object with two properties: ->result (a boolean), and ->message (a string).
* If ->result is true, the installation was successful
* (although the db.xml file might only have one field declared which will cause C5 to have problems later on, so you you will want to check for that separately).
* If ->result is false, the installation failed and you can check ->message for the explanation
* (usually -- sometimes ->message will be blank, in which case there's either a malformed db.xml file or an "unknown database error").
* See concrete/models/block_types.php::doInstallBlockType() for usage example.
*
* @param string $path
*
* @return mixed boolean or object having ->result (boolean) and ->message (string) properties
*/
public function install($path)
{
// passed path is the path to this block (try saying that ten times fast)
// create the necessary table
if (!$this->btTable) {
$r = new \stdClass();
$r->result = true;
return $r;
}
$ret = Package::installDB($path . '/' . FILENAME_BLOCK_DB);
return $ret;
}
/**
* Renders a view in the block's folder.
* <code>
* public function view() { // The view() method is automatically run when a block is viewed
* $this->render("other_special_view"); // don't use .php
* }
* </code>.
*
* @param string $view
*/
public function render($view)
{
$this->blockViewRenderOverride = $view;
}
/**
* Used to validate a blocks data before saving to the database
* Generally should return an empty ErrorList if valid
* Custom Packages may return a boolean value
*
* @param $args array|string|null
* @version <= 8.4.3 Method returns ErrorList|boolean
* @version 8.5.0a3 Method returns ErrorList
* @return ErrorList|boolean
*/
public function validate($args)
{
$e = $this->app->make(ErrorList::class);
return $e;
}
public function getBlockControllerData()
{
return $this->record;
}
/**
* Persist the block options.
*
* @param array $args An array that contains the block options
* @param bool $loadExisting Shall we initialize the record to be saved with the current data?
*/
protected function performSave($args, $loadExisting = false)
{
//$argsMerged = array_merge($_POST, $args);
if ($this->btTable) {
$db = Database::connection();
$columns = $db->MetaColumnNames($this->btTable);
$this->record = new BlockRecord($this->btTable);
$this->record->bID = $this->bID;
if ($loadExisting) {
$this->record->Load('bID=' . $this->bID);
}
if ($this->supportSavingNullValues) {
foreach ($columns as $key) {
if (array_key_exists($key, $args)) {
$this->record->{$key} = $args[$key];
}
}
} else {
foreach ($columns as $key) {
if (isset($args[$key])) {
$this->record->{$key} = $args[$key];
}
}
}
$this->record->Replace();
if ($this->cacheBlockRecord() && Config::get('concrete.cache.blocks')) {
$record = base64_encode(serialize($this->record));
$db = Database::connection();
$db->Execute('update Blocks set btCachedBlockRecord = ? where bID = ?', [$record, $this->bID]);
}
}
if ($this instanceof FileTrackableInterface) {
$this->app->make(AggregateTracker::class)->track($this);
}
}
/**
* Run when a block is added or edited. Automatically saves block data against the block's database table. If a block needs to do more than this (save to multiple tables, upload files, etc... it should override this.
*
* @param array<string,mixed> $args
* @return void
*/
public function save($args)
{
$this->performSave($args);
}
public function cacheBlockRecord()
{
return $this->btCacheBlockRecord;
}
/**
* @deprecated
*/
public function getPermissionsObject()
{
return $this->getPermissionObject();
}
public function getBlockTypeDefaultSet()
{
return $this->btDefaultSet;
}
/**
* Gets the permissions object for this controller's block.
*/
public function getPermissionObject()
{
$bp = new Permissions(Block::getByID($this->bID));
return $bp;
}
/**
* Automatically run when a block is duplicated. This most likely happens when a block is edited: a block is first duplicated, and then presented to the user to make changes.
*
* @param int $newBlockID
*
* @return BlockRecord | null $newInstance
*/
public function duplicate($newBID)
{
if ($this->btTable) {
$ni = new BlockRecord($this->btTable);
$ni->bID = $this->bID;
$ni->Load('bID=' . $this->bID);
$newInstance = clone $ni;
$newInstance->bID = $newBID;
$newInstance->Insert();
return $newInstance;
}
}
public function __wakeup()
{
$this->__construct();
}
/**
* Instantiates the block controller.
*
* @param BlockType $obj |Block $obj
*/
public function __construct($obj = null)
{
parent::__construct();
if ($obj instanceof BlockType) {
$this->btID = $obj->getBlockTypeID();
$this->identifier = 'BLOCKTYPE_' . $obj->getBlockTypeID();
$this->btHandle = $obj->getBlockTypeHandle();
} else {
if ($obj instanceof Block) {
$b = $obj;
$this->btID = $b->getBlockTypeID();
$this->identifier = 'BLOCK_' . $obj->getBlockID();
$this->bID = $b->getBlockID();
$this->btHandle = $obj->getBlockTypeHandle();
$this->btCachedBlockRecord = $obj->getBlockCachedRecord();
$this->setBlockObject($b);
$this->load();
}
}
$this->set('controller', $this);
}
/**
* Sets the block object for this controller.
*/
public function setBlockObject($b)
{
$this->block = $b;
}
/**
* Loads the BlockRecord class based on its attribute names.
*/
protected function load()
{
if ($this->btTable) {
if ($this->btCacheBlockRecord && $this->btCachedBlockRecord && Config::get('concrete.cache.blocks')) {
$this->record = unserialize(base64_decode($this->btCachedBlockRecord));
} else {
$this->record = new BlockRecord($this->btTable);
$this->record->bID = $this->bID;
$this->record->Load('bID=' . $this->bID);
if ($this->btCacheBlockRecord && Config::get('concrete.cache.blocks')) {
// this is the first time we're loading
$record = base64_encode(serialize($this->record));
$db = Database::connection();
$db->Execute('update Blocks set btCachedBlockRecord = ? where bID = ?', [$record, $this->bID]);
}
}
}
$event = new \Symfony\Component\EventDispatcher\GenericEvent();
$event->setArgument('record', $this->record);
$event->setArgument('btHandle', $this->btHandle);
$event->setArgument('bID', $this->bID);
$ret = Events::dispatch('on_block_load', $event);
$this->record = $ret->getArgument('record');
if (is_object($this->record)) {
foreach ($this->record as $key => $value) {
$this->{$key} = $value;
$this->set($key, $value);
}
}
}
public function export(\SimpleXMLElement $blockNode)
{
$tables[] = $this->getBlockTypeDatabaseTable();
if (isset($this->btExportTables)) {
$tables = $this->btExportTables;
}
$db = Database::connection();
foreach ($tables as $tbl) {
if (!$tbl) {
continue;
}
$data = $blockNode->addChild('data');
$data->addAttribute('table', $tbl);
$columns = $db->MetaColumns($tbl);
// remove columns we don't want
unset($columns['bid']);
$r = $db->Execute('select * from ' . $tbl . ' where bID = ?', [$this->bID]);
while ($record = $r->fetch()) {
$tableRecord = $data->addChild('record');
foreach ($record as $key => $value) {
if (isset($columns[strtolower($key)])) {
if (in_array($key, $this->btExportPageColumns)) {
$tableRecord->addChild($key, ContentExporter::replacePageWithPlaceHolder($value));
} elseif (in_array($key, $this->btExportFileColumns)) {
$tableRecord->addChild($key, ContentExporter::replaceFileWithPlaceHolder($value));
} elseif (in_array($key, $this->btExportPageTypeColumns)) {
$tableRecord->addChild($key, ContentExporter::replacePageTypeWithPlaceHolder($value));
} elseif (in_array($key, $this->btExportPageFeedColumns)) {
$tableRecord->addChild($key, ContentExporter::replacePageFeedWithPlaceHolder($value));
} elseif (in_array($key, $this->btExportFileFolderColumns)) {
$tableRecord->addChild($key, ContentExporter::replaceFileFolderWithPlaceHolder($value));
} else {
$cnode = $tableRecord->addChild($key);
$node = dom_import_simplexml($cnode);
$no = $node->ownerDocument;
$node->appendChild($no->createCDataSection($value));
}
}
}
}
}
}
public function getBlockTypeDatabaseTable()
{
return $this->btTable;
}
public function import($page, $arHandle, \SimpleXMLElement $blockNode)
{
// handle the adodb stuff
$args = $this->getImportData($blockNode, $page);
$blockData = [];
$bt = \Concrete\Core\Block\BlockType\BlockType::getByHandle($this->btHandle);
$b = $page->addBlock($bt, $arHandle, $args);
$bName = (string) $blockNode['name'];
$bFilename = (string) $blockNode['custom-template'];
if ($bName) {
$blockData['bName'] = $bName;
}
if ($bFilename) {
$blockData['bFilename'] = $bFilename;
}
if (count($blockData)) {
$b->updateBlockInformation($blockData);
}
if ($page->isMasterCollection() && $blockNode['mc-block-id'] != '') {
ContentImporter::addMasterCollectionBlockID($b, (string) $blockNode['mc-block-id']);
}
// now we insert stuff that isn't part of the btTable
// we have to do this this way because we need a bID
$this->importAdditionalData($b, $blockNode);
// now we handle container settings
$bCustomContainerSettings = (string) $blockNode['custom-container-settings'];
if ($bCustomContainerSettings === '0' || $bCustomContainerSettings === '1') {
$b->setCustomContainerSettings($bCustomContainerSettings);
}
// now we handle the styles
if (isset($blockNode->style)) {
$set = StyleSet::import($blockNode->style);
$b->setCustomStyleSet($set);
}
// now we handle block caching
$cache = (int) $blockNode['cache-output'];
if ($cache) {
$b->setCustomCacheSettings(true, $blockNode['cache-output-on-post'], $blockNode['cache-output-for-registered-users'],
$blockNode['cache-output-lifetime']);
}
if ($this instanceof FileTrackableInterface) {
$blockController = $b->getController(); // We have to do this because we need it loaded with the right block object, data.
$this->app->make(AggregateTracker::class)->track($blockController);
}
}
/**
* @param \SimpleXMLElement $blockNode
* @param \Concrete\Core\Page\Page $page
* @return array<string,mixed>
*/
protected function getImportData($blockNode, $page)
{
$args = [];
$inspector = \Core::make('import/value_inspector');
if (isset($blockNode->data)) {
foreach ($blockNode->data as $data) {
if ($data['table'] == $this->getBlockTypeDatabaseTable()) {
if (isset($data->record)) {
foreach ($data->record->children() as $node) {
$result = $inspector->inspect((string) $node);
$args[$node->getName()] = $result->getReplacedValue();
}
}
}
}
}
return $args;
}
protected function importAdditionalData($b, $blockNode)
{
$inspector = \Core::make('import/value_inspector');
if (isset($blockNode->data)) {
foreach ($blockNode->data as $data) {
if (strtoupper((string) $data['table']) != strtoupper((string) $this->getBlockTypeDatabaseTable())) {
$table = (string) $data['table'];
if (isset($data->record)) {
foreach ($data->record as $record) {
$aar = new \Concrete\Core\Legacy\BlockRecord($table);
$aar->bID = $b->getBlockID();
foreach ($record->children() as $node) {
$nodeName = $node->getName();
$result = $inspector->inspect((string) $node);
$aar->{$nodeName} = $result->getReplacedValue();
}
$aar->Save();
}
}
}
}
}
}
public function setPassThruBlockController(PageController $controller)
{
$controller->setPassThruBlockController($this->block, $this);
}
public function validateAddBlockPassThruAction(Checker $ap, BlockType $bt)
{
return $ap->canAddBlock($bt);
}
public function validateEditBlockPassThruAction(Block $b)
{
$bp = new \Permissions($b);
return $bp->canEditBlock();
}
public function validateComposerAddBlockPassThruAction(Type $type)
{
$pp = new \Permissions($type);
return $pp->canAddPageType();
}
/**
* @return int|null
*/
public function getBlockTypeID()
{
return $this->btID;
}
public function validateComposerEditBlockPassThruAction(Block $b)
{
return $this->validateEditBlockPassThruAction($b);
}
public function getPassThruActionAndParameters($parameters)
{
$method = 'action_' . $parameters[0];
$parameters = array_slice($parameters, 1);
return [$method, $parameters];
}
/**
* Creates a URL that can be posted or navigated to that, when done so, will automatically run the corresponding method inside the block's controller.
* It can also be used to perform system operations, accordingly to the current action.
*
* @param mixed $task,... The arguments to build the URL (variable number of arguments).
*
* @return \Concrete\Core\Url\UrlImmutable|null Return NULL in case of problems
*/
public function getActionURL($task)
{
try {
if (is_object($this->block)) {
if (is_object($this->block->getProxyBlock())) {
$b = $this->block->getProxyBlock();
} else {
$b = $this->block;
}
$action = $this->getAction();
if ($action === 'view' || strpos($action, 'action_') === 0) {
$c = Page::getCurrentPage();
if (is_object($b) && is_object($c)) {
$arguments = func_get_args();
$arguments[] = $b->getBlockID();
array_unshift($arguments, $c);
return call_user_func_array(array('\URL', 'page'), $arguments);
}
} else {
$c = $this->getCollectionObject();
$arguments = array_merge(array('/ccm/system/block/action/edit',
$c->getCollectionID(),
urlencode($this->getAreaObject()->getAreaHandle()),
$this->block->getBlockID(),
), func_get_args());
return call_user_func_array(array('\URL', 'to'), $arguments);
}
} else {
$c = \Page::getCurrentPage();
$arguments = array_merge(array('/ccm/system/block/action/add',
$c->getCollectionID(),
urlencode($this->getAreaObject()->getAreaHandle()),
$this->getBlockTypeID(),
), func_get_args());
return call_user_func_array(array('\URL', 'to'), $arguments);
}
} catch (\Exception $e) {
}
}
public function isValidControllerTask($method, $parameters = [])
{
if (strpos($method, 'action_') !== 0) { // gotta start with action_
return false;
}
if (is_callable([$this, $method])) {
$r = new \ReflectionMethod(get_class($this), $method);
if (count($parameters) - $r->getNumberOfParameters() <= 1) {
// how do we get <= 1? If it's 1, that means that the method has one fewer param. That's ok because
// certain older blocks don't know that the last param ought to be a $bID. If they're equal it's zero
// which is best. and if they're greater that's ok too.
return true;
}
}
return false;
}
public function cacheBlockOutput()
{
return $this->btCacheBlockOutput;
}
public function cacheBlockOutputForRegisteredUsers()
{
return $this->btCacheBlockOutputForRegisteredUsers;
}
public function cacheBlockOutputOnPost()
{
return $this->btCacheBlockOutputOnPost;
}
public function getBlockTypeCacheOutputLifetime()
{
return $this->btCacheBlockOutputLifetime;
}
public function getCollectionObject()
{
if (!$this->block) {
return false;
}
// This block is new for 9.0.2 – we need this because we're passing around blocks with page objects in them
// for file trackability, but without this code we lose the reference to the proper collection + collection version
$blockPage = $this->block->getBlockCollectionObject();
if ($blockPage) {
return $blockPage;
}
if (!isset($this->bActionCID)) {
$this->bActionCID = $this->block->getBlockActionCollectionID();
}
if ($this->bActionCID > 0) {
return Page::getByID($this->bActionCID);
}
return Page::getCurrentPage();
}
public function field($fieldName)
{
$field = '_bf[' . $this->identifier;
$b = $this->getBlockObject();
if (is_object($b)) {
$xc = $b->getBlockCollectionObject();
if (is_object($xc)) {
$field .= '_' . $xc->getCollectionID();
}
}
$field .= '][' . $fieldName . ']';
return $field;
}
/**
* Gets the generic Block object attached to this controller's instance.
*
* @return Block $b
*/
public function getBlockObject()
{
if (is_object($this->block)) {
return $this->block;
}
return Block::getByID($this->bID);
}
public function post($field = false, $defaultValue = null)
{
// the only post that matters is the one for this attribute's name space
$req = ($this->requestArray == false) ? $_POST : $this->requestArray;
if (is_array($req['_bf'])) {
$identifier = $this->identifier;
$b = $this->getBlockObject();
if (is_object($b)) {
$xc = $b->getBlockCollectionObject();
if (is_object($xc)) {
$identifier .= '_' . $xc->getCollectionID();
}
}
$p = $req['_bf'][$identifier];
if ($field) {
return $p[$field];
}
return $p;
}
return parent::post($field, $defaultValue);
}
/**
* Automatically run when a block is deleted. This removes the special data from the block's specific database table. If a block needs to do more than this this method should be overridden.
*
* @return void
*/
public function delete()
{
if ($this->bID > 0) {
if ($this->btTable) {
$ni = new BlockRecord($this->btTable);
$ni->bID = $this->bID;
$ni->Load('bID=' . $this->bID);
$ni->delete();
}
}
if ($this instanceof FileTrackableInterface) {
$this->app->make(AggregateTracker::class)->forget($this);
}
}
public function outputAutoHeaderItems()
{
$b = $this->getBlockObject();
if (is_object($b)) {
$bvt = new BlockViewTemplate($b);
$bvt->registerTemplateAssets();
}
}
public function registerViewAssets($outputContent = '')
{
}
public function setupAndRun($method)
{
if ($method) {
$this->task = $method;
}
if (method_exists($this, 'on_start')) {
$this->on_start($method);
}
if ($method) {
$this->runTask($method, []);
}
if (method_exists($this, 'on_before_render')) {
$this->on_before_render($method);
}
}
/**
* Gets the Area object attached to this controller's instance.
*
* @return Area $a
*/
public function getAreaObject()
{
return $this->area;
}
public function setAreaObject($a)
{
$this->area = $a;
}
/**
* @todo Make block's uninstallable
*/
public function uninstall()
{
// currently blocks cannot be uninstalled
}
/**
* Returns the name of the block type.
*
* @return string $btName
*/
public function getBlockTypeName()
{
return t($this->btName);
}
/**
* Returns the width of the block type's interface when presented in page.
*
* @return int
*/
public function getInterfaceWidth()
{
return $this->btInterfaceWidth;
}
/**
* Returns the height of the block type's interface when presented in page.
*
* @return int
*/
public function getInterfaceHeight()
{
return $this->btInterfaceHeight;
}
/**
* Returns the description of the block type.
*
* @return string
*/
public function getBlockTypeDescription()
{
return t($this->btDescription);
}
/**
* Returns HTML that will be shown when a user wants help for a given block type.
*/
public function getBlockTypeHelp()
{
return isset($this->btHelpContent) ? $this->btHelpContent : null;
}
public function isCopiedWhenPropagated()
{
return $this->btCopyWhenPropagate;
}
/**
* Returns whether this block type is included in all versions. Default is false - block types are typically versioned but sometimes it makes sense not to do so.
*
* @return bool
*/
public function includeAll()
{
return $this->btIncludeAll;
}
/**
* Returns whether this block type is internal to Concrete. If it's internal it's not displayed in the front end interface. Examples include the LibraryFile block.
*
* @return bool
*/
public function isBlockTypeInternal()
{
return $this->btIsInternal;
}
/**
* if a the current BlockType supports inline edit or not.
*
* @return bool
*/
public function supportsInlineEdit()
{
return $this->btSupportsInlineEdit;
}
/**
* if a the current BlockType supports inline add or not.
*
* @return bool
*/
public function supportsInlineAdd()
{
return $this->btSupportsInlineAdd;
}
/**
* If true, container classes will not be wrapped around this block type in edit mode (if the
* theme in question supports a grid framework.
*
* @return bool
*/
public function ignorePageThemeGridFrameworkContainer()
{
return $this->btIgnorePageThemeGridFrameworkContainer;
}
/**
* Returns a key/value array of strings that is used to translate items when used in javascript.
*/
public function getJavaScriptStrings()
{
return [];
}
}