yfix/yf

<?php

/**
 * sphinx_config_section
 * Represents a single section inside the sphinx configuration.
 */
class yf_manage_sphinx_config_section
{
    public $name;
    public $comment;
    public $end_comment;
    public $variables = [];

    /**
     * Construct a new section.
     *
     * @param    string    $name        Name of the section
     * @param    string    $comment    Comment that should be appended after the name in the
     *                                textual format.
     */
    public function __construct($name, $comment)
    {
        $this->name = $name;
        $this->comment = $comment;
        $this->end_comment = '';
    }

    /**
     * Add a variable object to the list of variables in this section.
     *
     * @param    sphinx_config_variable    $variable    The variable object
     */
    public function add_variable($variable)
    {
        $this->variables[] = $variable;
    }

    /**
     * Adds a comment after the closing bracket in the textual representation.
     * @param mixed $end_comment
     */
    public function set_end_comment($end_comment)
    {
        $this->end_comment = $end_comment;
    }

    /**
     * Getter for the name of this section.
     *
     * @return    string    Section's name
     */
    public function get_name()
    {
        return $this->name;
    }

    /**
     * Get a variable object by its name.
     *
     * @param    string                     $name    The name of the variable that shall be returned
     * @return    sphinx_config_section            The first variable object from this section with the
     *                                            given name or null if none was found
     */
    public function &get_variable_by_name($name)
    {
        for ($i = 0, $n = count($this->variables); $i < $n; $i++) {
            // make sure this is a variable object and not a comment
            if (is_a($this->variables[$i], 'sphinx_config_variable') && $this->variables[$i]->get_name() == $name) {
                return $this->variables[$i];
            }
        }
        $null = null;
        return $null;
    }

    /**
     * Deletes all variables with the given name.
     *
     * @param    string    $name    The name of the variable objects that are supposed to be removed
     */
    public function delete_variables_by_name($name)
    {
        for ($i = 0; $i < count($this->variables); $i++) {
            // make sure this is a variable object and not a comment
            if (is_a($this->variables[$i], 'sphinx_config_variable') && $this->variables[$i]->get_name() == $name) {
                array_splice($this->variables, $i, 1);
                $i--;
            }
        }
    }

    /**
     * Create a new variable object and append it to the variable list of this section.
     *
     * @param    string                    $name    The name for the new variable
     * @param    string                    $value    The value for the new variable
     * @return    sphinx_config_variable            Variable object that was created
     */
    public function &create_variable($name, $value)
    {
        $this->variables[] = new sphinx_config_variable($name, $value, '');
        return $this->variables[count($this->variables) - 1];
    }

    /**
     * Turns this object into a string which can be written to a config file.
     *
     * @return    string    Config data in textual form, parsable for sphinx
     */
    public function to_string()
    {
        $content = $this->name . ' ' . $this->comment . "\n{\n";

        // make sure we don't get too many newlines after the opening bracket
        while ($this->variables && trim($this->variables[0]->to_string()) == '') {
            array_shift($this->variables);
        }
        foreach ((array) $this->variables as $variable) {
            $content .= $variable->to_string();
        }
        $content .= '}' . $this->end_comment . "\n";

        return $content;
    }
}