Zabbix

<?php declare(strict_types = 0);

/*

** Copyright (C) 2001-2025 Zabbix SIA

**

** This program is free software: you can redistribute it and/or modify it under the terms of

** the GNU Affero General Public License as published by the Free Software Foundation, version 3.

**

** 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 Affero General Public License for more details.

**

** You should have received a copy of the GNU Affero General Public License along with this program.

** If not, see <https://www.gnu.org/licenses/>.

**/

​

​

/**

 * Parser is meant to check and extract the string with all backslashes escaped.

 */

class CEscapedStringParser extends CParser {

​

    /**

     * An error message if string is invalid.

     *

     * @var string

     */

    private $error = '';

​

    /**

     * Options for parser customization.

     *

     * @var array

     */

    private $options = [

        'characters' => ''

    ];

​

    public function __construct($options = []) {

        if (!array_key_exists('characters', $options)) {

            $options['characters'] = '';

        }

​

        if (strpos($options['characters'], '\\') === false) {

            $options['characters'] .= '\\';

        }

​

        $this->options['characters'] = $options['characters'];

    }

​

    /**

     * @param string $source

     * @param int    $offset

     *

     * @return int

     */

    public function parse($source, $offset = 0) {

        $this->length = 0;

        $this->match = '';

        $this->error = '';

​

        $result = self::PARSE_SUCCESS;

​

        // Check if all backslash characters in given string are escaped.