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

Fix typos in documentation per processwire/processwire-issues#797

Browse Source
This commit is contained in:
Ryan Cramer
2022-05-09 11:05:55 -04:00
parent c8ecf3f51d
commit d3a5b4170a
7 changed files with 32 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wire/core/Inputfield.php
View File

@@ -651,7 +651,7 @@ abstract class Inputfield extends WireData implements Module {
* *
* - For most public API use, you might consider using the the shorter `Inputfield::attr()` method instead. * - For most public API use, you might consider using the the shorter `Inputfield::attr()` method instead.
* *
* - When setting the `class` attribute is is preferable to use the `Inputfield::addClass()` method. * - When setting the `class` attribute it is preferable to use the `Inputfield::addClass()` method.
* *
* - The `$key` argument may contain multiple keys by being specified as an array, or by being a string with multiple * - The `$key` argument may contain multiple keys by being specified as an array, or by being a string with multiple
* keys separated by "+" or "|", for example: `$inputfield->setAttribute("id+name", "template")`. * keys separated by "+" or "|", for example: `$inputfield->setAttribute("id+name", "template")`.

2
wire/core/Module.php
View File

@@ -312,7 +312,7 @@
* The method should prepare the environment with anything else needed by the module, such as newly created * The method should prepare the environment with anything else needed by the module, such as newly created
* fields, pages, templates, etc. or installation of other modules. * fields, pages, templates, etc. or installation of other modules.
* *
* If the install() method determines that the module called be installed for some reason, it should * If the install() method determines that the module cannot be installed for some reason, it should
* throw a `WireException.` * throw a `WireException.`
* *
* ### uninstall() * ### uninstall()

2
wire/core/PageArray.php
View File

@@ -75,7 +75,7 @@ class PageArray extends PaginatedArray implements WirePaginatable {
protected $keyIndex = array(); protected $keyIndex = array();
/** /**
* Template mehod that descendant classes may use to validate items added to this WireArray * Template method that descendant classes may use to validate items added to this WireArray
* *
* #pw-internal * #pw-internal
* *

2
wire/core/Sanitizer.php
View File

@@ -1749,7 +1749,7 @@ class Sanitizer extends Wire {
* @param string $value String you want to convert * @param string $value String you want to convert
* @param array $options Options to modify default behavior: * @param array $options Options to modify default behavior:
* - `newline` (string): Character(s) to replace newlines with (default="\n"). * - `newline` (string): Character(s) to replace newlines with (default="\n").
* - `separator` (string): Character(s) to separate HTML <li> items with (default="\n"). * - `separator` (string): Character(s) to separate HTML `<li>` items with (default="\n").
* - `entities` (bool): Entity encode returned value? (default=false). * - `entities` (bool): Entity encode returned value? (default=false).
* - `trim` (string): Character(s) to trim from beginning and end of value (default=" -,:;|\n\t"). * - `trim` (string): Character(s) to trim from beginning and end of value (default=" -,:;|\n\t").
* @return string Converted string of text * @return string Converted string of text

32
wire/core/Wire.php
View File

@@ -19,7 +19,7 @@
* #pw-summary-changes Methods to support tracking and retrieval of changes made to the object. * #pw-summary-changes Methods to support tracking and retrieval of changes made to the object.
* #pw-summary-hooks Methods for managing hooks for an object instance or class. * #pw-summary-hooks Methods for managing hooks for an object instance or class.
* *
* ProcessWire 3.x, Copyright 2021 by Ryan Cramer * ProcessWire 3.x, Copyright 2022 by Ryan Cramer
* https://processwire.com * https://processwire.com
* *
* #pw-use-constants * #pw-use-constants
@@ -1266,12 +1266,18 @@ abstract class Wire implements WireTranslatable, WireFuelable, WireTrackable {
* *
* @param string|array|Wire $text Text to include in the notice * @param string|array|Wire $text Text to include in the notice
* @param int|bool|string $flags Optional flags to alter default behavior: * @param int|bool|string $flags Optional flags to alter default behavior:
* - `Notice::admin` (constant): Show notice only if user is in the admin.
* - `Notice::allowMarkdown` (constant): Allow basic markdown and bracket markup (see $sanitizer->entitiesMarkdown()).
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags.
* - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active. * - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active.
* - `Notice::log` (constant): Indicates notice should also be logged. * - `Notice::log` (constant): Indicates notice should also be logged.
* - `Notice::logOnly` (constant): Indicates notice should only be logged. * - `Notice::logOnly` (constant): Indicates notice should only be logged.
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags. * - `Notice::login` (constant): Show notice only if it will be seen by a logged-in user.
* - `Notice::noGroup` (constant): Indicates notice should not group with others of the same type (where supported).
* - `Notice::prepend` (constant): Indicates notice should prepend rather than append.
* - `Notice::superuser` (constant): Show notice only if current user is a superuser.
* - `true` (boolean): Shortcut for the `Notice::log` constant. * - `true` (boolean): Shortcut for the `Notice::log` constant.
* - In 3.0.149+ you may also specify a space-separated string of flag names. * - In 3.0.149+ you may also specify a space-separated string of flag names, i.e. "admin log noGroup".
* @return $this * @return $this
* @see Wire::messages(), Wire::warning(), Wire::error() * @see Wire::messages(), Wire::warning(), Wire::error()
* *
@@ -1297,12 +1303,18 @@ abstract class Wire implements WireTranslatable, WireFuelable, WireTrackable {
* *
* @param string|array|Wire $text Text to include in the notice * @param string|array|Wire $text Text to include in the notice
* @param int|bool|string $flags Optional flags to alter default behavior: * @param int|bool|string $flags Optional flags to alter default behavior:
* - `Notice::admin` (constant): Show notice only if user is in the admin.
* - `Notice::allowMarkdown` (constant): Allow basic markdown and bracket markup (see $sanitizer->entitiesMarkdown()).
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags.
* - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active. * - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active.
* - `Notice::log` (constant): Indicates notice should also be logged. * - `Notice::log` (constant): Indicates notice should also be logged.
* - `Notice::logOnly` (constant): Indicates notice should only be logged. * - `Notice::logOnly` (constant): Indicates notice should only be logged.
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags. * - `Notice::login` (constant): Show notice only if it will be seen by a logged-in user.
* - `Notice::noGroup` (constant): Indicates notice should not group with others of the same type (where supported).
* - `Notice::prepend` (constant): Indicates notice should prepend rather than append.
* - `Notice::superuser` (constant): Show notice only if current user is a superuser.
* - `true` (boolean): Shortcut for the `Notice::log` constant. * - `true` (boolean): Shortcut for the `Notice::log` constant.
* - In 3.0.149+ you may also specify a space-separated string of flag names. * - In 3.0.149+ you may also specify a space-separated string of flag names, i.e. "admin log noGroup".
* @return $this * @return $this
* @see Wire::warnings(), Wire::message(), Wire::error() * @see Wire::warnings(), Wire::message(), Wire::error()
* *
@@ -1330,12 +1342,18 @@ abstract class Wire implements WireTranslatable, WireFuelable, WireTrackable {
* *
* @param string|array|Wire $text Text to include in the notice * @param string|array|Wire $text Text to include in the notice
* @param int|bool|string $flags Optional flags to alter default behavior: * @param int|bool|string $flags Optional flags to alter default behavior:
* - `Notice::admin` (constant): Show notice only if user is in the admin.
* - `Notice::allowMarkdown` (constant): Allow basic markdown and bracket markup (see $sanitizer->entitiesMarkdown()).
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags.
* - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active. * - `Notice::debug` (constant): Indicates notice should only be shown when debug mode is active.
* - `Notice::log` (constant): Indicates notice should also be logged. * - `Notice::log` (constant): Indicates notice should also be logged.
* - `Notice::logOnly` (constant): Indicates notice should only be logged. * - `Notice::logOnly` (constant): Indicates notice should only be logged.
* - `Notice::allowMarkup` (constant): Indicates notice should allow the use of HTML markup tags. * - `Notice::login` (constant): Show notice only if it will be seen by a logged-in user.
* - `Notice::noGroup` (constant): Indicates notice should not group with others of the same type (where supported).
* - `Notice::prepend` (constant): Indicates notice should prepend rather than append.
* - `Notice::superuser` (constant): Show notice only if current user is a superuser.
* - `true` (boolean): Shortcut for the `Notice::log` constant. * - `true` (boolean): Shortcut for the `Notice::log` constant.
* - In 3.0.149+ you may also specify a space-separated string of flag names. * - In 3.0.149+ you may also specify a space-separated string of flag names, i.e. "admin log noGroup".
* @return $this * @return $this
* @see Wire::errors(), Wire::message(), Wire::warning() * @see Wire::errors(), Wire::message(), Wire::warning()
* *

2
wire/core/WireDatabasePDO.php
View File

@@ -1461,7 +1461,7 @@ class WireDatabasePDO extends Wire implements WireDatabase {
} }
/** /**
* Escape a string value, same as $db->quote() but without surrounding quotes * Escape a string value, same as $database->quote() but without surrounding quotes
* *
* #pw-group-sanitization * #pw-group-sanitization
* *

2
wire/core/WireInput.php
View File

@@ -378,7 +378,7 @@ class WireInput extends Wire {
* *
* The whitelist is a list of variables specifically set by the application as sanitized for use elsewhere in the application. * The whitelist is a list of variables specifically set by the application as sanitized for use elsewhere in the application.
* This whitelist is not specifically used by ProcessWire unless you populate it from your templates or the API. * This whitelist is not specifically used by ProcessWire unless you populate it from your templates or the API.
* When populated, it is used by the MarkupPagerNav module (for instance) to ensure that sanitizedd query string (GET) variables * When populated, it is used by the MarkupPagerNav module (for instance) to ensure that sanitized query string (GET) variables
* are maintained across paginations. * are maintained across paginations.
* *
* ~~~~~ * ~~~~~