[DOC-CVS] [doc-en] master: Revise the Yaf extension documentation (#5809)
[email protected] (Xinchen Hui via GitHub)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Xinchen Hui (laruence) Committer: GitHub (web-flow) Pusher: sy-records Date: 2026-08-27T15:23:56+08:00 Commit: https://github.com/php/doc-en/commit/ddcf673c59d1708557680946fbffeee361d7fca6 Raw diff: https://github.com/php/doc-en/commit/ddcf673c59d1708557680946fbffeee361d7fca6.diff Revise the Yaf extension documentation (#5809) Rewrite the Yaf extension reference for the current extension state: verify every class page against the 3.3.x arginfo (parameter names, types, return values), restore the missing example/singleton notes and add examples for the ~199 methods that had none, align the Introduction sections and the Tutorials with the README quick start, and fix the classname references across method signatures (Yaf_Response_Http, the Yaf_Exception_LoadFailed_* family and friends). Content highlights: - Recommend Yaconf for configuration in large applications - Point to the fuller commented skeleton generated by yaf_cg instead of the outdated one-liner - Use the standard GitHub link entities - Note that Yaf_Request_Simple::isXmlHttpRequest() always returns false - Keep DocBook validity (note paragraphs as simpara, no methodname nesting inside See Also lists) Changed paths: A reference/yaf/yaf_dispatcher/getresponse.xml A reference/yaf/yaf_dispatcher/setresponse.xml A reference/yaf/yaf_request_abstract/get.xml A reference/yaf/yaf_request_abstract/getcookie.xml A reference/yaf/yaf_request_abstract/getfiles.xml A reference/yaf/yaf_request_abstract/getpost.xml A reference/yaf/yaf_request_abstract/getquery.xml A reference/yaf/yaf_request_abstract/getraw.xml A reference/yaf/yaf_request_abstract/getrequest.xml A reference/yaf/yaf_request_abstract/isdelete.xml A reference/yaf/yaf_request_abstract/ispatch.xml D reference/yaf/yaf_application/destruct.xml D reference/yaf/yaf_request_http/get.xml D reference/yaf/yaf_request_http/getcookie.xml D reference/yaf/yaf_request_http/getfiles.xml D reference/yaf/yaf_request_http/getpost.xml D reference/yaf/yaf_request_http/getquery.xml D reference/yaf/yaf_request_http/getraw.xml D reference/yaf/yaf_request_http/getrequest.xml D reference/yaf/yaf_request_http/isxmlhttprequest.xml D reference/yaf/yaf_request_simple/get.xml D reference/yaf/yaf_request_simple/getcookie.xml D reference/yaf/yaf_request_simple/getfiles.xml D reference/yaf/yaf_request_simple/getpost.xml D reference/yaf/yaf_request_simple/getquery.xml D reference/yaf/yaf_request_simple/getrequest.xml D reference/yaf/yaf_request_simple/isxmlhttprequest.xml D reference/yaf/yaf_response_abstract/destruct.xml M reference/yaf/appconfig.xml M reference/yaf/book.xml M reference/yaf/constants.xml M reference/yaf/ini.xml M reference/yaf/setup.xml M reference/yaf/tutorials.xml M reference/yaf/versions.xml M reference/yaf/yaf-action-abstract.xml M reference/yaf/yaf-application.xml M reference/yaf/yaf-config-abstract.xml M reference/yaf/yaf-config-ini.xml M reference/yaf/yaf-config-simple.xml M reference/yaf/yaf-controller-abstract.xml M reference/yaf/yaf-dispatcher.xml M reference/yaf/yaf-exception-dispatchfailed.xml M reference/yaf/yaf-exception-loadfailed-action.xml M reference/yaf/yaf-exception-loadfailed-controller.xml M reference/yaf/yaf-exception-loadfailed-module.xml M reference/yaf/yaf-exception-loadfailed-view.xml M reference/yaf/yaf-exception-loadfailed.xml M reference/yaf/yaf-exception-routerfailed.xml M reference/yaf/yaf-exception-startuperror.xml M reference/yaf/yaf-exception-typeerror.xml M reference/yaf/yaf-exception.xml M reference/yaf/yaf-loader.xml M reference/yaf/yaf-plugin-abstract.xml M reference/yaf/yaf-registry.xml M reference/yaf/yaf-request-abstract.xml M reference/yaf/yaf-request-http.xml M reference/yaf/yaf-request-simple.xml M reference/yaf/yaf-response-abstract.xml M reference/yaf/yaf-response-cli.xml M reference/yaf/yaf-response-http.xml M reference/yaf/yaf-route-interface.xml M reference/yaf/yaf-route-map.xml M reference/yaf/yaf-route-regex.xml M reference/yaf/yaf-route-rewrite.xml M reference/yaf/yaf-route-simple.xml M reference/yaf/yaf-route-static.xml M reference/yaf/yaf-route-supervar.xml M reference/yaf/yaf-router.xml M reference/yaf/yaf-session.xml M reference/yaf/yaf_action_abstract/execute.xml M reference/yaf/yaf_action_abstract/getcontroller.xml M reference/yaf/yaf_action_abstract/getcontrollername.xml M reference/yaf/yaf_application/app.xml M reference/yaf/yaf_application/bootstrap.xml M reference/yaf/yaf_application/clearlasterror.xml M reference/yaf/yaf_application/construct.xml M reference/yaf/yaf_application/environ.xml M reference/yaf/yaf_application/execute.xml M reference/yaf/yaf_application/getappdirectory.xml M reference/yaf/yaf_application/getconfig.xml M reference/yaf/yaf_application/getdispatcher.xml M reference/yaf/yaf_application/getlasterrormsg.xml M reference/yaf/yaf_application/getlasterrorno.xml M reference/yaf/yaf_application/getmodules.xml M reference/yaf/yaf_application/run.xml M reference/yaf/yaf_application/setappdirectory.xml M reference/yaf/yaf_config_abstract/get.xml M reference/yaf/yaf_config_abstract/readonly.xml M reference/yaf/yaf_config_abstract/set.xml M reference/yaf/yaf_config_abstract/toarray.xml M reference/yaf/yaf_config_ini/construct.xml M reference/yaf/yaf_config_ini/count.xml M reference/yaf/yaf_config_ini/current.xml M reference/yaf/yaf_config_ini/get.xml M reference/yaf/yaf_config_ini/isset.xml M reference/yaf/yaf_config_ini/key.xml M reference/yaf/yaf_config_ini/next.xml M reference/yaf/yaf_config_ini/offsetexists.xml M reference/yaf/yaf_config_ini/offsetget.xml M reference/yaf/yaf_config_ini/offsetset.xml M reference/yaf/yaf_config_ini/offsetunset.xml M reference/yaf/yaf_config_ini/readonly.xml M reference/yaf/yaf_config_ini/rewind.xml M reference/yaf/yaf_config_ini/set.xml M reference/yaf/yaf_config_ini/toarray.xml M reference/yaf/yaf_config_ini/valid.xml M reference/yaf/yaf_config_simple/construct.xml M reference/yaf/yaf_config_simple/count.xml M reference/yaf/yaf_config_simple/current.xml M reference/yaf/yaf_config_simple/get.xml M reference/yaf/yaf_config_simple/isset.xml M reference/yaf/yaf_config_simple/key.xml M reference/yaf/yaf_config_simple/next.xml M reference/yaf/yaf_config_simple/offsetexists.xml M reference/yaf/yaf_config_simple/offsetget.xml M reference/yaf/yaf_config_simple/offsetset.xml M reference/yaf/yaf_config_simple/offsetunset.xml M reference/yaf/yaf_config_simple/readonly.xml M reference/yaf/yaf_config_simple/rewind.xml M reference/yaf/yaf_config_simple/set.xml M reference/yaf/yaf_config_simple/toarray.xml M reference/yaf/yaf_config_simple/valid.xml M reference/yaf/yaf_controller_abstract/construct.xml M reference/yaf/yaf_controller_abstract/display.xml M reference/yaf/yaf_controller_abstract/forward.xml M reference/yaf/yaf_controller_abstract/getinvokearg.xml M reference/yaf/yaf_controller_abstract/getinvokeargs.xml M reference/yaf/yaf_controller_abstract/getmodulename.xml M reference/yaf/yaf_controller_abstract/getname.xml M reference/yaf/yaf_controller_abstract/getrequest.xml M reference/yaf/yaf_controller_abstract/getresponse.xml M reference/yaf/yaf_controller_abstract/getview.xml M reference/yaf/yaf_controller_abstract/getviewpath.xml M reference/yaf/yaf_controller_abstract/init.xml M reference/yaf/yaf_controller_abstract/initview.xml M reference/yaf/yaf_controller_abstract/redirect.xml M reference/yaf/yaf_controller_abstract/render.xml M reference/yaf/yaf_controller_abstract/setviewpath.xml M reference/yaf/yaf_dispatcher/autorender.xml M reference/yaf/yaf_dispatcher/catchexception.xml M reference/yaf/yaf_dispatcher/construct.xml M reference/yaf/yaf_dispatcher/disableview.xml M reference/yaf/yaf_dispatcher/dispatch.xml M reference/yaf/yaf_dispatcher/enableview.xml M reference/yaf/yaf_dispatcher/flushinstantly.xml M reference/yaf/yaf_dispatcher/getapplication.xml M reference/yaf/yaf_dispatcher/getdefaultaction.xml M reference/yaf/yaf_dispatcher/getdefaultcontroller.xml M reference/yaf/yaf_dispatcher/getdefaultmodule.xml M reference/yaf/yaf_dispatcher/getinstance.xml M reference/yaf/yaf_dispatcher/getrequest.xml M reference/yaf/yaf_dispatcher/getrouter.xml M reference/yaf/yaf_dispatcher/initview.xml M reference/yaf/yaf_dispatcher/registerplugin.xml M reference/yaf/yaf_dispatcher/returnresponse.xml M reference/yaf/yaf_dispatcher/setdefaultaction.xml M reference/yaf/yaf_dispatcher/setdefaultcontroller.xml M reference/yaf/yaf_dispatcher/setdefaultmodule.xml M reference/yaf/yaf_dispatcher/seterrorhandler.xml M reference/yaf/yaf_dispatcher/setrequest.xml M reference/yaf/yaf_dispatcher/setview.xml M reference/yaf/yaf_dispatcher/throwexception.xml M reference/yaf/yaf_exception/construct.xml M reference/yaf/yaf_exception/getprevious.xml M reference/yaf/yaf_loader/autoload.xml M reference/yaf/yaf_loader/clearlocalnamespace.xml M reference/yaf/yaf_loader/construct.xml M reference/yaf/yaf_loader/getinstance.xml M reference/yaf/yaf_loader/getlibrarypath.xml M reference/yaf/yaf_loader/getlocalnamespace.xml M reference/yaf/yaf_loader/getnamespacepath.xml M reference/yaf/yaf_loader/getnamespaces.xml M reference/yaf/yaf_loader/import.xml M reference/yaf/yaf_loader/islocalname.xml M reference/yaf/yaf_loader/registerlocalnamespace.xml M reference/yaf/yaf_loader/registernamespace.xml M reference/yaf/yaf_loader/setlibrarypath.xml M reference/yaf/yaf_plugin_abstract/dispatchloopshutdown.xml M reference/yaf/yaf_plugin_abstract/dispatchloopstartup.xml M reference/yaf/yaf_plugin_abstract/postdispatch.xml M reference/yaf/yaf_plugin_abstract/predispatch.xml M reference/yaf/yaf_plugin_abstract/preresponse.xml M reference/yaf/yaf_plugin_abstract/routershutdown.xml M reference/yaf/yaf_plugin_abstract/routerstartup.xml M reference/yaf/yaf_registry/construct.xml M reference/yaf/yaf_registry/del.xml M reference/yaf/yaf_registry/get.xml M reference/yaf/yaf_registry/has.xml M reference/yaf/yaf_registry/set.xml M reference/yaf/yaf_request_abstract/clearparams.xml M reference/yaf/yaf_request_abstract/getactionname.xml M reference/yaf/yaf_request_abstract/getbaseuri.xml M reference/yaf/yaf_request_abstract/getcontrollername.xml M reference/yaf/yaf_request_abstract/getenv.xml M reference/yaf/yaf_request_abstract/getexception.xml M reference/yaf/yaf_request_abstract/getlanguage.xml M reference/yaf/yaf_request_abstract/getmethod.xml M reference/yaf/yaf_request_abstract/getmodulename.xml M reference/yaf/yaf_request_abstract/getparam.xml M reference/yaf/yaf_request_abstract/getparams.xml M reference/yaf/yaf_request_abstract/getrequesturi.xml M reference/yaf/yaf_request_abstract/getserver.xml M reference/yaf/yaf_request_abstract/iscli.xml M reference/yaf/yaf_request_abstract/isdispatched.xml M reference/yaf/yaf_request_abstract/isget.xml M reference/yaf/yaf_request_abstract/ishead.xml M reference/yaf/yaf_request_abstract/isoptions.xml M reference/yaf/yaf_request_abstract/ispost.xml M reference/yaf/yaf_request_abstract/isput.xml M reference/yaf/yaf_request_abstract/isrouted.xml M reference/yaf/yaf_request_abstract/isxmlhttprequest.xml M reference/yaf/yaf_request_abstract/setactionname.xml M reference/yaf/yaf_request_abstract/setbaseuri.xml M reference/yaf/yaf_request_abstract/setcontrollername.xml M reference/yaf/yaf_request_abstract/setdispatched.xml M reference/yaf/yaf_request_abstract/setmodulename.xml M reference/yaf/yaf_request_abstract/setparam.xml M reference/yaf/yaf_request_abstract/setrequesturi.xml M reference/yaf/yaf_request_abstract/setrouted.xml M reference/yaf/yaf_request_http/construct.xml M reference/yaf/yaf_request_simple/construct.xml M reference/yaf/yaf_response_abstract/appendbody.xml M reference/yaf/yaf_response_abstract/clearbody.xml M reference/yaf/yaf_response_abstract/clearheaders.xml M reference/yaf/yaf_response_abstract/construct.xml M reference/yaf/yaf_response_abstract/getbody.xml M reference/yaf/yaf_response_abstract/getheader.xml M reference/yaf/yaf_response_abstract/prependbody.xml M reference/yaf/yaf_response_abstract/response.xml M reference/yaf/yaf_response_abstract/setallheaders.xml M reference/yaf/yaf_response_abstract/setbody.xml M reference/yaf/yaf_response_abstract/setheader.xml M reference/yaf/yaf_response_abstract/setredirect.xml M reference/yaf/yaf_response_abstract/tostring.xml M reference/yaf/yaf_route_interface/assemble.xml M reference/yaf/yaf_route_interface/route.xml M reference/yaf/yaf_route_map/construct.xml M reference/yaf/yaf_route_map/route.xml M reference/yaf/yaf_route_regex/construct.xml M reference/yaf/yaf_route_regex/route.xml M reference/yaf/yaf_route_rewrite/route.xml M reference/yaf/yaf_route_simple/construct.xml M reference/yaf/yaf_route_simple/route.xml M reference/yaf/yaf_route_static/match.xml M reference/yaf/yaf_route_static/route.xml M reference/yaf/yaf_route_supervar/construct.xml M reference/yaf/yaf_route_supervar/route.xml M reference/yaf/yaf_router/construct.xml M reference/yaf/yaf_router/getcurrentroute.xml M reference/yaf/yaf_router/getroute.xml M reference/yaf/yaf_router/getroutes.xml M reference/yaf/yaf_router/route.xml M reference/yaf/yaf_session/construct.xml M reference/yaf/yaf_session/count.xml M reference/yaf/yaf_session/current.xml M reference/yaf/yaf_session/del.xml M reference/yaf/yaf_session/get.xml M reference/yaf/yaf_session/getinstance.xml M reference/yaf/yaf_session/has.xml M reference/yaf/yaf_session/isset.xml M reference/yaf/yaf_session/key.xml M reference/yaf/yaf_session/next.xml M reference/yaf/yaf_session/offsetexists.xml M reference/yaf/yaf_session/offsetget.xml M reference/yaf/yaf_session/offsetset.xml M reference/yaf/yaf_session/offsetunset.xml M reference/yaf/yaf_session/rewind.xml M reference/yaf/yaf_session/set.xml M reference/yaf/yaf_session/start.xml M reference/yaf/yaf_session/unset.xml M reference/yaf/yaf_session/valid.xml M reference/yaf/yaf_view_interface/assign.xml M reference/yaf/yaf_view_interface/display.xml M reference/yaf/yaf_view_interface/getscriptpath.xml M reference/yaf/yaf_view_interface/render.xml M reference/yaf/yaf_view_interface/setscriptpath.xml M reference/yaf/yaf_view_simple/assign.xml M reference/yaf/yaf_view_simple/assignref.xml M reference/yaf/yaf_view_simple/clear.xml M reference/yaf/yaf_view_simple/construct.xml M reference/yaf/yaf_view_simple/display.xml M reference/yaf/yaf_view_simple/eval.xml M reference/yaf/yaf_view_simple/get.xml M reference/yaf/yaf_view_simple/getscriptpath.xml M reference/yaf/yaf_view_simple/isset.xml M reference/yaf/yaf_view_simple/render.xml M reference/yaf/yaf_view_simple/set.xml M reference/yaf/yaf_view_simple/setscriptpath.xml Diff exceeded maximum size.