Class GetOperation

Get a file.

The file transfert is handled by PHP, the location of the file is not be revealed.

Offline files cannot be obtained by visitors.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

Extended by

ICanBoogie\Operation

Extended by

Icybee\Modules\Files\GetOperation

Direct known subclasses

Icybee\Modules\Files\DownloadOperation

Namespace: Icybee\Modules\Files
Located at vendor/icanboogie-modules/files/lib/operations/get.php

Methods summary

`protected array`	# `get_controls( )` Controls for the operation: record. Controls for the operation: record. Returns `array` All the controls set to false. Overrides `ICanBoogie\Operation::get_controls`
`protected ActiveRecord\|null`	# `control_record( )` Overrides the method to check the availability of the record to the requesting user. Overrides the method to check the availability of the record to the requesting user. Returns `ActiveRecord\|null` Throws `HTTPException` with HTTP code 401, if the user is a guest and the record is offline. Overrides `ICanBoogie\Operation::control_record`
`protected boolean`	# `validate( ICanboogie\Errors $errors )` Validates the operation before processing. Validates the operation before processing. The method is abstract and therefore must be implemented by subclasses. Returns `boolean` true if the operation is valid, false otherwise. Throws `Exception` If something horribly wrong happens.
`protected mixed`	# `process( )` Processes the operation. Processes the operation. The method is abstract and therefore must be implemented by subclasses. Returns `mixed` Depends on the implementation.

Methods inherited from ICanBoogie\Operation

__construct(), __invoke(), control(), control_authentication(), control_form(), control_method(), control_ownership(), control_permission(), control_session_token(), encode(), format_class_name(), from(), from_module_request(), from_request(), from_route(), get_is_forwarded(), get_module(), get_request(), get_response(), lazy_get_form(), lazy_get_properties(), lazy_get_record(), reset()

Methods inherited from ICanBoogie\Object

resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Constants summary

`integer`	`CACHE_MAX_AGE`	`2592000`	#

Constants inherited from ICanBoogie\Operation

CONTROL_AUTHENTICATION, CONTROL_FORM, CONTROL_METHOD, CONTROL_OWNERSHIP, CONTROL_PERMISSION, CONTROL_RECORD, CONTROL_SESSION_TOKEN, DESTINATION, KEY, NAME, RESTFUL_BASE, RESTFUL_BASE_LENGTH, SESSION_TOKEN

Properties summary

Properties inherited from ICanBoogie\Operation

$destination, $form, $format, $key, $method, $module, $properties, $request, $response

Magic properties

`public read-only mixed`	`$record`		# File File

Magic properties inherited from ICanBoogie\Operation

$is_forwarded, $request

Magic properties inherited from ICanBoogie\Object