mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-14 02:34:24 +02:00
Code Issues Releases Wiki Activity

Various pre-merge documentation and housekeeping updates

Browse Source
This commit is contained in:
Ryan Cramer
2022-05-13 10:34:30 -04:00
parent b164bc3e23
commit 5636a81d15
21 changed files with 457 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
wire/core/Paths.php
View File

@@ -8,7 +8,7 @@
* #pw-summary-paths-only These properties are only useful when accessed from `$config->paths` as they are not HTTP accessible as URLs.
* #pw-summary-urls-only These properties apply only to the `$urls` or `$config->urls`. Do not use them with `$config->paths`.
* #pw-summary-pagination These properties apply only to the `$urls` or `$config->urls` and only when pagination is active for the current request.
* #pw-var $var
* #pw-var $urls
*
* #pw-body =
* The Paths class is used by `$config->paths` and `$config->urls` (or just `$urls`). The `$config->paths` refers to server disk paths
@@ -47,13 +47,14 @@
* In the examples on this page, you can replace the `$urls` variable with `$config->paths` if you need to get the server path
* instead of a URL. As indicated earlier, `$urls` can aso be accessed at the more verbose `$config->urls` if you prefer.
*
* > Please note in the property/method descriptions below that the placeholder `$var` refers to either `$config->paths` or
* `$config->urls` (or the shorter alias `$urls`). So `$var->files` (for example) refers to either `$config->paths->files`
* or `$config->urls->files` (or the shorter alias `$urls->files`).
* > Please note in the property/method descriptions below that use the placeholder `$urls` refers to either `$config->paths` or
* `$config->urls` (or the shorter alias `$urls`). So `$urls->files` (for example) in the definitions below can refer to either
* `$config->paths->files` or `$config->urls->files` (or the shorter alias `$urls->files`). We use `$urls` here because it’s
* just the shortest option for example purposes.
*
* #pw-body
*
* ProcessWire 3.x, Copyright 2020 by Ryan Cramer
* ProcessWire 3.x, Copyright 2022 by Ryan Cramer
* https://processwire.com
*
* This file is licensed under the MIT license