diff options
Diffstat (limited to 'includes/ConfEditor.php')
| -rw-r--r-- | includes/ConfEditor.php | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/includes/ConfEditor.php b/includes/ConfEditor.php index 42a7173d..b68fc762 100644 --- a/includes/ConfEditor.php +++ b/includes/ConfEditor.php @@ -1,4 +1,24 @@ <?php +/** + * Configuration file editor. + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ /** * This is a state machine style parser with two internal stacks: @@ -139,6 +159,7 @@ class ConfEditor { * insert * Insert a new element at the start of the array. * + * @return string */ public function edit( $ops ) { $this->parse(); @@ -371,6 +392,7 @@ class ConfEditor { * Finds the source byte region which you would want to delete, if $pathName * was to be deleted. Includes the leading spaces and tabs, the trailing line * break, and any comments in between. + * @return array */ function findDeletionRegion( $pathName ) { if ( !isset( $this->pathInfo[$pathName] ) ) { @@ -428,6 +450,7 @@ class ConfEditor { * or semicolon. * * The end position is the past-the-end (end + 1) value as per convention. + * @return array */ function findValueRegion( $pathName ) { if ( !isset( $this->pathInfo[$pathName] ) ) { @@ -444,6 +467,7 @@ class ConfEditor { * Find the path name of the last element in the array. * If the array is empty, this will return the \@extra interstitial element. * If the specified path is not found or is not an array, it will return false. + * @return bool|int|string */ function findLastArrayElement( $path ) { // Try for a real element @@ -480,6 +504,7 @@ class ConfEditor { * Find the path name of first element in the array. * If the array is empty, this will return the \@extra interstitial element. * If the specified path is not found or is not an array, it will return false. + * @return bool|int|string */ function findFirstArrayElement( $path ) { // Try for an ordinary element @@ -504,6 +529,7 @@ class ConfEditor { /** * Get the indent string which sits after a given start position. * Returns false if the position is not at the start of the line. + * @return array */ function getIndent( $pos, $key = false, $arrowPos = false ) { $arrowIndent = ' '; @@ -725,6 +751,7 @@ class ConfEditor { /** * Create a ConfEditorToken from an element of token_get_all() + * @return ConfEditorToken */ function newTokenObj( $internalToken ) { if ( is_array( $internalToken ) ) { @@ -776,6 +803,7 @@ class ConfEditor { /** * Get the token $offset steps ahead of the current position. * $offset may be negative, to get tokens behind the current position. + * @return ConfEditorToken */ function getTokenAhead( $offset ) { $pos = $this->pos + $offset; @@ -821,6 +849,7 @@ class ConfEditor { /** * Pop a state from the state stack. + * @return mixed */ function popState() { return array_pop( $this->stateStack ); @@ -829,6 +858,7 @@ class ConfEditor { /** * Returns true if the user input path is valid. * This exists to allow "/" and "@" to be reserved for string path keys + * @return bool */ function validatePath( $path ) { return strpos( $path, '/' ) === false && substr( $path, 0, 1 ) != '@'; @@ -949,6 +979,7 @@ class ConfEditor { /** * Get a readable name for the given token type. + * @return string */ function getTypeName( $type ) { if ( is_int( $type ) ) { @@ -962,6 +993,7 @@ class ConfEditor { * Looks ahead to see if the given type is the next token type, starting * from the current position plus the given offset. Skips any intervening * whitespace. + * @return bool */ function isAhead( $type, $offset = 0 ) { $ahead = $offset; |