forked from xudianyang/yaf.auto.complete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Yaf.underline.php
3599 lines (3253 loc) · 78 KB
/
Yaf.underline.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
/**
* Yaf Develop Auto Complete
*
* Yaf框架之PhpStorm代码自动补全(屏蔽IDE undefined,中文详细文档,比手册更详细)
*
* 本文件使用方式:
*
* Yaf开发,在IDE中打开/导入本文件即可
* 如果IDE自带 Include Path 功能(如:PhpStorm),设置该文件路径即可.
*
* PhpStorm 另一种方法:
* WinRAR打开 <Phpstorm_Dir>/plugins/php/lib/php.jar 文件
* 复制 Yaf.underline.php 到路径:com/jetbrains/php/lang/psi/stubs/data/
* 保存文件,重启Phpstorm.
*
* PS:替换前请备份php.jar 若发生错误便于恢复 如有勘误,请联系Phpboy! :)
*
* @auther xudianyang<[email protected]>
* @copyright Copyright (c) 2014 (http://www.phpboy.net)
*/
define('YAF_VERSION', '2.2.9');
define('YAF_ERR_STARTUP_FAILED', 512);
define('YAF_ERR_ROUTE_FAILED', 513);
define('YAF_ERR_DISPATCH_FAILED', 514);
define('YAF_ERR_AUTOLOAD_FAILED', 520);
define('YAF_ERR_NOTFOUND_MODULE', 515);
define('YAF_ERR_NOTFOUND_CONTROLLER', 516);
define('YAF_ERR_NOTFOUND_ACTION', 517);
define('YAF_ERR_NOTFOUND_VIEW', 518);
define('YAF_ERR_CALL_FAILED', 519);
define('YAF_ERR_TYPE_ERROR', 521);
/**
* (Yaf >= 2.2.9)
* Class Yaf_Application
*
* Yaf应用类,代表一个产品/项目,是Yaf运行的主导者,真正执行的主题,它负责接收请求,协调路由,分发,执行,输出.
*
* @package Yaf
*/
final class Yaf_Application
{
/**
* (Yaf >= 2.2.9)
* 全局配置实例
*
* 根据实例化Yaf_Application时传入的ini配置文件路径或者配置数组及配置节点名称,实例化的Yaf_Config_Ini或者Yaf_Config_Simple对象.
*
* PHP代码可以这样获取:
*
* $config = Yaf_Application::app()->getConfig();
*
* @var Yaf_Config_Abstract
*/
protected $config;
/**
* (Yaf >= 2.2.9)
* Yaf_Dispatcher实例,即分发器.
*
* PHP代码可以这样获取:
* $dispatcher = Yaf_Application::app()->getDispatcher();
*
* @var Yaf_Dispatcher
*/
protected $dispatcher;
/**
* (Yaf >= 2.2.9)
* 过特殊的方式实现了单例模式, 此属性保存当前实例.
*
* PHP代码可以这样获取:
* $app = Yaf_Application::app();
*
* @var Yaf_Application
*/
static protected $_app;
/**
* (Yaf >= 2.2.9)
* 存在的模块名, 从配置文件中ap.modules读取.
*
* PHP代码可以这样获取:
* $modules = Yaf_Application::app()->geModules();
*
* @var String
*/
protected $_modules;
/**
* (Yaf >= 2.2.9)
* 指明当前的Yaf_Application是否已经运行.
*
* @var Boolean
*/
protected $_running;
/**
* (Yaf >= 2.2.9)
* 前的环境名, 也就是Yaf_Application在读取配置的时候, 获取的配置节名字.
* 注:此值只能在Yaf扩展级的配置文件.ini里面进行修改,默认为product.
*
* PHP代码可以这样获取:
* $environ = Yaf_Application::app()->environ();
*
* @var String
*/
protected $_environ;
/**
* (Yaf >= 2.2.9)
* 最近一次发生的错误代码.
*
* PHP代码可以这样获取:
* $err_on = Yaf_Application::app()->getLastErrorNo();
*
* @var Int
*/
protected $_err_no;
/**
* (Yaf >= 2.2.9)
* 最近一次产生的错误信息.
*
* PHP代码可以这样获取:
* $err_msg = Yaf_Application::app()->getLastErrorMsg();
*
* @var String
*/
protected $_err_msg;
/**
* (Yaf >= 2.2.9)
* 获取当前的Yaf_Application实例.
*
* @return Yaf_Application
*/
static public function app(){}
/**
* (Yaf >= 2.2.9)
* 调用bootstrap
*
* 指示Yaf_Application去寻找Bootstrap,并按照声明的顺序,执行所有在Bootstrap类中定义的以_init开头的方法.(php.net文档有误).
*
* @return Yaf_Application
*/
public function bootstrap(){}
/**
* (Yaf >= 2.2.9)
* 运行Yaf_Application
*
* @return Boolean
*/
public function run(){}
/**
* (Yaf >= 2.2.9)
* 清除最近的错误信息,将设置$this->_err_no=0,$this->_err_msg=''.
*
* @return Yaf_Application
*/
public function clearLastError(){}
/**
* (Yaf >= 2.2.9)
* 构造函数,根据配置初始化Yaf_Application
*
* @param mixed $config 关联数组的配置, 或者一个指向ini格式的配置文件的路径的字符串.
* 如果是一个ini配置文件,那配置文件中应该有一个定义了yaf.environ 的配置节.这个在生产环境中是默认的.
* 如果你使用了ini配置文件作为你应用配置的容器,你需要打开yaf.cache_config 来提升性能.
* @param string $section 加载的配置节点,使用该节点的配置初始化应用.
* @return Yaf_Application
*/
public function __construct($config, $section = 'product'){}
/**
* (Yaf >= 2.2.9)
* 运行回调函数,一般在命令行模式下运行.
*
* @param callable $entry 回调函数
* @param mixed $parameter 零个或者多个回调函数参数
*
* @return void
*/
public function execute(callable $entry, $parameter = null){}
/**
* (Yaf >= 2.2.9)
* 获取当前Yaf_Application的环境名,它被定义在yaf.environ,默认值为"product".
*
* @return String
*/
public function environ(){}
/**
* (Yaf >= 2.2.9)
* 获取当前应用的主目录
*
* @return String
*/
public function getAppDirectory(){}
/**
* (Yaf >= 2.2.9)
* 获取全局配置实例,即$this->config
*
* @return Yaf_Config_Abstract
*/
public function getConfig(){}
/**
* (Yaf >= 2.2.9)
* 获取当前请求的分发器Yaf_Dispatcher的实例
*
* @return Yaf_Dispatcher
*/
public function getDispatcher(){}
/**
* (Yaf >= 2.2.9)
* 获取最近产生的错误信息.
*
* @return String
*/
public function getLastErrorMsg(){}
/**
* (Yaf >= 2.2.9)
* 获取最近产生的错误代码.
*
* @return Int
*/
public function getLastErrorNo(){}
/**
* (Yaf >= 2.2.9)
* 获取在配置文件中声明的模块,如果没有声明,它的默认值将是"Index".
*
* @return String
*/
public function getModules(){}
/**
* (Yaf >= 2.2.9)
* 设置应用的主目录
*
* @param String $directory 目录路径.
*
* @return Yaf_Application
*/
public function setAppDirectory($directory){}
/**
* (Yaf >= 2.2.9)
* 重置__clone魔术方法,防止克隆Yaf_Application(因为是单例模式).
*
* @return void
*/
private function __clone(){}
/**
* (Yaf >= 2.2.9)
* 重置__destruct魔术方法.
*
* @return void
*/
public function __destruct(){}
/**
* (Yaf >= 2.2.9)
* 重置__sleep魔术方法.
*
* @return void
*/
private function __sleep(){}
/**
* (Yaf >= 2.2.9)
* 重置__wakeup魔术方法.
*
* @return void
*/
private function __wakeup(){}
}
/**
* (Yaf >= 2.2.9)
* Class Yaf_Bootstrap_Abstract
*
* Bootstrap是用来在Yaf_Application运行(run)之前做一些初始化工作的机制.
* 你可以通过继承Yaf_Bootstrap_Abstract来定义自己的Bootstrap类.
* 在Bootstrap类中所有以"_init"开头的公有的方法, 都会被按照定义顺序依次在Yaf_Application::bootstrap()被调用的时刻调用.
*
* @package Yaf
*/
abstract class Yaf_Bootstrap_Abstract{}
/**
* (Yaf >= 2.2.9)
* Class Yaf_Dispatcher
*
* Yaf_Dispatcher实现了MVC中的C分发,它由Yaf_Application负责初始化,然后由Yaf_Application::run启动,它协调路由来的请求,并分发和执行发现的动作.
* 并收集动作产生的响应,输出响应给请求者,并在整个过程完成以后返回响应.
*
* @package Yaf
*/
final class Yaf_Dispatcher
{
/**
* (Yaf >= 2.2.9)
* 当前请求对象(包含请求的所有信息).
*
* PHP代码可以这样获取:
* $request = Yaf_Dispatcher::getInstance()->getRequest();
*
* @var Yaf_Request_Abstract
*/
protected $_request;
/**
* (Yaf >= 2.2.9)
* 视图对象.
*
* PHP代码可以这样设置并初始化视图对象:
* Yaf_Dispatcher::getInstance()->setView($view);
* Yaf_Dispatcher::getInstance()->initView($template_dir, $option);
*
* @var Yaf_View_Interface
*/
protected $_view;
/**
* (Yaf >= 2.2.9)
* 路由器对象.
*
* PHP代码可以这样获取:
* $router = Yaf_Dispatcher::getInstance()->getRouter();
*
* @var Yaf_Router
*/
protected $_router;
/**
* (Yaf >= 2.2.9)
* Yaf_Dispatcher实现了单例模式,此属性保存当前实例.
*
* PHP代码可以这样获取:
* $dispatcher = Yaf_Dispatcher::getInstance();
*
* @var Yaf_Dispatcher
*/
static protected $_instance;
/**
* (Yaf >= 2.2.9)
* 自动渲染功能开关,默认1.
* 自动渲染是指根据当前请求的控制器Controller和动作Action自动寻找模块文件,加载与渲染模块,之后返回结果或者输出.
* 如果设置为0,$this->_instantly_flush,$this->_return_response的设置将无效,也即:
* Yaf_Dispatcher::getInstance()->flushInstantly($flag);
* Yaf_Dispatcher::getInstance()->returnResponse($flag);
* 设置无效,并且不会渲染模板.
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->autoRender($flag);
*
* @var Boolean
*/
protected $_auto_render;
/**
* (Yaf >= 2.2.9)
* 返回包含请求正文的响应对象开关,默认为0.
* 默认情况下,Yaf的自动渲染查找并渲染模板(render,并非display),渲染结果写入Yaf_Response_Abstract实例的_body属性,
* 在分发器结束分发之后,输出_body(数组遍历输出)属性的值,并清空_body.
* 设置此属性为1,分发器结束分发之后,不会输出和清空_body,可以通过Yaf_Application的run(),Yaf_Dispatcher的方法dispatch(),
* 或者Yaf_Controller_Abstract的getResponse()等方法的调用返回响应对象,
* 进而调用Yaf_Response_Abstract实例的getBody()方法获取响应正文.此属性依赖$this->_auto_render的设置,
* 当$this->_auto_render=1时,响应正文包括渲染模板的结果,反之则不包括.
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->returnResponse($flag);
*
* @var Boolean
*/
protected $_return_response;
/**
* (Yaf >= 2.2.9)
* 立即输出响应正文开头,默认为0.
* 默认情况下,Yaf自动渲染调用Yaf_Controller_Abstract的render方法,渲染模板.
* 当此属性设置为1时,Yaf调用Yaf_Controller_Abstract的display方法,直接渲染并输出,但不设置Yaf_Response_Abstract实例的_body属性.
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->flushInstantly($flag);
*
* @var Boolean
*/
protected $_instantly_flush;
/**
* (Yaf >= 2.2.9)
* 默认模块名
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->setDefaultModule($module);
*
* @var String
*/
protected $_default_module;
/**
* (Yaf >= 2.2.9)
* 默认控制器
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->setDefaultController($controller);
*
* @var String
*/
protected $_default_controller;
/**
* (Yaf >= 2.2.9)
* 默认动作名
*
* PHP代码可以这样设置:
* Yaf_Dispatcher::getInstance()->setDefaultAction($action);
*
* @var String
*/
protected $_default_action;
/**
* (Yaf >= 2.2.9)
* 已注册的插件对象
*
* PHP代码可以这样注册插件:
* Yaf_Dispatcher::getInstance()::registerPlugin(new ModuleInitPlugin());
*
* @var Array
*/
protected $_plugins;
/**
* (Yaf >= 2.2.9)
* 关闭自动渲染模板
*
* @return Yaf_Dispatcher
*/
public function disableView(){}
/**
* (Yaf >= 2.2.9)
* 开启自动渲染模板
*
* @return Yaf_Dispatcher
*/
public function enableView(){}
/**
* (Yaf >= 2.2.9)
* 初始化视图对象
*
* @param string $tpl_dir 模板目录
* @param mixed $options 全局的模板选项(配置相关)
*
* @return Yaf_View_Interface
*/
public function initView($tpl_dir, $options = null){}
/**
* (Yaf >= 2.2.9)
* 设置视图对象
*
* @param Yaf_View_Interface $view 视图对象实例
*
* @return Yaf_View_Interface
*/
public function setView(Yaf_View_Interface $view){}
/**
* (Yaf >= 2.2.9)
* 设置请求对象(在命令行或者其他API模式下构造请求很有用)
*
* @param Yaf_Request_Abstract $request 手动实例化的请求对象
*
* @return Yaf_Dispatcher
*/
public function setRequest(Yaf_Request_Abstract $request){}
/**
* (Yaf >= 2.2.9)
* 返回应用实例
*
* @return Yaf_Application
*/
public function getApplication(){}
/**
* 返回路由器实例
*
* @return Yaf_Router
*/
public function getRouter(){}
/**
* (Yaf >= 2.2.9)
* 返回请求对象实例
*
* @return Yaf_Request_Abstract
*/
public function getRequest(){}
/**
* (Yaf >= 2.2.9)
* 设置一个用户定义的错误处理函数(封装了PHP内置的set_error_handler函数)
*
* @param callable $callback PHP中可回调的结构
* @param $error_type int 处理的错误类型(默认:E_ALL | E_STRICT)
*
* @return Yaf_Dispatcher
*/
public function setErrorHandler(callable $callback, $error_type = 32767){}
/**
* (Yaf >= 2.2.9)
* 设置默认模块
*
* @param string $module 模块名
*
* @return Yaf_Dispatcher
*/
public function setDefaultModule($module){}
/**
* (Yaf >= 2.2.9)
* 设置默认的控制器
*
* @param string $controller 控制器名
*
* @return Yaf_Dispatcher
*/
public function setDefaultController($controller){}
/**
* (Yaf >= 2.2.9)
* 设置默认的动作名
*
* @param string $action
*
* @return Yaf_Dispatcher
*/
public function setDefaultAction($action){}
/**
* (Yaf >= 2.2.9)
* 设置或者返回$this->_return_response属性的值
* 当传递$flag参数时,设置$this->_return_response=$flag,并返回Dispatcher
* 当不传递任何参数时,返回$this->_return_response当前值
*
* @param boolean $flag
*
* @return mixed
*/
public function returnResponse($flag){}
/**
* (Yaf >= 2.2.9)
* 设置或者返回$this->_auto_render属性的值
* 当传递$flag参数时,设置$this->_auto_render=$flag,并返回Dispatcher
* 当不传递任何参数时,返回$this->_auto_render属性的值
*
* @param boolean $flag
*
* @return mixed
*/
public function autoRender($flag){}
/**
* (Yaf >= 2.2.9)
* 设置或者返回$this->_instantly_flush属性的值
* 当传递$flag参数时,设置$this->_instantly_flush=$flag,并返回Dispatcher
* 当不传递任何参数时,返回$this->_instantly_flush属性的值
*
* @param boolean $flag
*
* @return mixed
*/
public function flushInstantly($flag){}
/**
* (Yaf >= 2.2.9)
* 返回当前Yaf_Dispatcher实例(单例模式)
*
* @return Yaf_Dispatcher
*/
static public function getInstance(){}
/**
* (Yaf >= 2.2.9)
* 手动分发请求
*
* @param Yaf_Request_Abstract $request 分发的请求对象
*
* @return Yaf_Response_Abstract
*/
public function dispatch(Yaf_Request_Abstract $request){}
/**
* (Yaf >= 2.2.9)
* 开启/关闭异常抛出或返回当前状态
*
* 当传递$flag参数时,设置抛出异常,并返回Yaf_Dispatcher
* 当不传递任何参数时,返回抛出异常状态
*
* @param boolean $flag
*
* @return mixed
*/
public function throwException($flag){}
/**
* (Yaf >= 2.2.9)
* 开启/关闭自动异常捕获功能或返回当前状态
*
* 当传递$flag参数时,设置自动异常捕获,并返回Yaf_Dispatcher
* 当不传递任何参数时,返回当前状态
*
* 注意:如果开启了Yaf_Dispatcher::catchException() (可以通过设置application.dispatcher.catchException来开启),
* 并且在你定义了异常处理的controller的情况下,Yaf会将所有未捕获的异常交给Error Controller的Error Action来处理.
*
* @param boolean $flag
*
* @return mixed
*/
public function catchException($flag){}
/**
* (Yaf >= 2.2.9)
* 注册插件
*
* @param Yaf_Plugin_Abstract $plugin 实例化的插件对象
*
* @return Yaf_Dispatcher
*/
public function registerPlugin(Yaf_Plugin_Abstract $plugin){}
/**
* (Yaf >= 2.2.9)
* 重置__construct魔术方法.
*/
private function __construct(){}
/**
* (Yaf >= 2.2.9)
* 重置__clone魔术方法,防止克隆Yaf_Dispatcher(因为是单例模式).
*
* @return void
*/
private function __clone(){}
/**
* (Yaf >= 2.2.9)
* 重置__destruct魔术方法.
*
* @return void
*/
public function __destruct(){}
/**
* (Yaf >= 2.2.9)
* 重置__sleep魔术方法.
*
* @return void
*/
private function __sleep(){}
/**
* (Yaf >= 2.2.9)
* 重置__wakeup魔术方法.
*
* @return void
*/
private function __wakeup(){}
}
/**
* (Yaf >= 2.2.9)
* Class Yaf_Config_Abstract
*
* Yaf_Config_Abstract被设计在应用程序中简化访问和使用配置数据.它为在应用程序代码中访问这样的配置数据提供了一个基于用户接口的嵌入式对象属性.
* 配置数据可能来自于各种支持等级结构数据存储的媒体.Yaf_Config_Abstract实现了Countable,ArrayAccess和Iterator接口.
* 这样,可以基于Yaf_Config_Abstract对象使用count()函数和PHP语句如foreach,也可以通过数组方式访问Yaf_Config_Abstract的元素.
*
* @package Yaf
*/
abstract class Yaf_Config_Abstract implements Iterator, Countable, ArrayAccess
{
/**
* (Yaf >= 2.2.9)
* 存储已解析的配置
*
* PHP代码可以这样获取:
* $config = Yaf_Application::app()->getConfig()->toArray();
*
* @var array
*/
protected $_config;
/**
* (Yaf >= 2.2.9)
* 配置是否只读,默认为1.
*
* @var Boolean
*/
protected $_readonly;
/**
* (Yaf >= 2.2.9)
* 获取配置节点的值
* 当不传递$name参数时,返回配置对象本身
*
* @param string $name
* @return Yaf_Config_Abstract
*/
abstract function get($name);
/**
* (Yaf >= 2.2.9)
* 设置配置节点的值
*
* @param string $name
* @param mixed $value
* @return boolean
*/
abstract function set($name, $value);
/**
* (Yaf >= 2.2.9)
* 返回配置只读的状态
*
* @return boolean
*/
abstract function readonly();
/**
* (Yaf >= 2.2.9)
* 将配置转换为数组
*
* @return array
*/
abstract function toArray();
/**
* (Yaf >= 2.2.9)
* 获取配置节点的值
* 当不传递$name参数时,返回配置对象本身
*
* @param string $name
* @return Yaf_Config_Abstract
*/
public function __get($name){}
}
/**
* (Yaf >= 2.2.9)
* Class Yaf_Controller_Abstract
*
* Yaf_Controller_Abstract是Yaf的MVC体系的核心部分.
* MVC是指Model-View-Controller,是一个用于分离应用逻辑和表现逻辑的设计模式.
* Yaf_Controller_Abstract体系具有可扩展性,可以通过继承已有的类,来实现这个抽象类,从而添加应用自己的应用逻辑.
* 对于Controller来说, 真正的执行体是在Controller中定义的一个一个的动作, 当然这些动作也可以定义在Controller外.
*
* @package Yaf
*/
abstract class Yaf_Controller_Abstract
{
/**
* (Yaf >= 2.2.9)
* 动作名与动作类文件路径映射数组
*
* 如:
* public $actions = array(
* 'user' => "actions/article/index/User.php",
* );
*
* 备注:有些时候为了拆分比较大的Controller, 使得代码更加清晰和易于管理, Yaf支持将具体的动作分开定义.
* 每个动作都需要实现Yaf_Action_Abstract就可以通过定义Yaf_Controller_Abstract::$actions来指明
* 那些动作对应于具体的那些分离的类.
*
* @var array
*/
public $actions;
/**
* (Yaf >= 2.2.9)
* 当前请求的模块名
*
* PHP代码中也可以这样获取:
* $module = $this->getModuleName();
*
* @var String
*/
protected $_module;
/**
* (Yaf >= 2.2.9)
* 当前请求的控制器名
*
* @var String
*/
protected $_name;
/**
* (Yaf >= 2.2.9)
* 当前请求对象,包括请求的所有相关信息
*
* PHP代码中可以这样获取:
* $request = $this->getRequest();
*
* @var Yaf_Request_Abstract
*/
protected $_request;
/**
* (Yaf >= 2.2.9)
* 当前响应对象,保存响应的所有相关信息
*
* PHP代码中也可以这样获取:
* $response = $this->getResponse();
*
* @var Yaf_Response_Abstract
*/
protected $_response;
/**
* (Yaf >= 2.2.9)
* 储存调用参数
*
* PHP代码中可以这样获取:
* $args = $this->getInvokeArgs();
*
* @var array
*/
protected $_invoke_args;
/**
* (Yaf >= 2.2.9)
* 视图对象
*
* PHP代码中也可以这样获取:
* $view = $this->getView();
*
* @var Yaf_View_Interface
*/
protected $_view;
/**
* (Yaf >= 2.2.9)
* 渲染动作对应的模板,并返回结果
*
* @param string $action_name 动作名
* @param array $var_array 传递到视图对象的参数
*
* @return String
*/
protected function render($action_name, $var_array = array()){}
/**
* (Yaf >= 2.2.9)
* 渲染动作对应的模板,并直接输出结果
*
* @param string $action_name 动作名
* @param array $var_array 传递到视图对象的参数
*
* @return String
*/
protected function display($action_name, $var_array = array()){}
/**
* (Yaf >= 2.2.9)
* 获取请求对象
*
* @return Yaf_Request_Abstract
*/
public function getRequest(){}
/**
* (Yaf >= 2.2.9)
* 获取响应对象
*
* @return Yaf_Response_Abstract
*/
public function getResponse(){}
/**
* (Yaf >= 2.2.9)
* 获取当前模块名
*
* @return String
*/
public function getModuleName(){}
/**
* (Yaf >= 2.2.9)
* 初始化视图对象
*
* @deprecated 一直不可用,调用此方法只会返回Yaf_Controller_Abstract的实例
*
* @return Yaf_Controller_Abstract
*/
public function initView(){}
/**
* (Yaf >= 2.2.9)
* 返回视图对象
*
* @return Yaf_View_Interface
*/
public function getView(){}
/**
* (Yaf >= 2.2.9)
* 设置模板文件目录
*
* @param string $path
*
* @return Boolean
*/
public function setViewPath($path){}
/**
* (Yaf >= 2.2.9)
* 获取模板文件目录
*
* @return String
*/
public function getViewPath(){}
/**
* (Yaf >= 2.2.9)
* 将当前的请求转交给另外的Action(对用户来说是透明的,相当于Web服务器的代理).
*
* 调用Yaf_Controller_Abstract::forward()以后,不会直接立即跳转到目的Action执行,
* 而是会在当前的Action执行完成后,下一轮的DispatchLoop中,交给目的Action.
* 所以, 如果你希望立即跳转到目的Action, 那么请使用return结束当前的执行流程.
*
* @param string $module
* @param string $controller
* @param string $action
* @param string $parameters
*
* @return Boolean
*/
public function forward($module, $controller = null, $action = null, $parameters = null){}
/**
* (Yaf >= 2.2.9)
* 将当前请求重定向到指定的URL(内部实现是通过发送Location报头实现,如:header("Location:http//www.phpboy.net/"))
*
* @param string $url
*
* @return Boolean
*/
public function redirect($url){}
/**
* (Yaf >= 2.2.9)
* 获取全部调用参数
*
* @return Array
*/
public function getInvokeArgs(){}
/**
* (Yaf >= 2.2.9)
* 获取指定调用参数名的值
*
* @param string $name
*
* @return mixed
*/
public function getInvokeArg($name){}
/**
* (Yaf >= 2.2.9)
* 屏蔽构造方法
*/
final public function __construct(){}
/**
* (Yaf >= 2.2.9)
* 屏蔽克隆的魔术方法
*/
final public function __clone(){}
}