Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-02-03 06:45:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for WebRoot.

Browse Source
This commit is contained in:
Relintai 2022-08-21 17:13:06 +02:00
parent 20c0a91275
commit 7cc171ebe7
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
modules/web/doc_classes/WebRoot.xml
View File

@ -3,6 +3,9 @@
<brief_description> <brief_description>
</brief_description> </brief_description>
<description> <description>
It adds some functionality over [WebNode]s that you need for functional websites, like wwwroot handling, Middleware support, and also requests can register themselves to be notified in case they need to do some special tasks.
When a request is received, WebRoot goes through all it's registered [WebServerMiddleware] in order, and call their on_before_handle_request_main() method. If it returns true that means the middleware ended up handling that request, which means the request should not be processed further. This usually means that the Middleware sent an error.
If none of the [WebServerMiddleware]s handled the request, then routing begins. At first it will check if the request matches a file from the given wwwroot, if not, then it will use the default [WebNode] routing, except the only difference, is that if a [WebRoot]s has a [WebNode] child with it's uri_segment set to "/" (withot quotes), that will be used as the root [WebNode], instead of itself.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -11,12 +14,14 @@
<return type="bool" /> <return type="bool" />
<argument index="0" name="request" type="WebServerRequest" /> <argument index="0" name="request" type="WebServerRequest" />
<description> <description>
Precesses the [WebServerRequest] using registered [WebServerMiddleware].
</description> </description>
</method> </method>
<method name="register_request_update"> <method name="register_request_update">
<return type="void" /> <return type="void" />
<argument index="0" name="request" type="WebServerRequest" /> <argument index="0" name="request" type="WebServerRequest" />
<description> <description>
Registers the [WebServerRequest], to receive update notifications.
</description> </description>
</method> </method>
<method name="send_file"> <method name="send_file">
@ -24,27 +29,33 @@
<argument index="0" name="path" type="String" /> <argument index="0" name="path" type="String" />
<argument index="1" name="request" type="WebServerRequest" /> <argument index="1" name="request" type="WebServerRequest" />
<description> <description>
Helper method to easily sends files from the wwwroot.
</description> </description>
</method> </method>
<method name="try_send_wwwroot_file"> <method name="try_send_wwwroot_file">
<return type="bool" /> <return type="bool" />
<argument index="0" name="request" type="WebServerRequest" /> <argument index="0" name="request" type="WebServerRequest" />
<description> <description>
Helper method that tries to send files from the wwwroot, if the file doesn't exists, returns false.
</description> </description>
</method> </method>
<method name="unregister_request_update"> <method name="unregister_request_update">
<return type="void" /> <return type="void" />
<argument index="0" name="request" type="WebServerRequest" /> <argument index="0" name="request" type="WebServerRequest" />
<description> <description>
unregisters the [WebServerRequest], so it doesn't receive update notifications anymore.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="middlewares" type="Array" setter="set_middlewares" getter="get_middlewares" default="[ ]"> <member name="middlewares" type="Array" setter="set_middlewares" getter="get_middlewares" default="[ ]">
The registered [WebServerMiddleware]s.
</member> </member>
<member name="www_root_file_cache" type="FileCache" setter="" getter="get_www_root_file_cache"> <member name="www_root_file_cache" type="FileCache" setter="" getter="get_www_root_file_cache">
You can get the underlying [FileCache], that is used for handling the wwwroot.
</member> </member>
<member name="www_root_path" type="String" setter="set_www_root_path" getter="get_www_root_path" default="&quot;&quot;"> <member name="www_root_path" type="String" setter="set_www_root_path" getter="get_www_root_path" default="&quot;&quot;">
The wwwroot's path.
</member> </member>
</members> </members>
<constants> <constants>