-
Notifications
You must be signed in to change notification settings - Fork 242
/
ezmodule.php
1403 lines (1294 loc) · 48.8 KB
/
ezmodule.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
//
// Definition of eZModule class
//
// Created on: <17-Apr-2002 11:11:39 amos>
//
// ## BEGIN COPYRIGHT, LICENSE AND WARRANTY NOTICE ##
// SOFTWARE NAME: eZ publish
// SOFTWARE RELEASE: 3.8.x
// COPYRIGHT NOTICE: Copyright (C) 1999-2006 eZ systems AS
// SOFTWARE LICENSE: GNU General Public License v2.0
// NOTICE: >
// This program is free software; you can redistribute it and/or
// modify it under the terms of version 2.0 of the GNU General
// Public License as published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of version 2.0 of the GNU General
// Public License along with this program; if not, write to the Free
// Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
// MA 02110-1301, USA.
//
//
// ## END COPYRIGHT, LICENSE AND WARRANTY NOTICE ##
//
/*!
\class eZModule ezmodule.php
\ingroup eZUtils
\brief Allows execution of modules and functions
*/
include_once( "lib/ezutils/classes/ezdebug.php" );
define( "EZ_MODULE_STATUS_IDLE", 0 );
define( "EZ_MODULE_STATUS_OK", 1 );
define( "EZ_MODULE_STATUS_FAILED", 2 );
define( "EZ_MODULE_STATUS_REDIRECT", 3 );
define( "EZ_MODULE_STATUS_RERUN", 4 );
define( "EZ_MODULE_HOOK_STATUS_OK", 0 );
define( "EZ_MODULE_HOOK_STATUS_CANCEL_RUN", 1 );
define( "EZ_MODULE_HOOK_STATUS_FAILED", 2 );
class eZModule
{
function eZModule( $path, $file, $moduleName )
{
$this->initialize( $path, $file, $moduleName );
}
/*!
\private
Initializes the module object with the path and file and name.
It will look for a file called \a $file and include the contents
of that file, it will then assume that some variables were set
which defines the module and it's view/functions.
*/
function initialize( $path, $file, $moduleName )
{
unset( $FunctionArray );
unset( $Module );
if ( file_exists( $file ) )
{
include( $file );
$this->Functions = $ViewList;
if ( isset( $FunctionList ) )
{
$this->FunctionList = $FunctionList;
}
else
{
$this->FunctionList = array();
}
$this->Module =& $Module;
$this->Name = $moduleName;
$this->Path = $path;
$this->Title = "";
$this->UIContext = 'navigation';
$this->UIComponent = $moduleName;
$uiComponentMatch = 'module';
if ( isset( $this->Module['ui_component_match'] ) )
{
$uiComponentMatch = $this->Module['ui_component_match'];
}
$this->UIComponentMatch = $uiComponentMatch;
foreach( $this->Functions as $key => $dummy)
{
$this->Functions[$key]["uri"] = "/$moduleName/$key";
}
}
else
{
$this->Functions = array();
$this->Module = array( "name" => "null",
"variable_params" => false,
"function" => array() );
$this->Name = $moduleName;
$this->Path = $path;
$this->Title = "";
$this->UIContext = 'navigation';
$this->UIComponent = $moduleName;
$this->UIComponentMatch = 'module';
}
$this->HookList = array();
$this->ExitStatus = EZ_MODULE_STATUS_IDLE;
$this->ErrorCode = 0;
$this->ViewActions = array();
$this->OriginalParameters = null;
$this->UserParameters = array();
// Load in navigation part overrides
$ini =& eZINI::instance( 'module.ini' );
$this->NavigationParts = $ini->variable( 'ModuleOverrides', 'NavigationPart' );
}
/*!
\return the URI of the module.
\sa functionURI
*/
function uri()
{
return "/" . $this->Name;
}
/*!
\return the URI to the view \a $function. If the view is empty or the module is a singleView type
it will return the result of uri(). If the view does not exist the \c null is returned.
\sa uri
*/
function functionURI( $function )
{
if ( $this->singleFunction() or
$function == '' )
return $this->uri();
if ( isset( $this->Functions[$function] ) )
return $this->Functions[$function]["uri"];
else
return null;
}
/*!
\return the title of the current view run, it's normally set by the view
and display as the title of view pages.
*/
function title()
{
return $this->Title;
}
/*!
Sets the current view for the module to \a $title.
*/
function setTitle( $title )
{
$this->Title = $title;
}
/*!
Sets the name of the currently running module to \a $name.
*/
function setCurrentName( $name )
{
$this->Name = $name;
foreach( $this->Functions as $key => $dummy )
{
$this->Functions[$key]["uri"] = "/$name/$key";
}
}
/*!
Sets the name of the currently running view to \a $name.
*/
function setCurrentView( $name )
{
$GLOBALS['eZModuleCurrentView'] = $name;
}
/*!
\return true if the module acts a single view.
*/
function singleFunction()
{
return count( $this->Functions ) == 0;
}
/*!
\return A string describing the current UI context, the default is \c 'navigation'
Change the context with setUIContextName().
*/
function uiContextName()
{
return $this->UIContext;
}
/*!
\return A string describing the current UI component.
The default value is the name of the currently running module, can be changed with setUIComponentName().
*/
function uiComponentName()
{
return $this->UIComponent;
}
/*!
Sets the current context string to \a $context.
*/
function setUIContextName( $context )
{
$this->UIContext = $context;
}
/*!
Sets the current component string to \a $component.
*/
function setUIComponentName( $component )
{
$this->UIComponent = $component;
}
/*!
\return the current status from the module.
*/
function exitStatus()
{
return $this->ExitStatus;
}
/*!
Sets the current status for the module to \a $stat, the status can trigger
a redirect or tell the client that the view failed.
*/
function setExitStatus( $stat )
{
$this->ExitStatus = $stat;
}
/*!
\return the error code if the function failed to run or \c 0 if no error code.
\sa setErrorCode
*/
function errorCode()
{
return $this->ErrorCode;
}
/*!
Sets the current error code.
\note You need to set the exit status to EZ_MODULE_STATUS_FAILED for the error code to be used.
\sa setExitStatus, errorCode
*/
function setErrorCode( $errorCode )
{
$this->ErrorCode = $errorCode;
}
/*!
\return the name of the module which will be run on errors.
The default name is 'error'.
\sa handleError
*/
function errorModule()
{
$globalErrorModule =& $GLOBALS['eZModuleGlobalErrorModule'];
if ( !isset( $globalErrorModule ) )
$globalErrorModule = array( 'module' => 'error',
'view' => 'view' );
return $globalErrorModule;
}
/*!
Sets the name of the module which will be run on errors.
\sa handleError
*/
function setErrorModule( $moduleName, $viewName )
{
$globalErrorModule =& $GLOBALS['eZModuleGlobalErrorModule'];
$globalErrorModule = array( 'module' => $moduleName,
'view' => $viewName );
}
/*!
Tries to run the error module with the error code \a $errorCode.
Sets the state of the module object to \c failed and sets the error code.
*/
function &handleError( $errorCode, $errorType = false, $parameters = array(), $userParameters = false )
{
if ( !$errorType )
{
eZDebug::writeWarning( "No error type specified for error code $errorCode, assuming kernel.\nA specific error type should be supplied, please check your code.",
'eZModule::handleError' );
$errorType = 'kernel';
}
$errorModule = eZModule::errorModule();
$module =& eZModule::findModule( $errorModule['module'], $this );
if ( $module === null )
{
$retValue = false;
return $retValue;
}
$result =& $module->run( $errorModule['view'], array( $errorType, $errorCode, $parameters, $userParameters ) );
// The error module may want to redirect to another URL, see error.ini
if ( $this->exitStatus() != EZ_MODULE_STATUS_REDIRECT and
$this->exitStatus() != EZ_MODULE_STATUS_RERUN )
{
$this->setExitStatus( EZ_MODULE_STATUS_FAILED );
$this->setErrorCode( $errorCode );
}
return $result;
}
/*!
Redirects the page to the module \a $moduleName and view \a $viewName with parameters \a $parameters
and unorderedParameters \a $unorderedParameters. If you already have the module object use redirectModule
instead or if you need to redirect to a view in the current module use redirectToView.
\return false if the view could not redirected to.
\sa redirectionURI
*/
function redirect( $moduleName, $viewName, $parameters = array(),
$unorderedParameters = null, $userParameters = false,
$anchor = false )
{
$module =& eZModule::exists( $moduleName );
if ( $module )
{
return $this->redirectModule( $module, $viewName, $parameters,
$unorderedParameters, $userParameters, $anchor );
}
else
{
eZDebug::writeError( 'Undefined module: ' . $moduleName, 'eZModule::redirect' );
}
return false;
}
/*!
Same as redirect() only redirects in the current module.
*/
function redirectToView( $viewName = '', $parameters = array(),
$unorderedParameters = null, $userParameters = false,
$anchor = false )
{
return $this->redirectModule( $this, $viewName, $parameters,
$unorderedParameters, $userParameters, $anchor );
}
/*!
Same as redirect() but takes a module object instead of the name.
*/
function redirectModule( &$module, $viewName, $parameters = array(),
$unorderedParameters = null, $userParameters = false,
$anchor = false )
{
$uri = $this->redirectionURIForModule( $module, $viewName, $parameters,
$unorderedParameters, $userParameters, $anchor );
$this->redirectTo( $uri );
return true;
}
/*!
\return the URI for the module \a $moduleName and view \a $viewName using parameters \a $parameters
and unordered parameters \a $unorderedParameters.
\sa redirect
*/
function redirectionURI( $moduleName, $viewName, $parameters = array(),
$unorderedParameters = null, $userParameters = false,
$anchor = false )
{
$module =& eZModule::exists( $moduleName );
if ( $module )
{
return $this->redirectionURIForModule( $module, $viewName, $parameters,
$unorderedParameters, $userParameters, $anchor );
}
else
eZDebug::writeError( 'Undefined module: ' . $moduleName, 'eZModule::redirectionURI' );
return false;
}
/*!
\return The URI of the currently run view in the current module with the current parameters.
*/
function currentRedirectionURI()
{
$module =& $this;
$viewName = eZModule::currentView();
$parameters = $this->OriginalViewParameters;
$unorderedParameters = $this->OriginalUnorderedParameters;
$userParameters = $this->UserParameters;
return $this->redirectionURIForModule( $module, $viewName, $parameters,
$unorderedParameters, $userParameters );
}
/*!
Redirects to the current module and view, it will use currentRedirectionURI() to
figure out the URL.
\note By changing using setCurrentName() and setCurrentView() first it is possible to
redirect to another module or view with the same parameters.
*/
function redirectCurrent()
{
$this->redirectTo( $this->currentRedirectionURI() );
}
/*!
Sames as redirectionURI but takes a module object instead of the name.
*/
function redirectionURIForModule( &$module, $viewName, $parameters = array(),
$unorderedParameters = null, $userParameters = false,
$anchor = false )
{
if ( $viewName == '' )
$viewName = eZModule::currentView();
$uri = $module->functionURI( $viewName );
$uri .= '/';
$viewParameters =& $module->parameters( $viewName );
$parameterIndex = 0;
$unorderedURI = '';
$hasUnorderedParameter = false;
if ( $unorderedParameters !== null )
{
$unorderedViewParameters =& $module->unorderedParameters( $viewName );
if ( is_array( $unorderedViewParameters ) )
{
foreach ( $unorderedViewParameters as $unorderedViewParameterName => $unorderedViewParameterVariable )
{
if ( isset( $unorderedParameters[$unorderedViewParameterVariable] ) )
{
$unorderedURI .= $unorderedViewParameterName . '/' . $unorderedParameters[$unorderedViewParameterVariable] . '/';
$hasUnorderedParameter = true;
}
}
}
}
if( !isset( $viewParameters ) )
$viewParameters = array(); // prevent PHP warning below
foreach ( $viewParameters as $viewParameter )
{
if ( !isset( $parameters[$parameterIndex] ) )
{
// We don't show a warning anymore since some parameters can be optional
// In future versions we will need required and optional parameters
// for modules and give warnings for required ones.
// eZDebug::writeWarning( "Missing parameter(s) " . implode( ', ', array_slice( $viewParameters, $parameterIndex ) ) .
// " in view '$viewName'", 'eZModule::redirect' );
}
else
$uri .= $parameters[$parameterIndex] . '/';
++$parameterIndex;
}
if ( $hasUnorderedParameter )
{
$uri .= $unorderedURI;
}
if ( is_array( $userParameters ) )
{
foreach ( $userParameters as $name => $value )
{
$uri .= '/(' . $name . ')/' . $value;
}
}
$uri = preg_replace( "#(^.*)(//+)$#", "\$1", $uri );
if ( $anchor !== false )
$uri .= '#' . urlencode( $anchor );
return $uri;
}
/*!
\return the parameter definition for the view \a $viewName. If \a $viewName
is empty the current view is used.
\sa unorderedParameters, viewData, currentView, currentModule
*/
function ¶meters( $viewName = '' )
{
if ( $viewName == '' )
$viewName = eZModule::currentView();
$viewData =& $this->viewData( $viewName );
if ( isset( $viewData['params'] ) )
return $viewData['params'];
$retValue = null;
return $retValue;
}
/*!
\return the unordered parameter definition for the view \a $viewName. If \a $viewName
is empty the current view is used.
\sa parameters, viewData, currentView, currentModule
*/
function &unorderedParameters( $viewName = '' )
{
if ( $viewName == '' )
$viewName = eZModule::currentView();
$viewData =& $this->viewData( $viewName );
if ( isset( $viewData['unordered_params'] ) )
return $viewData['unordered_params'];
$retValue = null;
return $retValue;
}
/*!
\return the view data for the view \a $viewName. If \a $viewName
is empty the current view is used.
\sa parameters, unorderedParameters, currentView, currentModule
*/
function &viewData( $viewName = '' )
{
if ( $viewName == '' )
$viewName = eZModule::currentView();
if ( $this->singleFunction() )
$viewData =& $this->Module["function"];
else
$viewData =& $this->Functions[$viewName];
return $viewData;
}
/*!
Makes sure that the module is redirected to the URI \a $uri when the function exits.
\sa setRedirectURI, setExitStatus
*/
function redirectTo( $uri )
{
$originalURI = $uri;
$uri = preg_replace( "#(^.*)(/+)$#", "\$1", $uri );
if ( strlen( $originalURI ) != 0 and
strlen( $uri ) == 0 )
$uri = '/';
$this->RedirectURI = $uri;
$this->setExitStatus( EZ_MODULE_STATUS_REDIRECT );
}
/*!
\return the URI which will be redirected to when the function exits.
*/
function redirectURI()
{
return $this->RedirectURI;
}
/*!
Sets the URI which will be redirected to when the function exits.
*/
function setRedirectURI( $uri )
{
$this->RedirectURI = $uri;
}
/*!
\return the status which will be set when redirecting.
*/
function redirectStatus()
{
return $this->RedirectStatus;
}
/*!
Sets the status which will be set when redirecting.
\note The status must be a valid HTTP status with number and text.
*/
function setRedirectStatus( $status )
{
$this->RedirectStatus = $status;
}
/*!
\return an array with the available attributes.
*/
function attributes()
{
return array( "uri",
"functions",
"name",
"path",
"info",
"aviable_functions",
"available_functions" );
}
/*!
\return true if the attribute \a $attr is available.
*/
function hasAttribute( $attr )
{
return in_array( $attr, $this->attributes() );
}
/*!
\return the attribute value for attribute \a $attr if it is available, otherwise \c null.
*/
function &attribute( $attr )
{
switch( $attr )
{
case "uri":
$retValue = $this->uri();
break;
case "functions":
return $this->Functions;
case "views":
return $this->Functions;
case "name":
return $this->Name;
case "path":
return $this->Path;
case "info":
return $this->Module;
case 'aviable_functions':
case 'available_functions':
return $this->FunctionList;
default:
{
eZDebug::writeError( "Attribute '$attr' does not exist", 'eZModule::attribute' );
$retValue = null;
}
break;
}
return $retValue;
}
/*!
Sets the current action in view \a $view to \a $actionName.
\sa currentAction, isCurrentAction
*/
function setCurrentAction( $actionName, $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
if ( $view == '' or $actionName == '' )
return false;
$this->ViewActions[$view] = $actionName;
}
/*!
\return the current action for the view \a $view.
If the current action is not yet determined it will use the definitions in
\c module.php for finding out the current action. It first looks trough
the \c single_post_actions array in the selected view mode, the key to
each element is the name of the post-variable to match, if it matches the
element value is set as the action.
\code
'single_post_actions' => array( 'PreviewButton' => 'Preview',
'PublishButton' => 'Publish' )
\endcode
If none of these matches it will use the elements from the \c post_actions
array to find a match. It uses the element value for each element to match
agains a post-variable, if it is found the contents of the post-variable
is set as the action.
\code
'post_actions' => array( 'BrowseActionName' )
\endcode
\sa setCurrentAction
*/
function currentAction( $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
if ( isset( $this->ViewActions[$view] ) )
return $this->ViewActions[$view];
include_once( "lib/ezutils/classes/ezhttptool.php" );
$http =& eZHTTPTool::instance();
if ( isset( $this->Functions[$view]['default_action'] ) )
{
$defaultAction = $this->Functions[$view]['default_action'];
foreach ( $defaultAction as $defaultActionStructure )
{
$actionName = $defaultActionStructure['name'];
$type = $defaultActionStructure['type'];
if ( $type == 'post' )
{
$parameters = array();
if ( isset( $defaultActionStructure['parameters'] ) )
$parameters = $defaultActionStructure['parameters'];
$hasParameters = true;
foreach ( $parameters as $parameterName )
{
if ( !$http->hasPostVariable( $parameterName ) )
{
$hasParameters = false;
break;
}
}
if ( $hasParameters )
{
$this->ViewActions[$view] = $actionName;
return $this->ViewActions[$view];
}
}
else
{
eZDebug::writeWarning( 'Unknown default action type: ' . $type, 'eZModule::currentAction' );
}
}
}
if ( isset( $this->Functions[$view]['single_post_actions'] ) )
{
$singlePostActions =& $this->Functions[$view]['single_post_actions'];
foreach( $singlePostActions as $postActionName => $realActionName )
{
if ( $http->hasPostVariable( $postActionName ) )
{
$this->ViewActions[$view] = $realActionName;
return $this->ViewActions[$view];
}
}
}
if ( isset( $this->Functions[$view]['post_actions'] ) )
{
$postActions =& $this->Functions[$view]['post_actions'];
foreach( $postActions as $postActionName )
{
if ( $http->hasPostVariable( $postActionName ) )
{
$this->ViewActions[$view] = $http->postVariable( $postActionName );
return $this->ViewActions[$view];
}
}
}
/* if ( isset( $this->Functions[$view]['group_post_actions'] ) )
{
$singlePostActions =& $this->Functions[$view]['group_post_actions'];
foreach( $singlePostActions as $postActionName => $realActionName )
{
if ( $http->hasPostVariable( $postActionName ) )
{
$this->ViewActions[$view] = $realActionName;
return $this->ViewActions[$view];
}
}
}
*/
$this->ViewActions[$view] = false;
return false;
}
function setActionParameter( $parameterName, $parameterValue, $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
$this->ViewActionParameters[$view][$parameterName] = $parameterValue;
}
function actionParameter( $parameterName, $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
if ( isset( $this->ViewActionParameters[$view][$parameterName] ) )
return $this->ViewActionParameters[$view][$parameterName];
$currentAction = $this->currentAction( $view );
include_once( "lib/ezutils/classes/ezhttptool.php" );
$http =& eZHTTPTool::instance();
if ( isset( $this->Functions[$view]['post_action_parameters'][$currentAction] ) )
{
$postParameters =& $this->Functions[$view]['post_action_parameters'][$currentAction];
if ( isset( $postParameters[$parameterName] ) and
$http->hasPostVariable( $postParameters[$parameterName] ) )
return $http->postVariable( $postParameters[$parameterName] );
eZDebug::writeError( "No such action parameter: $parameterName", 'eZModule::actionParameter' );
}
if ( isset( $this->Functions[$view]['post_value_action_parameters'][$currentAction] ) )
{
$postParameters =& $this->Functions[$view]['post_value_action_parameters'][$currentAction];
if ( isset( $postParameters[$parameterName] ) )
{
$postVariables =& $http->attribute( 'post' );
$postVariableNameMatch = $postParameters[$parameterName];
$regMatch = "/^" . $postVariableNameMatch . "_(.+)$/";
foreach ( $postVariables as $postVariableName => $postVariableValue )
{
if ( preg_match( $regMatch, $postVariableName, $matches ) )
{
$parameterValue = $matches[1];
$this->ViewActionParameters[$view][$parameterName] = $parameterValue;
return $parameterValue;
}
}
eZDebug::writeError( "No such action parameter: $parameterName", 'eZModule::actionParameter' );
}
}
return null;
}
function hasActionParameter( $parameterName, $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
if ( isset( $this->ViewActionParameters[$view][$parameterName] ) )
return true;
$currentAction = $this->currentAction( $view );
include_once( "lib/ezutils/classes/ezhttptool.php" );
$http =& eZHTTPTool::instance();
if ( isset( $this->Functions[$view]['post_action_parameters'][$currentAction] ) )
{
$postParameters =& $this->Functions[$view]['post_action_parameters'][$currentAction];
if ( isset( $postParameters[$parameterName] ) and
$http->hasPostVariable( $postParameters[$parameterName] ) )
return true;
}
if ( isset( $this->Functions[$view]['post_value_action_parameters'][$currentAction] ) )
{
$postParameters =& $this->Functions[$view]['post_value_action_parameters'][$currentAction];
if ( isset( $postParameters[$parameterName] ) )
{
$postVariables =& $http->attribute( 'post' );
$postVariableNameMatch = $postParameters[$parameterName];
$regMatch = "/^" . $postVariableNameMatch . "_(.+)$/";
foreach ( $postVariables as $postVariableName => $postVariableValue )
{
if ( preg_match( $regMatch, $postVariableName, $matches ) )
{
$parameterValue = $matches[1];
$this->ViewActionParameters[$view][$parameterName] = $parameterValue;
return true;
}
}
}
}
return false;
}
/*!
\return true if the current action matches the action name \a $actionName in view \a $view.
Always returns false if either \a $view or \a $actionName is empty.
\sa currentAction, setCurrentAction
*/
function isCurrentAction( $actionName, $view = '' )
{
if ( $view == '' )
$view = eZModule::currentView();
if ( $view == '' or $actionName == '' )
return false;
return $this->currentAction( $view ) == $actionName;
}
/*!
Adds an entry to the hook named \a $hookName. The entry is placed
before all other existing entries unless \a $append is set to \c true
in which case the entry is placed at the end.
\param $function Either the name of the function to be run or an
array where the first entry is the object and the second
is the method name.
*/
function addHook( $hookName, $function, $priority = 1, $expandParameters = true, $append = false )
{
$hookEntries =& $this->HookList[$hookName];
if ( !is_array( $hookEntries ) )
$hookEntries = array();
$entry = array( 'function' => $function,
'expand_parameters' => $expandParameters );
$position = $priority;
if ( $append )
{
while ( isset( $hookEntries[$position] ) )
++$position;
}
else
{
while ( isset( $hookEntries[$position] ) )
--$position;
}
$hookEntries[$position] = $entry;
}
/*!
Runs all hooks found in the hook list named \a $hookName.
The parameter array \a $parameters will be passed to each hook function.
*/
function runHooks( $hookName, $parameters = null )
{
$status = null;
$hookEntries =& $this->HookList[$hookName];
if ( isset( $hookEntries ) and
is_array( $hookEntries ) )
{
ksort( $hookEntries );
foreach ( array_keys( $hookEntries ) as $hookKey )
{
$hookEntry =& $hookEntries[$hookKey];
$function =& $hookEntry['function'];
$expandParameters =& $hookEntry['expand_parameters'];
if ( is_string( $function ) )
{
$functionName = $function;
if ( function_exists( $functionName ) )
{
if ( $parameters === null or $expandParameters === null )
$retVal =& $functionName( $this );
else if ( $expandParameters )
$retVal = call_user_func_array( $functionName, array_merge( array( &$this ), $parameters ) );
else
$retVal =& $functionName( $this, $parameters );
}
else
eZDebug::writeError( "Unknown hook function '$functionName' in hook: $hookName", 'eZModule::runHooks' );
}
else if ( is_array( $function ) )
{
if ( isset( $function[0] ) and
isset( $function[1] ) )
{
$object =& $function[0];
$functionName = $function[1];
if ( method_exists( $object, $functionName ) )
{
if ( $parameters === null )
$retVal =& $object->$function( $this );
else if ( $expandParameters )
$retVal = call_user_method_array( $functionName, $object, array_merge( array( &$this ), $parameters ) );
else
$retVal =& $object->$functionName( $this, $parameters );
}
else
eZDebug::writeError( "Unknown hook method '$functionName' in class '" . get_class( $object ) . "' in hook: $hookName", 'eZModule::runHooks' );
}
else
eZDebug::writeError( "Missing data for method handling in hook: $hookName", 'eZModule::runHooks' );
}
else
eZDebug::writeError( 'Unknown entry type ' . gettype( $function ) . 'in hook: ' . $hookName, 'eZModule::runHooks' );
switch( $retVal )
{
case EZ_MODULE_HOOK_STATUS_OK:
break;
case EZ_MODULE_HOOK_STATUS_FAILED:
{
eZDebug::writeWarning( 'Hook execution failed in hook: ' . $hookName, 'eZModule::runHooks' );
break;
}
case EZ_MODULE_HOOK_STATUS_CANCEL_RUN:
{
$status = $retVal;
return $status;
break;
}
}
}
}
return $status;
}
function setViewResult( &$result, $view = '' )
{
if ( $view == '' )
$view = $this->currentView();
$this->ViewResult[$view] =& $result;
}
function hasViewResult( $view = '' )
{
if ( $view == '' )
$view = $this->currentView();
return isset( $this->ViewResult[$view] );
}
function &viewResult( $view = '' )
{
if ( $view == '' )
$view = $this->currentView();
if ( isset( $this->ViewResult[$view] ) )
return $this->ViewResult[$view];
$retValue = null;
return $retValue;
}
function &forward( &$module, $functionName, $parameters = false )
{
$Return = null;
if ( $module && $functionName )
{
$viewName = eZModule::currentView();
if ( $parameters === false)
{
$parameters = array();
}
$parameters = array_merge( $parameters, $this->OriginalViewParameters );
$unorderedParameters = $this->OriginalUnorderedParameters;
$userParameters = $this->UserParameters;
$Return =& $module->run( $functionName, $parameters, $unorderedParameters, $userParameters );
// override default navigation part
if ( $Return['is_default_navigation_part'] === true )