forked from ezsystems/ezpublish-legacy
/
ezcontentobjecttreenode.php
6470 lines (5782 loc) · 266 KB
/
ezcontentobjecttreenode.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
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* File containing the eZContentObjectTreeNode class.
*
* @copyright Copyright (C) eZ Systems AS. All rights reserved.
* @license For full copyright and license information view LICENSE file distributed with this source code.
* @version //autogentag//
* @package kernel
*/
/**
* Encapsulates data about and methods to work with content objects inside the content object tree
*
* @package kernel
*/
class eZContentObjectTreeNode extends eZPersistentObject
{
const SORT_FIELD_PATH = 1;
const SORT_FIELD_PUBLISHED = 2;
const SORT_FIELD_MODIFIED = 3;
const SORT_FIELD_SECTION = 4;
const SORT_FIELD_DEPTH = 5;
const SORT_FIELD_CLASS_IDENTIFIER = 6;
const SORT_FIELD_CLASS_NAME = 7;
const SORT_FIELD_PRIORITY = 8;
const SORT_FIELD_NAME = 9;
const SORT_FIELD_MODIFIED_SUBNODE = 10;
const SORT_FIELD_NODE_ID = 11;
const SORT_FIELD_CONTENTOBJECT_ID = 12;
const SORT_FIELD_VISIBILITY = 13;
const SORT_ORDER_DESC = 0;
const SORT_ORDER_ASC = 1;
/**
* @inheritdoc
*/
static function definition()
{
static $definition = array( "fields" => array( "node_id" => array( 'name' => "NodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"parent_node_id" => array( 'name' => "ParentNodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObjectTreeNode',
'foreign_attribute' => 'node_id',
'multiplicity' => '1..*' ),
"main_node_id" => array( 'name' => "MainNodeID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObjectTreeNode',
'foreign_attribute' => 'node_id',
'multiplicity' => '1..*' ),
"contentobject_id" => array( 'name' => "ContentObjectID",
'datatype' => 'integer',
'default' => 0,
'required' => true,
'foreign_class' => 'eZContentObject',
'foreign_attribute' => 'id',
'multiplicity' => '1..*' ),
'contentobject_version' => array( 'name' => 'ContentObjectVersion',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'contentobject_is_published' => array( 'name' => 'ContentObjectIsPublished',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"depth" => array( 'name' => "Depth",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'sort_field' => array( 'name' => 'SortField',
'datatype' => 'integer',
'default' => self::SORT_FIELD_PATH,
'required' => true ),
'sort_order' => array( 'name' => 'SortOrder',
'datatype' => 'integer',
'default' => self::SORT_ORDER_ASC,
'required' => true ),
'priority' => array( 'name' => 'Priority',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
'modified_subnode' => array( 'name' => 'ModifiedSubNode',
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"path_string" => array( 'name' => "PathString",
'datatype' => 'string',
'default' => '',
'required' => true ),
"path_identification_string" => array( 'name' => "PathIdentificationString",
'datatype' => 'text',
'default' => '',
'required' => true ),
'remote_id' => array( 'name' => 'RemoteID',
'datatype' => 'string',
'default' => '',
'required' => true ),
"is_hidden" => array( 'name' => "IsHidden",
'datatype' => 'integer',
'default' => 0,
'required' => true ),
"is_invisible" => array( 'name' => "IsInvisible",
'datatype' => 'integer',
'default' => 0,
'required' => true ) ),
"keys" => array( "node_id" ),
"function_attributes" => array( "name" => "getName",
'data_map' => 'dataMap',
'remote_id' => 'remoteID', // Note: This overrides remote_id field
"object" => "object",
"subtree" => "subTree",
"children" => "children",
"children_count" => "childrenCount",
'view_count' => 'viewCount',
'contentobject_version_object' => 'contentObjectVersionObject',
'sort_array' => 'sortArray',
'can_read' => 'canRead',
'can_pdf' => 'canPdf',
'can_create' => 'canCreate',
'can_edit' => 'canEdit',
'can_hide' => 'canHide',
'can_remove' => 'canRemove',
'can_move' => 'canMoveFrom',
'can_move_from' => 'canMoveFrom',
'can_add_location' => 'canAddLocation',
'can_remove_location' => 'canRemoveLocation',
'can_view_embed' => 'canViewEmbed',
'is_main' => 'isMain',
'creator' => 'creator',
"path_with_names" => "pathWithNames",
"path" => "fetchPath",
'path_array' => 'pathArray',
"parent" => "fetchParent",
'url' => 'url',
'url_alias' => 'urlAlias',
'class_identifier' => 'classIdentifier',
'class_name' => 'className',
'hidden_invisible_string' => 'hiddenInvisibleString',
'hidden_status_string' => 'hiddenStatusString',
'classes_js_array' => 'availableClassesJsArray',
'is_container' => 'classIsContainer' ),
"increment_key" => "node_id",
"class_name" => "eZContentObjectTreeNode",
"name" => "ezcontentobject_tree" );
return $definition;
}
/**
* Creates a new tree node and returns it.
*
* The attribute remote_id will get an automatic and unique value.
*
* @param int $parentNodeID The ID of the parent or null if the node is not known yet.
* @param int $contentObjectID The ID of the object it points to or null if it is not known yet.
* @param int $contentObjectVersion The version of the object or 0 if not known yet.
* @param int $sortField Number describing the field to sort by, or 0 if not known yet.
* @param bool $sortOrder Which way to sort, true means ascending while false is descending.
*
* @return eZContentObjectTreeNode
*/
static function create( $parentNodeID = null, $contentObjectID = null, $contentObjectVersion = 0,
$sortField = 0, $sortOrder = true )
{
$row = array( 'node_id' => null,
'main_node_id' => null,
'parent_node_id' => $parentNodeID,
'contentobject_id' => $contentObjectID,
'contentobject_version' => $contentObjectVersion,
'contentobject_is_published' => false,
'depth' => 1,
'path_string' => null,
'path_identification_string' => null,
'is_hidden' => false,
'is_invisible' => false,
'sort_field' => $sortField,
'sort_order' => $sortOrder,
'modified_subnode' => 0,
'remote_id' => eZRemoteIdUtility::generate( 'node' ),
'priority' => 0 );
$node = new eZContentObjectTreeNode( $row );
return $node;
}
/**
* @since 4.7
* @var bool
*/
static protected $useCurrentUserDraft = false;
/**
* Enables / disables Use current user draft mode for data map
*
* When this mode is enabled (disabled by default), current user draft is used _if_ available
* on all dataMap calls.
*
* @since 4.7
* @param bool $enable
*/
static public function setUseCurrentUserDraft( $enable )
{
self::$useCurrentUserDraft = (bool) $enable;
}
/**
* Returns an array with all the content object attributes where the keys are the attribute identifiers.
*
* @see eZContentObject::fetchDataMap()
* @return eZContentObjectAttribute[]
*/
function dataMap()
{
$object = $this->object();
if ( self::$useCurrentUserDraft )
{
$draft = eZContentObjectVersion::fetchLatestUserDraft(
$object->attribute( 'id' ),
eZUser::currentUserID(),
$object->currentLanguageObject()->attribute( 'id' ),
$object->attribute( 'modified' )
);
if ( $draft instanceof eZContentObjectVersion )
return $object->fetchDataMap( $draft->attribute( 'version' ) );
}
return $object->fetchDataMap( $this->attribute( 'contentobject_version' ) );
}
/**
* Get the remote id of content node
*
* If there is no remote ID a new unique one will be generated.
*
* The remote ID is often used to synchronise imports and exports.
*
* @return string
*/
function remoteID()
{
$remoteID = $this->attribute( 'remote_id', true );
if ( !$remoteID )
{
$this->setAttribute( 'remote_id', eZRemoteIdUtility::generate( 'node' ) );
$this->sync( array( 'remote_id' ) );
$remoteID = $this->attribute( 'remote_id', true );
}
return $remoteID;
}
/**
* Returns true if this node is the main node.
*
* @return bool
*/
function isMain()
{
return $this->NodeID == $this->MainNodeID;
}
/**
* Returns the ID of the class attribute with the given ID or false if no class/attribute by that identifier
* is found. If multiple classes have the same identifier, the first found is returned.
*
* @param string $identifier
* @return int|bool
*/
static function classAttributeIDByIdentifier( $identifier )
{
return eZContentClassAttribute::classAttributeIDByIdentifier( $identifier );
}
/**
* Return the ID of the class with the given ID or false if no class by that identifier is found.
* If multiple classes have the same identifier, the first found is returned.
*
* @param string $identifier
* @return int|bool
*/
static function classIDByIdentifier( $identifier )
{
return eZContentClass::classIDByIdentifier( $identifier );
}
/**
* Returns true if the node can be read by the current user.
*
* @return bool
*/
function canRead( )
{
if ( !isset( $this->Permissions["can_read"] ) )
{
$this->Permissions["can_read"] = $this->checkAccess( 'read' );
}
return ( $this->Permissions["can_read"] == 1 );
}
/**
* Returns true if the current user can create a pdf of this content object.
*
* @return bool
*/
function canPdf( )
{
if ( !isset( $this->Permissions["can_pdf"] ) )
{
$this->Permissions["can_pdf"] = $this->checkAccess( 'pdf' );
}
return ( $this->Permissions["can_pdf"] == 1 );
}
/**
* Returns true if the node can be viewed as embeded object by the current user.
*
* @return bool
*/
function canViewEmbed( )
{
if ( !isset( $this->Permissions["can_view_embed"] ) )
{
$this->Permissions["can_view_embed"] = $this->checkAccess( 'view_embed' );
}
return ( $this->Permissions["can_view_embed"] == 1 );
}
/**
* Returns true if the node can be edited by the current user.
*
* @return bool
*/
function canEdit( )
{
if ( !isset( $this->Permissions["can_edit"] ) )
{
$this->Permissions["can_edit"] = $this->checkAccess( 'edit' );
if ( $this->Permissions["can_edit"] != 1 )
{
$user = eZUser::currentUser();
if ( $user->id() == $this->ContentObject->attribute( 'id' ) )
{
$access = $user->hasAccessTo( 'user', 'selfedit' );
if ( $access['accessWord'] == 'yes' )
{
$this->Permissions["can_edit"] = 1;
}
}
}
}
return ( $this->Permissions["can_edit"] == 1 );
}
/**
* Returns true if the node can be hidden by the current user.
*
* @return bool
*/
function canHide( )
{
if ( !isset( $this->Permissions["can_hide"] ) )
{
$this->Permissions["can_hide"] = $this->checkAccess( 'hide' );
}
return ( $this->Permissions["can_hide"] == 1 );
}
/**
* Returns true if the current user can create a new node as child of this node.
*
* @return bool
*/
function canCreate( )
{
if ( !isset( $this->Permissions["can_create"] ) )
{
$this->Permissions["can_create"] = $this->checkAccess( 'create' );
}
return ( $this->Permissions["can_create"] == 1 );
}
/**
* Returns true if the node can be removed by the current user.
*
* @return bool
*/
function canRemove( )
{
if ( !isset( $this->Permissions["can_remove"] ) )
{
$this->Permissions["can_remove"] = $this->checkAccess( 'remove' );
}
return ( $this->Permissions["can_remove"] == 1 );
}
/**
* Returns true if the node can be moved by the current user.
*
* @return bool
*/
function canMoveFrom( )
{
if ( !isset( $this->Permissions['can_move_from'] ) )
{
$this->Permissions['can_move_from'] = $this->checkAccess( 'edit' ) && $this->checkAccess( 'remove' );
}
return ( $this->Permissions['can_move_from'] == 1 );
}
/**
* Returns true if a node of class $classID can be moved to the current node by the current user.
*
* @param bool $classID
* @return bool
*/
function canMoveTo( $classID = false )
{
if ( !isset( $this->Permissions['can_move_to'] ) )
{
$this->Permissions['can_move_to'] = $this->checkAccess( 'create', $classID );
}
return ( $this->Permissions['can_move_to'] == 1 );
}
/**
* Returns true if a node can be swaped by the current user.
*
* @return bool
*/
function canSwap()
{
if ( !isset( $this->Permissions['can_swap'] ) )
{
$this->Permissions['can_swap'] = $this->checkAccess( 'edit' );
}
return ( $this->Permissions['can_swap'] == 1 );
}
/**
* Returns true if current user can add object locations to current node.
*
* @return bool
*/
function canAddLocation()
{
if ( !isset( $this->Permissions['can_add_location'] ) )
{
$this->Permissions['can_add_location'] = $this->checkAccess( 'can_add_location' );
}
return ( $this->Permissions['can_add_location'] == 1 );
}
/**
* Returns true if current user can add object locations to current node.
*
* @return bool
*/
function canRemoveLocation()
{
if ( !isset( $this->Permissions['can_remove_location'] ) )
{
$this->Permissions['can_remove_location'] = $this->checkAccess( 'can_remove_location' );
}
return ( $this->Permissions['can_remove_location'] == 1 );
}
/**
* Returns the sort key for the given classAttributeID or false if it can't be retrieved
*
* @param int $classAttributeID
* @return int|string|bool
*/
static function sortKeyByClassAttributeID( $classAttributeID )
{
return eZContentClassAttribute::sortKeyTypeByID( $classAttributeID );
}
/**
* Returns the datatype of a class attribute
*
* @param int $classAttributeID
* @return string
*/
static function dataTypeByClassAttributeID( $classAttributeID )
{
return eZContentClassAttribute::dataTypeByID( $classAttributeID );
}
/**
* Fetches the number of nodes which exists in the system.
*
* @return int
*/
static function fetchListCount()
{
$sql = "SELECT count( node_id ) as count FROM ezcontentobject_tree";
$db = eZDB::instance();
$rows = $db->arrayQuery( $sql );
return $rows[0]['count'];
}
/**
* Fetches a list of nodes and returns it. Offset and limitation can be set if needed.
*
* @param bool $asObject
* @param int|bool $offset
* @param int|bool $limit
* @return eZContentObjectTreeNode[]
*/
static function fetchList( $asObject = true, $offset = false, $limit = false )
{
$sql = "SELECT * FROM ezcontentobject_tree";
$parameters = array();
if ( $offset !== false )
$parameters['offset'] = $offset;
if ( $limit !== false )
$parameters['limit'] = $limit;
$db = eZDB::instance();
$rows = $db->arrayQuery( $sql, $parameters );
$nodes = array();
if ( $asObject )
{
foreach ( $rows as $row )
{
$nodes[] = new eZContentObjectTreeNode( $row );
}
return $nodes;
}
else
return $rows;
}
/**
* Creates an array with sorting SQL strings to be appended to a query
*
* @param array|bool $sortList
* @param string $treeTableName
* @param bool $allowCustomColumns
* @return array
*/
static function createSortingSQLStrings( $sortList, $treeTableName = 'ezcontentobject_tree', $allowCustomColumns = false )
{
$sortingInfo = array( 'sortCount' => 0,
'sortingFields' => " path_string ASC",
'attributeJoinCount' => 0,
'attributeFromSQL' => "",
'attributeTargetSQL' => "",
'attributeWhereSQL' => "" );
if ( $sortList and is_array( $sortList ) and count( $sortList ) > 0 )
{
if ( count( $sortList ) > 1 and !is_array( $sortList[0] ) )
{
$sortList = array( $sortList );
}
$sortingFields = '';
$sortCount = 0;
$attributeJoinCount = 0;
$stateJoinCount = 0;
$attributeFromSQL = "";
$attributeWhereSQL = "";
$datatypeSortingTargetSQL = "";
foreach ( $sortList as $sortBy )
{
if ( is_array( $sortBy ) and count( $sortBy ) > 0 )
{
if ( $sortCount > 0 )
{
$sortingFields .= ', ';
}
$sortField = $sortBy[0];
switch ( $sortField )
{
case 'path':
{
$sortingFields .= 'path_string';
} break;
case 'path_string':
{
$sortingFields .= 'path_identification_string';
} break;
case 'published':
{
$sortingFields .= 'ezcontentobject.published';
} break;
case 'modified':
{
$sortingFields .= 'ezcontentobject.modified';
} break;
case 'modified_subnode':
{
$sortingFields .= 'modified_subnode';
} break;
case 'section':
{
$sortingFields .= 'ezcontentobject.section_id';
} break;
case 'node_id':
{
$sortingFields .= $treeTableName . '.node_id';
} break;
case 'contentobject_id':
{
$sortingFields .= 'ezcontentobject.id';
} break;
case 'depth':
{
$sortingFields .= 'depth';
} break;
case 'class_identifier':
{
$sortingFields .= 'ezcontentclass.identifier';
} break;
case 'class_name':
{
$classNameFilter = eZContentClassName::sqlFilter();
$sortingFields .= 'contentclass_name';
$datatypeSortingTargetSQL .= ", $classNameFilter[nameField] AS contentclass_name";
$attributeFromSQL .= " INNER JOIN $classNameFilter[from] ON ($classNameFilter[where])";
} break;
case 'priority':
{
$sortingFields .= $treeTableName . '.priority';
} break;
case 'visibility':
{
$sortingFields .= $treeTableName . '.is_invisible';
} break;
case 'name':
{
$sortingFields .= 'ezcontentobject_name.name';
} break;
case 'attribute':
{
$classAttributeID = $sortBy[2];
if ( !is_numeric( $classAttributeID ) )
$classAttributeID = eZContentObjectTreeNode::classAttributeIDByIdentifier( $classAttributeID );
$contentAttributeTableAlias = "a$attributeJoinCount";
$datatypeFromSQL = "ezcontentobject_attribute $contentAttributeTableAlias";
$datatypeWhereSQL = "
$contentAttributeTableAlias.contentobject_id = ezcontentobject.id AND
$contentAttributeTableAlias.contentclassattribute_id = $classAttributeID AND
$contentAttributeTableAlias.version = ezcontentobject.current_version AND";
$datatypeWhereSQL .= eZContentLanguage::sqlFilter( $contentAttributeTableAlias, 'ezcontentobject' );
$dataType = eZDataType::create( eZContentObjectTreeNode::dataTypeByClassAttributeID( $classAttributeID ) );
if( is_object( $dataType ) && $dataType->customSorting() )
{
$params = array();
$params['contentobject_attr_id'] = "$contentAttributeTableAlias.id";
$params['contentobject_attr_version'] = "$contentAttributeTableAlias.version";
$params['table_alias_suffix'] = "$attributeJoinCount";
$sql = $dataType->customSortingSQL( $params );
$datatypeFromSQL .= " INNER JOIN $sql[from] ON ($sql[where])";
$datatypeSortingFieldSQL = $sql['sorting_field'];
$datatypeSortingTargetSQL .= ', ' . $sql['sorting_field'];
}
else
{
// Look up datatype for standard sorting
$sortKeyType = eZContentObjectTreeNode::sortKeyByClassAttributeID( $classAttributeID );
switch ( $sortKeyType )
{
case 'string':
{
$sortKey = 'sort_key_string';
} break;
case 'int':
default:
{
$sortKey = 'sort_key_int';
} break;
}
$datatypeSortingFieldSQL = "a$attributeJoinCount.$sortKey";
$datatypeSortingTargetSQL .= ', ' . $datatypeSortingFieldSQL;
}
$sortingFields .= "$datatypeSortingFieldSQL";
$attributeFromSQL .= " INNER JOIN $datatypeFromSQL ON ($datatypeWhereSQL)";
$attributeJoinCount++;
}break;
case 'state':
{
$stateGroupID = $sortBy[2];
if ( !is_numeric( $stateGroupID ) )
{
$stateGroup = eZContentObjectStateGroup::fetchByIdentifier( $stateGroupID );
if ( $stateGroup )
{
$stateGroupID = $stateGroup->attribute( 'id' );
}
else
{
eZDebug::writeError( "Unknown content object state group '$stateGroupID'" );
continue 2;
}
}
$stateAlias = "s$stateJoinCount";
$stateLinkAlias = "sl$stateJoinCount";
$sortingFields .= "$stateAlias.priority";
$datatypeSortingTargetSQL .= ", $stateAlias.priority";
$attributeFromSQL .=
" INNER JOIN ezcobj_state $stateAlias ON ($stateAlias.group_id = $stateGroupID)" .
" INNER JOIN ezcobj_state_link $stateLinkAlias" .
" ON ($stateLinkAlias.contentobject_id = ezcontentobject.id AND $stateLinkAlias.contentobject_state_id = $stateAlias.id)";
} break;
default:
{
if ( $allowCustomColumns )
{
$sortingFields .= $sortField;
}
else
{
eZDebug::writeWarning( 'Unknown sort field: ' . $sortField, __METHOD__ );
continue;
}
}
}
$sortOrder = true; // true is ascending
if ( isset( $sortBy[1] ) )
$sortOrder = $sortBy[1];
$sortingFields .= $sortOrder ? " ASC" : " DESC";
++$sortCount;
}
}
$sortingInfo['sortCount'] = $sortCount;
$sortingInfo['sortingFields'] = $sortingFields;
$sortingInfo['attributeTargetSQL'] = $datatypeSortingTargetSQL;
$sortingInfo['attributeJoinCount'] = $attributeJoinCount;
$sortingInfo['attributeFromSQL'] = $attributeFromSQL;
$sortingInfo['attributeWhereSQL'] = $attributeWhereSQL;
}
else if ( $sortList === array() )
{
$sortingInfo['sortingFields'] = '';
}
return $sortingInfo;
}
/**
* Returns an SQL string to filter query results by classes
*
* @param string|bool $classFilterType
* @param array $classFilterArray
* @return string|bool
*/
static function createClassFilteringSQLString( $classFilterType, &$classFilterArray )
{
// Check for class filtering
$classCondition = '';
if ( isset( $classFilterType ) &&
( $classFilterType == 'include' || $classFilterType == 'exclude' ) &&
count( $classFilterArray ) > 0 )
{
$classCondition = ' ';
$i = 0;
$classCount = count( $classFilterArray );
$classIDArray = array();
foreach ( $classFilterArray as $classID )
{
$originalClassID = $classID;
// Check if classes are recerenced by identifier
if ( is_string( $classID ) && !is_numeric( $classID ) )
{
$classID = eZContentClass::classIDByIdentifier( $classID );
}
if ( is_numeric( $classID ) )
{
$classIDArray[] = $classID;
}
else
{
eZDebugSetting::writeWarning( 'kernel-content-class', "Invalid class identifier in subTree() classfilterarray, classID : " . $originalClassID );
}
}
if ( count( $classIDArray ) > 0 )
{
$classCondition .= " ezcontentobject.contentclass_id ";
if ( $classFilterType == 'include' )
$classCondition .= " IN ";
else
$classCondition .= " NOT IN ";
$classIDString = implode( ', ', $classIDArray );
$classCondition .= ' ( ' . $classIDString . ' ) AND';
}
else
{
if ( count( $classIDArray ) == 0 and count( $classFilterArray ) > 0 and $classFilterType == 'include' )
{
$classCondition = false;
}
}
}
return $classCondition;
}
/**
* Creates a filter array from extended attribute filters
*
* The filter array includes tables, joins, columns and grouping information
*
* @param array $extendedAttributeFilter
* @return array
*/
static function createExtendedAttributeFilterSQLStrings( &$extendedAttributeFilter )
{
$filter = array( 'tables' => '',
'joins' => '',
'columns' => '',
'group_by' => '' );
if ( $extendedAttributeFilter and count( $extendedAttributeFilter ) > 1 )
{
$extendedAttributeFilterID = $extendedAttributeFilter['id'];
$extendedAttributeFilterParams = $extendedAttributeFilter['params'];
$filterINI = eZINI::instance( 'extendedattributefilter.ini' );
if ( !$filterINI->hasGroup( $extendedAttributeFilterID ) )
{
eZDebug::writeError( "Unable to find configuration for the extended attribute filter '$extendedAttributeFilterID', the filter will be ignored", __METHOD__ );
return $filter;
}
$filterClassName = $filterINI->variable( $extendedAttributeFilterID, 'ClassName' );
$filterMethodName = $filterINI->variable( $extendedAttributeFilterID, 'MethodName' );
if ( $filterINI->hasVariable( $extendedAttributeFilterID, 'FileName' ) )
{
$filterFile = $filterINI->variable( $extendedAttributeFilterID, 'FileName' );
if ( $filterINI->hasVariable( $extendedAttributeFilterID, 'ExtensionName' ) )
{
$extensionName = $filterINI->variable( $extendedAttributeFilterID, 'ExtensionName' );
include_once( eZExtension::baseDirectory() . "/$extensionName/$filterFile" );
}
else
{
include_once( $filterFile );
}
}
if ( !class_exists( $filterClassName, true ) )
{
eZDebug::writeError( "Unable to find the PHP class '$filterClassName' associated with the extended attribute filter '$extendedAttributeFilterID', the filter will be ignored", __METHOD__ );
return $filter;
}
$classObject = new $filterClassName();
$parameterArray = array( $extendedAttributeFilterParams );
$sqlResult = call_user_func_array( array( $classObject, $filterMethodName ), $parameterArray );
$filter['tables'] = $sqlResult['tables'];
$filter['joins'] = $sqlResult['joins'];
$filter['columns'] = isset( $sqlResult['columns'] ) ? $sqlResult['columns'] : '';
if( isset( $sqlResult['group_by'] ) )
$filter['group_by'] = $sqlResult['group_by'];
}
return $filter;
}
/**
* If $mainNodeOnly is set to true, creates an SQL part which makes sure the fetched node(s) are main nodes
*
* @param bool $mainNodeOnly
* @return string
*/
static function createMainNodeConditionSQLString( $mainNodeOnly )
{
// Main node check
$mainNodeCondition = '';
if ( isset( $mainNodeOnly ) && $mainNodeOnly === true )
{
$mainNodeCondition = 'ezcontentobject_tree.node_id = ezcontentobject_tree.main_node_id AND';
}
return $mainNodeCondition;
}
/**
* Creates an SQL part to match objects with a name starting with $filter
*
* If $filter is "others", the SQL part will match only names which do NOT start with a letter from the
* alphabet.
*
* @see eZAlphabetOperator::fetchAlphabet()
*
* @param string $filter
* @return string
*/
static function createObjectNameFilterConditionSQLString( $filter )
{
if ( !$filter )
return '';
$db = eZDB::instance();
if ( $filter == 'others' )
{
$alphabet = eZAlphabetOperator::fetchAlphabet();
$sql = '';
foreach ( $alphabet as $letter )
{
$sql .= " AND ezcontentobject_name.name NOT LIKE '". $db->escapeString( $letter ) . "%' ";
}
return $sql;
}
$objectNameFilterSQL = " AND ezcontentobject_name.name LIKE '" . $db->escapeString( $filter ) ."%'";
return $objectNameFilterSQL;
}
/**
* Returns an array to filter a query by the given attributes in $attributeFilter
*
* @param array|bool $attributeFilter
* @param array $sortingInfo
* @param array|bool $language
* @return array|bool
*/
static function createAttributeFilterSQLStrings( &$attributeFilter, &$sortingInfo = array( 'sortCount' => 0, 'attributeJoinCount' => 0 ), $language = false )
{
// Check for attribute filtering
$filterSQL = array( 'from' => '',
'where' => '' );
if ( $language !== false && !is_array( $language ) )
{
$language = array( $language );
}
$totalAttributesFiltersCount = 0;
$invalidAttributesFiltersCount = 0;
if ( isset( $attributeFilter ) && $attributeFilter !== false )
{
if ( !is_array( $attributeFilter ) )
{
eZDebug::writeError( "\$attributeFilter needs to be an array", __METHOD__ );
return $filterSQL;
}
$filterArray = $attributeFilter;
// Check if first value of array is a string.
// To check for and/or filtering
$filterJoinType = 'AND';
if ( is_string( $filterArray[0] ) )
{
if ( strtolower( $filterArray[0] ) == 'or' )
{
$filterJoinType = 'OR';
}
else if ( strtolower( $filterArray[0] ) == 'and' )
{
$filterJoinType = 'AND';
}
unset( $filterArray[0] );
}
$attibuteFilterJoinSQL = "";
$filterCount = $sortingInfo['sortCount'];
$justFilterCount = 0;
$db = eZDB::instance();
if ( is_array( $filterArray ) )
{
// Handle attribute filters and generate SQL
$totalAttributesFiltersCount = count( $filterArray );
foreach ( $filterArray as $filter )
{
$isFilterValid = true; // by default assumes that filter is valid