class forum_description extends row_based_plugin

Properties

protected string $name from  base
protected bool $save_changes from  base
protected driver_interface $db from  row_based_plugin
protected string $table from  row_based_plugin

Methods

int
get_max_id()

Return the highest ID for all existing records

array
get_records_by_range(int $min_id, int $max_id)

Return all records in given range

save_record(array $record)

{@inheritdoc}

array
add_missing_fields(array $record)

Add fields to given record, if applicable

from  base
string
get_name()

Returns the name of the reparser

from  base
set_name(string $name)

Sets the name of the reparser

from  base
disable_save()

Disable saving changes to the database

from  base
enable_save()

Enable saving changes to the database

from  base
bool
guess_bbcode(array $record, string $bbcode)

Guess whether given BBCode is in use in given record

from  base
bool
guess_bbcodes(array $record)

Guess whether any BBCode is in use in given record

from  base
bool
guess_magic_url(array $record)

Guess whether magic URLs are in use in given record

from  base
bool
guess_smilies(array $record)

Guess whether smilies are in use in given record

from  base
reparse_range(int $min_id, int $max_id)

Reparse all records in given range

from  base
reparse_record(array $record)

Reparse given record

from  base
__construct(driver_interface $db, string $table)

Constructor

array
get_columns()

Return the name of the column that correspond to each field

string
get_records_by_range_query(int $min_id, int $max_id)

Generate the query that retrieves all records for given range

Details

in row_based_plugin at line 50
int get_max_id()

Return the highest ID for all existing records

Return Value

int

in row_based_plugin at line 65
protected array get_records_by_range(int $min_id, int $max_id)

Return all records in given range

Parameters

int $min_id

Lower bound

int $max_id

Upper bound

Return Value

array

Array of records

in row_based_plugin at line 108
protected save_record(array $record)

{@inheritdoc}

Parameters

array $record

in base at line 56
protected array add_missing_fields(array $record)

Add fields to given record, if applicable

The enable_* fields are not always saved to the database. Sometimes we need to guess their original value based on the text content or possibly other fields

Parameters

array $record

Original record

Return Value

array

Complete record

in base at line 102
string get_name()

Returns the name of the reparser

Return Value

string

Name of reparser

in base at line 112
set_name(string $name)

Sets the name of the reparser

Parameters

string $name

The reparser name

in base at line 120
disable_save()

Disable saving changes to the database

in base at line 128
enable_save()

Enable saving changes to the database

in base at line 140
protected bool guess_bbcode(array $record, string $bbcode)

Guess whether given BBCode is in use in given record

Parameters

array $record
string $bbcode

Return Value

bool

in base at line 172
protected bool guess_bbcodes(array $record)

Guess whether any BBCode is in use in given record

Parameters

array $record

Return Value

bool

in base at line 199
protected bool guess_magic_url(array $record)

Guess whether magic URLs are in use in given record

Parameters

array $record

Return Value

bool

in base at line 211
protected bool guess_smilies(array $record)

Guess whether smilies are in use in given record

Parameters

array $record

Return Value

bool

in base at line 219
reparse_range(int $min_id, int $max_id)

Reparse all records in given range

Parameters

int $min_id

Lower bound

int $max_id

Upper bound

in base at line 232
protected reparse_record(array $record)

Reparse given record

Parameters

array $record

Associative array containing the record's data

in row_based_plugin at line 34
__construct(driver_interface $db, string $table)

Constructor

Parameters

driver_interface $db

Database connection

string $table

at line 21
array get_columns()

Return the name of the column that correspond to each field

Return Value

array

in row_based_plugin at line 82
protected string get_records_by_range_query(int $min_id, int $max_id)

Generate the query that retrieves all records for given range

Parameters

int $min_id

Lower bound

int $max_id

Upper bound

Return Value

string

SQL query