1. class
  2. phpbb
  3. \
  4. search
  5. \
  6. backend
  7. \
  8. sphinx
  9. \
  10. config_section

config_section

class config_section extends config_item

\phpbb\search\backend\sphinx\config_section Represents a single section inside the sphinx configuration

Properties

protected string $name from  config_item

Methods

string
get_name()

Getter for the item's name

from  config_item
string
to_string()

Turns this object into a string which can be written to a config file

__construct(string $name, string $comment)

Construct a new section

void
set_end_comment(string $end_comment)

Adds a comment after the closing bracket in the textual representation

config_variable|null
get_variable_by_name(string $name)

Get a variable object by its name

delete_variables_by_name(string $name)

Deletes all variables with the given name

config_variable
create_variable(string $name, string $value)

Create a new variable object and append it to the variables list of this section

Details

in config_item at line 30
string get_name()

Getter for the item's name

Return Value

string

The item object's name

at line 114
string to_string()

Turns this object into a string which can be written to a config file

Return Value

string

String representation of config item

at line 38
__construct(string $name, string $comment)

Construct a new section

Parameters

string $name

Name of the section
string $comment

Comment that should be appended after the name in the textual format.

at line 50
void set_end_comment(string $end_comment)

Adds a comment after the closing bracket in the textual representation

Parameters

string $end_comment

Return Value

void

at line 63
config_variable|null get_variable_by_name(string $name)

Get a variable object by its name

Parameters

string $name

The name of the variable that shall be returned

Return Value

config_variable|null

The first variable object from this section with the given name or null if none was found

at line 82
delete_variables_by_name(string $name)

Deletes all variables with the given name

Parameters

string $name

The name of the variable objects that are supposed to be removed

at line 103
config_variable create_variable(string $name, string $value)

Create a new variable object and append it to the variables list of this section

Parameters

string $name

The name for the new variable
string $value

The value for the new variable

Return Value

config_variable

Variable object that was created