-
-
Notifications
You must be signed in to change notification settings - Fork 211
/
class.pagemanager.php
974 lines (876 loc) · 31 KB
/
class.pagemanager.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
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
<?php
/**
* @package toolkit
*/
/**
* The `PageManager` class is responsible for providing basic CRUD operations
* for Symphony frontend pages. These pages are stored in the database in
* `tbl_pages` and are resolved to an instance of `FrontendPage` class from a URL.
* Additionally, this manager provides functions to access the Page's types,
* and any linked datasources or events.
*
* @since Symphony 2.3
*/
class PageManager
{
/**
* Given an associative array of data, where the key is the column name
* in `tbl_pages` and the value is the data, this function will create a new
* Page and return a Page ID on success.
*
* @param array $fields
* Associative array of field names => values for the Page
* @throws DatabaseException
* @return integer|boolean
* Returns the Page ID of the created Page on success, false otherwise.
*/
public static function add(array $fields)
{
if (!isset($fields['sortorder'])) {
$fields['sortorder'] = self::fetchNextSortOrder();
}
if (!Symphony::Database()->insert($fields, 'tbl_pages')) {
return false;
}
return Symphony::Database()->getInsertID();
}
/**
* Return a Page title by the handle
*
* @param string $handle
* The handle of the page
* @return integer
* The Page title
*/
public static function fetchTitleFromHandle($handle)
{
return Symphony::Database()->fetchVar('title', 0, sprintf(
"SELECT `title`
FROM `tbl_pages`
WHERE `handle` = '%s'
LIMIT 1",
Symphony::Database()->cleanValue($handle)
));
}
/**
* Return a Page ID by the handle
*
* @param string $handle
* The handle of the page
* @return integer
* The Page ID
*/
public static function fetchIDFromHandle($handle)
{
return Symphony::Database()->fetchVar('id', 0, sprintf(
"SELECT `id`
FROM `tbl_pages`
WHERE `handle` = '%s'
LIMIT 1",
Symphony::Database()->cleanValue($handle)
));
}
/**
* Given a Page ID and an array of types, this function will add Page types
* to that Page. If a Page types are stored in `tbl_pages_types`.
*
* @param integer $page_id
* The Page ID to add the Types to
* @param array $types
* An array of page types
* @throws DatabaseException
* @return boolean
*/
public static function addPageTypesToPage($page_id = null, array $types)
{
if (is_null($page_id)) {
return false;
}
PageManager::deletePageTypes($page_id);
foreach ($types as $type) {
Symphony::Database()->insert(
array(
'page_id' => $page_id,
'type' => $type
),
'tbl_pages_types'
);
}
return true;
}
/**
* Returns the path to the page-template by looking at the
* `WORKSPACE/template/` directory, then at the `TEMPLATES`
* directory for `$name.xsl`. If the template is not found,
* false is returned
*
* @param string $name
* Name of the template
* @return mixed
* String, which is the path to the template if the template is found,
* false otherwise
*/
public static function getTemplate($name)
{
$format = '%s/%s.xsl';
if (file_exists($template = sprintf($format, WORKSPACE . '/template', $name))) {
return $template;
} elseif (file_exists($template = sprintf($format, TEMPLATE, $name))) {
return $template;
} else {
return false;
}
}
/**
* This function creates the initial `.xsl` template for the page, whether
* that be from the `TEMPLATES/blueprints.page.xsl` file, or from an existing
* template with the same name. This function will handle the renaming of a page
* by creating the new files using the old files as the templates then removing
* the old template. If a template already exists for a Page, it will not
* be overridden and the function will return true.
*
* @see toolkit.PageManager#resolvePageFileLocation()
* @see toolkit.PageManager#createHandle()
* @param string $new_path
* The path of the Page, which is the handles of the Page parents. If the
* page has multiple parents, they will be separated by a forward slash.
* eg. article/read. If a page has no parents, this parameter should be null.
* @param string $new_handle
* The new Page handle, generated using `PageManager::createHandle`.
* @param string $old_path (optional)
* This parameter is only required when renaming a Page. It should be the 'old
* path' before the Page was renamed.
* @param string $old_handle (optional)
* This parameter is only required when renaming a Page. It should be the 'old
* handle' before the Page was renamed.
* @throws Exception
* @return boolean
* True when the page files have been created successfully, false otherwise.
*/
public static function createPageFiles($new_path, $new_handle, $old_path = null, $old_handle = null)
{
$new = PageManager::resolvePageFileLocation($new_path, $new_handle);
$old = PageManager::resolvePageFileLocation($old_path, $old_handle);
// Nothing to do:
if (file_exists($new) && $new == $old) {
return true;
}
// Old file doesn't exist, use template:
if (!file_exists($old)) {
$data = file_get_contents(self::getTemplate('blueprints.page'));
} else {
$data = file_get_contents($old);
}
/**
* Just before a Page Template is about to be created & written to disk
*
* @delegate PageTemplatePreCreate
* @since Symphony 2.2.2
* @param string $context
* '/blueprints/pages/'
* @param string $file
* The path to the Page Template file
* @param string $contents
* The contents of the `$data`, passed by reference
*/
Symphony::ExtensionManager()->notifyMembers('PageTemplatePreCreate', '/blueprints/pages/', array('file' => $new, 'contents' => &$data));
if (PageManager::writePageFiles($new, $data)) {
// Remove the old file, in the case of a rename
if (file_exists($old)) {
General::deleteFile($old);
}
/**
* Just after a Page Template is saved after been created.
*
* @delegate PageTemplatePostCreate
* @since Symphony 2.2.2
* @param string $context
* '/blueprints/pages/'
* @param string $file
* The path to the Page Template file
*/
Symphony::ExtensionManager()->notifyMembers('PageTemplatePostCreate', '/blueprints/pages/', array('file' => $new));
return true;
}
return false;
}
/**
* A wrapper for `General::writeFile`, this function takes a `$path`
* and a `$data` and writes the new template to disk.
*
* @param string $path
* The path to write the template to
* @param string $data
* The contents of the template
* @return boolean
* True when written successfully, false otherwise
*/
public static function writePageFiles($path, $data)
{
return General::writeFile($path, $data, Symphony::Configuration()->get('write_mode', 'file'));
}
/**
* This function will update a Page in `tbl_pages` given a `$page_id`
* and an associative array of `$fields`. A third parameter, `$delete_types`
* will also delete the Page's associated Page Types if passed true.
*
* @see toolkit.PageManager#addPageTypesToPage()
* @param integer $page_id
* The ID of the Page that should be updated
* @param array $fields
* Associative array of field names => values for the Page.
* This array does need to contain every value for the Page, it
* can just be the changed values.
* @param boolean $delete_types
* If true, this parameter will cause the Page Types of the Page to
* be deleted. By default this is false.
* @return boolean
*/
public static function edit($page_id, array $fields, $delete_types = false)
{
if (!is_numeric($page_id)) {
return false;
}
if (isset($fields['id'])) {
unset($fields['id']);
}
if (Symphony::Database()->update($fields, 'tbl_pages', sprintf("`id` = %d", $page_id))) {
// If set, this will clear the page's types.
if ($delete_types) {
PageManager::deletePageTypes($page_id);
}
return true;
} else {
return false;
}
}
/**
* This function will update all children of a particular page (if any)
* by renaming/moving all related files to their new path and updating
* their database information. This is a recursive function and will work
* to any depth.
*
* @param integer $page_id
* The ID of the Page whose children need to be updated
* @param string $page_path
* The path of the Page, which is the handles of the Page parents. If the
* page has multiple parents, they will be separated by a forward slash.
* eg. article/read. If a page has no parents, this parameter should be null.
* @throws Exception
* @return boolean
*/
public static function editPageChildren($page_id = null, $page_path = null)
{
if (!is_int($page_id)) {
return false;
}
$page_path = trim($page_path, '/');
$children = PageManager::fetchChildPages($page_id);
foreach ($children as $child) {
$child_id = (int)$child['id'];
$fields = array(
'path' => $page_path
);
if (!PageManager::createPageFiles($page_path, $child['handle'], $child['path'], $child['handle'])) {
$success = false;
}
if (!PageManager::edit($child_id, $fields)) {
$success = false;
}
$success = PageManager::editPageChildren($child_id, $page_path . '/' . $child['handle']);
}
return $success;
}
/**
* This function takes a Page ID and removes the Page from the database
* in `tbl_pages` and it's associated Page Types in `tbl_pages_types`.
* This function does not delete any of the Page's children.
*
* @see toolkit.PageManager#deletePageTypes
* @see toolkit.PageManager#deletePageFiles
* @param integer $page_id
* The ID of the Page that should be deleted.
* @param boolean $delete_files
* If true, this parameter will remove the Page's templates from the
* the filesystem. By default this is true.
* @throws DatabaseException
* @throws Exception
* @return boolean
*/
public static function delete($page_id = null, $delete_files = true)
{
if (!is_int($page_id)) {
return false;
}
$can_proceed = true;
// Delete Files (if told to)
if ($delete_files) {
$page = PageManager::fetchPageByID($page_id, array('path', 'handle'));
if (empty($page)) {
return false;
}
$can_proceed = PageManager::deletePageFiles($page['path'], $page['handle']);
}
// Delete from tbl_pages/tbl_page_types
if ($can_proceed) {
PageManager::deletePageTypes($page_id);
Symphony::Database()->delete('tbl_pages', sprintf(" `id` = %d ", $page_id));
Symphony::Database()->query(sprintf(
"UPDATE
tbl_pages
SET
`sortorder` = (`sortorder` + 1)
WHERE
`sortorder` < %d",
$page_id
));
}
return $can_proceed;
}
/**
* Given a `$page_id`, this function will remove all associated
* Page Types from `tbl_pages_types`.
*
* @param integer $page_id
* The ID of the Page that should be deleted.
* @throws DatabaseException
* @return boolean
*/
public static function deletePageTypes($page_id = null)
{
if (is_null($page_id)) {
return false;
}
return Symphony::Database()->delete('tbl_pages_types', sprintf(" `page_id` = %d ", $page_id));
}
/**
* Given a Page's `$path` and `$handle`, this function will remove
* it's templates from the `PAGES` directory returning boolean on
* completion
*
* @param string $page_path
* The path of the Page, which is the handles of the Page parents. If the
* page has multiple parents, they will be separated by a forward slash.
* eg. article/read. If a page has no parents, this parameter should be null.
* @param string $handle
* A Page handle, generated using `PageManager::createHandle`.
* @throws Exception
* @return boolean
*/
public static function deletePageFiles($page_path, $handle)
{
$file = PageManager::resolvePageFileLocation($page_path, $handle);
// Nothing to do:
if (!file_exists($file)) {
return true;
}
// Delete it:
if (General::deleteFile($file)) {
return true;
}
return false;
}
/**
* This function will return an associative array of Page information. The
* information returned is defined by the `$include_types` and `$select`
* parameters, which will return the Page Types for the Page and allow
* a developer to restrict what information is returned about the Page.
* Optionally, `$where` and `$order_by` parameters allow a developer to
* further refine their query.
*
* @param boolean $include_types
* Whether to include the resulting Page's Page Types in the return array,
* under the key `type`. Defaults to true.
* @param array $select (optional)
* Accepts an array of columns to return from `tbl_pages`. If omitted,
* all columns from the table will be returned.
* @param array $where (optional)
* Accepts an array of WHERE statements that will be appended with AND.
* If omitted, all pages will be returned.
* @param string $order_by (optional)
* Allows a developer to return the Pages in a particular order. The string
* passed will be appended to `ORDER BY`. If omitted this will return
* Pages ordered by `sortorder`.
* @param boolean $hierarchical (optional)
* If true, builds a multidimensional array representing the pages hierarchy.
* Defaults to false.
* @return array|null
* An associative array of Page information with the key being the column
* name from `tbl_pages` and the value being the data. If requested, the array
* can be made multidimensional to reflect the pages hierarchy. If no Pages are
* found, null is returned.
*/
public static function fetch($include_types = true, array $select = array(), array $where = array(), $order_by = null, $hierarchical = false)
{
if ($hierarchical) {
$select = array_merge($select, array('id', 'parent'));
}
if (empty($select)) {
$select = array('*');
}
if (is_null($order_by)) {
$order_by = 'sortorder ASC';
}
$pages = Symphony::Database()->fetch(sprintf(
"SELECT
%s
FROM
`tbl_pages` AS p
WHERE
%s
ORDER BY
%s",
implode(',', $select),
empty($where) ? '1' : implode(' AND ', $where),
$order_by
));
// Fetch the Page Types for each page, if required
if ($include_types) {
foreach ($pages as &$page) {
$page['type'] = PageManager::fetchPageTypes($page['id']);
}
}
if ($hierarchical) {
$output = array();
self::__buildTreeView(null, $pages, $output);
$pages = $output;
}
return !empty($pages) ? $pages : array();
}
private function __buildTreeView($parent_id, $pages, &$results)
{
if (!is_array($pages)) {
return;
}
foreach ($pages as $page) {
if ($page['parent'] == $parent_id) {
$results[] = $page;
self::__buildTreeView($page['id'], $pages, $results[count($results) - 1]['children']);
}
}
}
/**
* Returns Pages that match the given `$page_id`. Developers can optionally
* choose to specify what Page information is returned using the `$select`
* parameter.
*
* @param integer|array $page_id
* The ID of the Page, or an array of ID's
* @param array $select (optional)
* Accepts an array of columns to return from `tbl_pages`. If omitted,
* all columns from the table will be returned.
* @return array|null
* An associative array of Page information with the key being the column
* name from `tbl_pages` and the value being the data. If multiple Pages
* are found, an array of Pages will be returned. If no Pages are found
* null is returned.
*/
public static function fetchPageByID($page_id = null, array $select = array())
{
if (is_null($page_id)) {
return null;
}
if (!is_array($page_id)) {
$page_id = array(
Symphony::Database()->cleanValue($page_id)
);
}
if (empty($select)) {
$select = array('*');
}
$page = PageManager::fetch(true, $select, array(
sprintf("id IN (%s)", implode(',', $page_id))
));
return count($page) == 1 ? array_pop($page) : $page;
}
/**
* Returns Pages that match the given `$type`. If no `$type` is provided
* the function returns the result of `PageManager::fetch`.
*
* @param string $type
* Where the type is one of the available Page Types.
* @return array|null
* An associative array of Page information with the key being the column
* name from `tbl_pages` and the value being the data. If multiple Pages
* are found, an array of Pages will be returned. If no Pages are found
* null is returned.
*/
public static function fetchPageByType($type = null)
{
if (is_null($type)) {
return PageManager::fetch();
}
$pages = Symphony::Database()->fetch(sprintf(
"SELECT
`p`.*
FROM
`tbl_pages` AS `p`
LEFT JOIN
`tbl_pages_types` AS `pt` ON (p.id = pt.page_id)
WHERE
`pt`.type = '%s'",
Symphony::Database()->cleanValue($type)
));
return count($pages) == 1 ? array_pop($pages) : $pages;
}
/**
* Returns the child Pages (if any) of the given `$page_id`.
*
* @param integer $page_id
* The ID of the Page.
* @param array $select (optional)
* Accepts an array of columns to return from `tbl_pages`. If omitted,
* all columns from the table will be returned.
* @return array|null
* An associative array of Page information with the key being the column
* name from `tbl_pages` and the value being the data. If multiple Pages
* are found, an array of Pages will be returned. If no Pages are found
* null is returned.
*/
public static function fetchChildPages($page_id = null, array $select = array())
{
if (is_null($page_id)) {
return null;
}
if (empty($select)) {
$select = array('*');
}
return PageManager::fetch(false, $select, array(
sprintf('id != %d', $page_id),
sprintf('parent = %d', $page_id)
));
}
/**
* This function returns a Page's Page Types. If the `$page_id`
* parameter is given, the types returned will be for that Page.
*
* @param integer $page_id
* The ID of the Page.
* @return array
* An array of the Page Types
*/
public static function fetchPageTypes($page_id = null)
{
return Symphony::Database()->fetchCol('type', sprintf(
"SELECT
type
FROM
`tbl_pages_types` AS pt
WHERE
%s
GROUP BY
pt.type
ORDER BY
pt.type ASC",
(is_null($page_id) ? '1' : sprintf('pt.page_id = %d', $page_id))
));
}
/**
* Returns all the page types that exist in this Symphony install.
* There are 6 default system page types, and new types can be added
* by Developers via the Page Editor.
*
* @since Symphony 2.3 introduced the JSON type.
* @return array
* An array of strings of the page types used in this Symphony
* install. At the minimum, this will be an array with the values
* 'index', 'XML', 'JSON', 'admin', '404' and '403'.
*/
public static function fetchAvailablePageTypes()
{
$system_types = array('index', 'XML', 'JSON', 'admin', '404', '403');
$types = PageManager::fetchPageTypes();
return (!empty($types) ? General::array_remove_duplicates(array_merge($system_types, $types)) : $system_types);
}
/**
* Work out the next available sort order for a new page
*
* @return integer
* Returns the next sort order
*/
public static function fetchNextSortOrder()
{
$next = Symphony::Database()->fetchVar(
"next",
0,
"SELECT
MAX(p.sortorder) + 1 AS `next`
FROM
`tbl_pages` AS p
LIMIT 1"
);
return ($next ? (int)$next : 1);
}
/**
* Fetch an associated array with Page ID's and the types they're using.
*
* @throws DatabaseException
* @return array
* A 2-dimensional associated array where the key is the page ID.
*/
public static function fetchAllPagesPageTypes()
{
$types = Symphony::Database()->fetch("SELECT `page_id`,`type` FROM `tbl_pages_types`");
$page_types = array();
if (is_array($types)) {
foreach ($types as $type) {
$page_types[$type['page_id']][] = $type['type'];
}
}
return $page_types;
}
/**
* Given a name, this function will return a page handle. These handles
* will only contain latin characters
*
* @param string $name
* The Page name to generate a handle for
* @return string
*/
public static function createHandle($name)
{
return Lang::createHandle($name, 255, '-', false, true, array(
'@^[^a-z\d]+@i' => '',
'/[^\w-\.]/i' => ''
));
}
/**
* This function takes a `$path` and `$handle` and generates a flattened
* string for use as a filename for a Page's template.
*
* @param string $path
* The path of the Page, which is the handles of the Page parents. If the
* page has multiple parents, they will be separated by a forward slash.
* eg. article/read. If a page has no parents, this parameter should be null.
* @param string $handle
* A Page handle, generated using `PageManager::createHandle`.
* @return string
*/
public static function createFilePath($path, $handle)
{
return trim(str_replace('/', '_', $path . '_' . $handle), '_');
}
/**
* This function will return the number of child pages for a given
* `$page_id`. This is a recursive function and will return the absolute
* count.
*
* @param integer $page_id
* The ID of the Page.
* @return integer
* The number of child pages for the given `$page_id`
*/
public static function getChildPagesCount($page_id = null)
{
if (is_null($page_id)) {
return null;
}
$children = PageManager::fetch(false, array('id'), array(
sprintf('parent = %d', $page_id)
));
$count = count($children);
if ($count > 0) {
foreach ($children as $c) {
$count += self::getChildPagesCount($c['id']);
}
}
return $count;
}
/**
* Returns boolean if a the given `$type` has been used by Symphony
* for a Page that is not `$page_id`.
*
* @param integer $page_id
* The ID of the Page to exclude from the query.
* @param string $type
* The Page Type to look for in `tbl_page_types`.
* @return boolean
* True if the type is used, false otherwise
*/
public static function hasPageTypeBeenUsed($page_id = null, $type)
{
return (boolean)Symphony::Database()->fetchRow(0, sprintf(
"SELECT
pt.id
FROM
`tbl_pages_types` AS pt
WHERE
pt.page_id != %d
AND pt.type = '%s'
LIMIT 1",
$page_id,
Symphony::Database()->cleanValue($type)
));
}
/**
* Given a `$page_id`, this function returns boolean if the page
* has child pages.
*
* @param integer $page_id
* The ID of the Page to check
* @return boolean
* True if the page has children, false otherwise
*/
public static function hasChildPages($page_id = null)
{
return (boolean)Symphony::Database()->fetchVar('id', 0, sprintf(
"SELECT
p.id
FROM
`tbl_pages` AS p
WHERE
p.parent = %d
LIMIT 1",
$page_id
));
}
/**
* Resolves the path to this page's XSLT file. The Symphony convention
* is that they are stored in the `PAGES` folder. If this page has a parent
* it will be as if all the / in the URL have been replaced with _. ie.
* /articles/read/ will produce a file `articles_read.xsl`
*
* @see toolkit.PageManager#createFilePath()
* @param string $path
* The URL path to this page, excluding the current page. ie, /articles/read
* would make `$path` become articles/
* @param string $handle
* The handle of the page.
* @return string
* The path to the XSLT of the page
*/
public static function resolvePageFileLocation($path, $handle)
{
return PAGES . '/' . PageManager::createFilePath($path, $handle) . '.xsl';
}
/**
* Given the `$page_id` and a `$column`, this function will return an
* array of the given `$column` for the Page, including all parents.
*
* @param mixed $page_id
* The ID of the Page that currently being viewed, or the handle of the
* current Page
* @param string $column
* @return array
* An array of the current Page, containing the `$column`
* requested. The current page will be the last item the array, as all
* parent pages are prepended to the start of the array
*/
public static function resolvePage($page_id, $column)
{
$page = Symphony::Database()->fetchRow(0, sprintf(
"SELECT
p.%s,
p.parent
FROM
`tbl_pages` AS p
WHERE
p.id = %d
OR p.handle = '%s'
LIMIT 1",
$column,
$page_id,
Symphony::Database()->cleanValue($page_id)
));
if (empty($page)) {
return $page;
}
$path = array($page[$column]);
if (!is_null($page['parent'])) {
$next_parent = $page['parent'];
while (
$parent = Symphony::Database()->fetchRow(0, sprintf(
"SELECT
p.%s,
p.parent
FROM
`tbl_pages` AS p
WHERE
p.id = %d",
$column,
$next_parent
))
) {
array_unshift($path, $parent[$column]);
$next_parent = $parent['parent'];
}
}
return $path;
}
/**
* Given the `$page_id`, return the complete title of the
* current page. Each part of the Page's title will be
* separated by ': '.
*
* @param mixed $page_id
* The ID of the Page that currently being viewed, or the handle of the
* current Page
* @return string
* The title of the current Page. If the page is a child of another
* it will be prepended by the parent and a colon, ie. Articles: Read
*/
public static function resolvePageTitle($page_id)
{
$path = PageManager::resolvePage($page_id, 'title');
return implode(': ', $path);
}
/**
* Given the `$page_id`, return the complete path to the
* current page. Each part of the Page's path will be
* separated by '/'.
*
* @param mixed $page_id
* The ID of the Page that currently being viewed, or the handle of the
* current Page
* @return string
* The complete path to the current Page including any parent
* Pages, ie. /articles/read
*/
public static function resolvePagePath($page_id)
{
$path = PageManager::resolvePage($page_id, 'handle');
return implode('/', $path);
}
/**
* Resolve a page by it's handle and path
*
* @param $handle
* The handle of the page
* @param boolean $path
* The path to the page
* @return mixed
* Array if found, false if not
*/
public static function resolvePageByPath($handle, $path = false)
{
return Symphony::Database()->fetchRow(0, sprintf(
"SELECT * FROM `tbl_pages` WHERE `path` %s AND `handle` = '%s' LIMIT 1",
($path ? " = '".Symphony::Database()->cleanValue($path)."'" : 'IS NULL'),
Symphony::Database()->cleanValue($handle)
));
}
/**
* Check whether a datasource is used or not
*
* @param string $handle
* The datasource handle
* @return boolean
* True if used, false if not
*/
public static function isDataSourceUsed($handle)
{
return (boolean)Symphony::Database()->fetchVar('count', 0, "SELECT COUNT(*) AS `count` FROM `tbl_pages` WHERE `data_sources` REGEXP '[[:<:]]{$handle}[[:>:]]' ") > 0;
}
/**
* Check whether a event is used or not
*
* @param string $handle
* The event handle
* @return boolean
* True if used, false if not
*/
public static function isEventUsed($handle)
{
return (boolean)Symphony::Database()->fetchVar('count', 0, "SELECT COUNT(*) AS `count` FROM `tbl_pages` WHERE `events` REGEXP '[[:<:]]{$handle}[[:>:]]' ") > 0;
}
}