[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch




/phpbb/search/sphinx/ -> config_section.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 160 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

config_section:: (8 methods):

Class: config_section  - X-Ref

Represents a single section inside the sphinx configuration

__construct($name, $comment)   X-Ref
Construct a new section

param: string    $name        Name of the section
param: string    $comment    Comment that should be appended after the name in the

add_variable($variable)   X-Ref
Add a variable object to the list of variables in this section

param: \phpbb\search\sphinx\config_variable    $variable    The variable object

set_end_comment($end_comment)   X-Ref
Adds a comment after the closing bracket in the textual representation

param: string    $end_comment

get_name()   X-Ref
Getter for the name of this section

return: string    Section's name

get_variable_by_name($name)   X-Ref
Get a variable object by its name

param: string                                 $name    The name of the variable that shall be returned
return: \phpbb\search\sphinx\config_section            The first variable object from this section with the

delete_variables_by_name($name)   X-Ref
Deletes all variables with the given name

param: string    $name    The name of the variable objects that are supposed to be removed

create_variable($name, $value)   X-Ref
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: \phpbb\search\sphinx\config_variable            Variable object that was created

to_string()   X-Ref
Turns this object into a string which can be written to a config file

return: string    Config data in textual form, parsable for sphinx

Generated: Sat Oct 26 11:28:42 2019 Cross-referenced by PHPXref 0.7.1