1. class
  2. phpbb
  3. \
  4. storage
  5. \
  6. controller
  7. \
  8. avatar

avatar

class avatar extends controller

Controller for /download/avatar/{file} routes

Properties

protected service $cache from  controller
protected driver_interface $db from  controller
protected storage $storage from  controller
protected Request $symfony_request from  controller
protected config $config
protected array $allowed_extensions

Methods

__construct(service $cache, config $config, driver_interface $db, storage $storage, Request $symfony_request)

Constructor

Response
handle(string $file)

Handler

bool
is_allowed(string $file)

If the user is allowed to download the file

bool
file_exists(string $file)

Check if file exists

from  controller
void
prepare(StreamedResponse $response, string $file)

Prepare response

void
file_gc()

Garbage Collection

from  controller
string
decode_filename(string $file)

Decode avatar filename

Details

at line 45
__construct(service $cache, config $config, driver_interface $db, storage $storage, Request $symfony_request)

Constructor

Parameters

service $cache
config $config
driver_interface $db
storage $storage
Request $symfony_request

at line 55
Response handle(string $file)

Handler

Parameters

string $file

File path

Return Value

Response

a Symfony response object

Exceptions

http_exception

when can't access $file
exception

when there is an error reading the file

at line 65
protected bool is_allowed(string $file)

If the user is allowed to download the file

Parameters

string $file

File path

Return Value

bool

in controller at line 111
protected bool file_exists(string $file)

Check if file exists

Parameters

string $file

File path

Return Value

bool

at line 99
protected void prepare(StreamedResponse $response, string $file)

Prepare response

Parameters

StreamedResponse $response
string $file

File path

Return Value

void

Exceptions

exception

when there is an error reading the file

in controller at line 183
protected void file_gc()

Garbage Collection

Return Value

void

at line 80
protected string decode_filename(string $file)

Decode avatar filename

Parameters

string $file

Filename

Return Value

string

Filename in filesystem