From 126c1392d42681cdb8803274d204b7941b8cb675 Mon Sep 17 00:00:00 2001 From: Ryan Cramer Date: Thu, 14 Feb 2019 08:01:39 -0500 Subject: [PATCH] Fix additional phpdoc typos per processwire/processwire-issues#797 --- wire/core/Pageimage.php | 5 +++-- wire/core/Pageimages.php | 1 + wire/core/Sanitizer.php | 6 +++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/wire/core/Pageimage.php b/wire/core/Pageimage.php index 4a4a3bf4..0daa87b8 100644 --- a/wire/core/Pageimage.php +++ b/wire/core/Pageimage.php @@ -47,7 +47,7 @@ * @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 $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 $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 @@ -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: * - `{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). * @return string * @see Pageimages::render() + * @since 3.0.126 * */ public function ___render($markup = '', $options = array()) { diff --git a/wire/core/Pageimages.php b/wire/core/Pageimages.php index c0c1f25c..e45bcbde 100644 --- a/wire/core/Pageimages.php +++ b/wire/core/Pageimages.php @@ -222,6 +222,7 @@ class Pageimages extends Pagefiles { * - 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). * @return string + * @since 3.0.126 * */ public function ___render($markup = '', $options = array()) { diff --git a/wire/core/Sanitizer.php b/wire/core/Sanitizer.php index 8f36f304..0732dbf3 100644 --- a/wire/core/Sanitizer.php +++ b/wire/core/Sanitizer.php @@ -21,7 +21,7 @@ * * 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. - * This is a useful shortcut for intances where you don’t need to provide additional arguments to the sanitizer method. + * This is a useful shortcut for instances where you don’t need to provide additional arguments to the sanitizer method. * Below are a few examples of this usage: * ~~~~~ * // get GET variable 'id' as integer @@ -72,7 +72,7 @@ * $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 - * 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); * ~~~~~ @@ -83,7 +83,7 @@ * with multiple sanitizer calls. * * 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 * and thus it’ll return a non-value rather than a sanitized value. See the `Sanitizer::validate()` and * `Sanitizer::valid()` methods for usage details.