1
0
mirror of https://github.com/processwire/processwire.git synced 2025-08-14 02:34:24 +02:00

Clarify wording in phpdoc of Wire::trackChanges() method per processwire/processwire-issues#707

This commit is contained in:
Ryan Cramer
2018-09-25 10:26:02 -04:00
parent f2edf04602
commit bddea16255

View File

@@ -1086,12 +1086,12 @@ abstract class Wire implements WireTranslatable, WireFuelable, WireTrackable {
}
/**
* Returns true if change tracking is on, or false if it is not.
* Returns true or 1 if change tracking is on, or false or 0 if it is not, or mode bitmask (int) if requested.
*
* #pw-group-changes
*
* @param bool $getMode When true, the track changes mode bitmask will be returned rather than a boolean
* @return bool|int
* @param bool $getMode When true, the track changes mode bitmask will be returned
* @return int|bool 0/false if off, 1/true if On, or mode bitmask if requested
*
*/
public function trackChanges($getMode = false) {