PHP Class phpbb\textreparser\manager

Show file Open project: phpbb/phpbb Class Usage Examples

Protected Properties

Property Type Description
$config phpbb\config\config
$config_text phpbb\config\db_text
$reparsers phpbb\di\service_collection
$resume_data array

Public Methods

Method Description
__construct ( phpbb\config\config $config, phpbb\config\db_text $config_text, phpbb\di\service_collection $reparsers ) Constructor
find_reparser ( string $name ) : string Finds a reparser by name.
get_resume_data ( string $name ) : array Loads resume data from the database
schedule ( string $name, integer $interval ) Sets the interval for a text_reparser cron task
schedule_all ( integer $interval ) Sets the interval for all text_reparser cron tasks
update_resume_data ( string $name, integer $min, integer $current, integer $size, boolean $update_db = true ) Updates the resume data in the database

Method Details

__construct() public method

Constructor
public __construct ( phpbb\config\config $config, phpbb\config\db_text $config_text, phpbb\di\service_collection $reparsers )
$config phpbb\config\config
$config_text phpbb\config\db_text
$reparsers phpbb\di\service_collection

find_reparser() public method

If there is no reparser with the specified name, null is returned.
public find_reparser ( string $name ) : string
$name string Name of the reparser to look up.
return string A reparser service name, or null.

get_resume_data() public method

Loads resume data from the database
public get_resume_data ( string $name ) : array
$name string Name of the reparser to which the resume data belongs
return array

schedule() public method

Sets the interval for a text_reparser cron task
public schedule ( string $name, integer $interval )
$name string Name of the reparser to schedule
$interval integer Interval in seconds, 0 to disable the cron task

schedule_all() public method

Sets the interval for all text_reparser cron tasks
public schedule_all ( integer $interval )
$interval integer Interval in seconds, 0 to disable the cron task

update_resume_data() public method

Updates the resume data in the database
public update_resume_data ( string $name, integer $min, integer $current, integer $size, boolean $update_db = true )
$name string Name of the reparser to which the resume data belongs
$min integer Lowest record ID
$current integer Current record ID
$size integer Number of records to process at a time
$update_db boolean True if the resume data should be written to the database, false if not. (default: true)

Property Details

$config protected property

protected config,phpbb\config $config
return phpbb\config\config

$config_text protected property

protected db_text,phpbb\config $config_text
return phpbb\config\db_text

$reparsers protected property

protected service_collection,phpbb\di $reparsers
return phpbb\di\service_collection

$resume_data protected property

protected array $resume_data
return array