1
0
mirror of https://github.com/processwire/processwire.git synced 2025-08-09 08:17:12 +02:00

Fix additional phpdoc typos per processwire/processwire-issues#797

This commit is contained in:
Ryan Cramer
2019-02-14 08:01:39 -05:00
parent a993a14de9
commit 126c1392d4
3 changed files with 7 additions and 5 deletions

View File

@@ -47,7 +47,7 @@
* @property-read string $httpUrl URL to the file on the server including scheme and hostname. * @property-read string $httpUrl URL to the file on the server including scheme and hostname.
* @property-read string $URL Same as $url property but with browser cache busting query string appended. #pw-group-other * @property-read string $URL Same as $url property but with browser cache busting query string appended. #pw-group-other
* @property-read string $HTTPURL Same as the cache-busting uppercase “URL” property, but includes scheme and hostname. #pw-group-other * @property-read string $HTTPURL Same as the cache-busting uppercase “URL” property, but includes scheme and hostname. #pw-group-other
* @property-read string $filename full disk path to the file on the server. * @property-read string $filename Full disk path to the file on the server.
* @property-read string $name Returns the filename without the path, same as the "basename" property. * @property-read string $name Returns the filename without the path, same as the "basename" property.
* @property-read string $hash Get a unique hash (for the page) representing this Pagefile. * @property-read string $hash Get a unique hash (for the page) representing this Pagefile.
* @property-read array $tagsArray Get file tags as an array. #pw-group-tags @since 3.0.17 * @property-read array $tagsArray Get file tags as an array. #pw-group-tags @since 3.0.17
@@ -1654,7 +1654,7 @@ class Pageimage extends Pagefile {
} }
/** /**
* Render markup for this image (optionally using a provided markup template string and or image size options) * Render markup for this image (optionally using a provided markup template string and/or image size options)
* *
* Given template string can contain any of the placeholders, which will be replaced: * Given template string can contain any of the placeholders, which will be replaced:
* - `{url}` or `{src}` Image URL (typically used for src attribute) * - `{url}` or `{src}` Image URL (typically used for src attribute)
@@ -1708,6 +1708,7 @@ class Pageimage extends Pagefile {
* - If you only need width and/or height, you can specify a width x height string, i.e. 123x456 (use 0 for proportional). * - If you only need width and/or height, you can specify a width x height string, i.e. 123x456 (use 0 for proportional).
* @return string * @return string
* @see Pageimages::render() * @see Pageimages::render()
* @since 3.0.126
* *
*/ */
public function ___render($markup = '', $options = array()) { public function ___render($markup = '', $options = array()) {

View File

@@ -222,6 +222,7 @@ class Pageimages extends Pagefiles {
* - Plus any option available to the $options argument on the `Pageimage::size()` method. * - Plus any option available to the $options argument on the `Pageimage::size()` method.
* - If you only need width and/or height, you can specify a width x height string, i.e. 123x456 (use 0 for proportional). * - If you only need width and/or height, you can specify a width x height string, i.e. 123x456 (use 0 for proportional).
* @return string * @return string
* @since 3.0.126
* *
*/ */
public function ___render($markup = '', $options = array()) { public function ___render($markup = '', $options = array()) {

View File

@@ -21,7 +21,7 @@
* *
* Sanitizer methods are most commonly used with user input. As a result, the methods in this class are also accessible * Sanitizer methods are most commonly used with user input. As a result, the methods in this class are also accessible
* from the `$input->get`, `$input->post` and `$input->cookie` API variables, in the same manner that they are here. * from the `$input->get`, `$input->post` and `$input->cookie` API variables, in the same manner that they are here.
* This is a useful shortcut for intances where you dont need to provide additional arguments to the sanitizer method. * This is a useful shortcut for instances where you dont need to provide additional arguments to the sanitizer method.
* Below are a few examples of this usage: * Below are a few examples of this usage:
* ~~~~~ * ~~~~~
* // get GET variable 'id' as integer * // get GET variable 'id' as integer
@@ -72,7 +72,7 @@
* $cleanValue = $sanitizer->text_entities($dirtyValue); * $cleanValue = $sanitizer->text_entities($dirtyValue);
* ~~~~~ * ~~~~~
* If you append a number to any sanitizer call that returns a string, it is assumed to be maximum allowed length. For * If you append a number to any sanitizer call that returns a string, it is assumed to be maximum allowed length. For
* example the following would sanitize the value to be text of no more than 20 characters: * example, the following would sanitize the value to be text of no more than 20 characters:
* ~~~~~ * ~~~~~
* $cleanValue = $sanitizer->text20($dirtyValue); * $cleanValue = $sanitizer->text20($dirtyValue);
* ~~~~~ * ~~~~~
@@ -83,7 +83,7 @@
* with multiple sanitizer calls. * with multiple sanitizer calls.
* *
* Most methods in the Sanitizer class focus on sanitization rather than validation, with a few exceptions. You can * Most methods in the Sanitizer class focus on sanitization rather than validation, with a few exceptions. You can
* convert ta sanitizer call to validation call by calling the `validate()` method with the name of the sanitizer and the * convert a sanitizer call to validation call by calling the `validate()` method with the name of the sanitizer and the
* value. A validation call simply implies that if the value is modified by sanitization then it is considered invalid * value. A validation call simply implies that if the value is modified by sanitization then it is considered invalid
* and thus itll return a non-value rather than a sanitized value. See the `Sanitizer::validate()` and * and thus itll return a non-value rather than a sanitized value. See the `Sanitizer::validate()` and
* `Sanitizer::valid()` methods for usage details. * `Sanitizer::valid()` methods for usage details.