phpBB API Documentation
Class

phpbb\install\helper\file_updater\file_updater

class file_updater implements file_updater_interface

File updater for direct filesystem access

Methods

__construct(filesystem $filesystem, string $phpbb_root_path)

Constructor

delete_file(string $path_to_file)

Deletes a file

create_new_file(string $path_to_file_to_create, string $source, bool $create_from_content = false)

Creates a new file

update_file(string $path_to_file_to_update, string $source, bool $create_from_content = false)

Update file

string get_method_name()

Returns the name of the file updater method

Details

at line 41
public __construct(filesystem $filesystem, string $phpbb_root_path)

Constructor

Parameters

filesystem $filesystem
string $phpbb_root_path

at line 53
public delete_file(string $path_to_file)

Deletes a file

Parameters

string $path_to_file Path to the file to delete

at line 64
public create_new_file(string $path_to_file_to_create, string $source, bool $create_from_content = false)

Creates a new file

Parameters

string $path_to_file_to_create Path to the new file's location
string $source Path to file to copy or string with the new file's content
bool $create_from_content Whether or not to use $source as the content, false by default

at line 111
public update_file(string $path_to_file_to_update, string $source, bool $create_from_content = false)

Update file

Parameters

string $path_to_file_to_update Path to the file's location
string $source Path to file to copy or string with the new file's content
bool $create_from_content Whether or not to use $source as the content, false by default

at line 198
public string get_method_name()

Returns the name of the file updater method

Return Value

string