mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-12 17:54:44 +02:00
Code Issues Releases Wiki Activity

Improve documentation for $session->close(); method, explaining in detail when you might use the method.

Browse Source
This commit is contained in:
Ryan Cramer
2023-03-17 09:39:08 -04:00
parent f2a1ebb7b4
commit 4960d8f891
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wire/core/Session.php
View File

@@ -1428,7 +1428,11 @@ class Session extends Wire implements \IteratorAggregate {
/** /**
* Manually close the session, before program execution is done * Manually close the session, before program execution is done
* *
* #pw-internal * A user session is limited to rendering one page at a time, unless the session is closed
* early. Use this when you have a request that may take awhile to render (like a request
* rendering a sitemap, etc.) and you don't need to get/save session data. By closing the session
* before starting a render, you can release the session to be available for the user to view
* other pages while the slower page render continues.
* *
*/ */
public function close() { public function close() {