Class File

Representation of a managed file.

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

Extended by

ICanBoogie\ActiveRecord

Extended by

Icybee\Modules\Nodes\Node implements Brickrouge\CSSClassNames uses Brickrouge\CSSClassNamesProperty, ICanBoogie\ActiveRecord\CreatedAtProperty, ICanBoogie\ActiveRecord\UpdatedAtProperty

Extended by

Icybee\Modules\Files\File

Direct known subclasses

Icybee\Modules\Images\Image

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

Methods summary

`public`	# `__construct( string\|Icybee\Modules\Files\Model $model = 'files' )` Defaults the model to "files". Defaults the model to "files". Parameters `$model` `string\|Icybee\Modules\Files\Model` $model The model managing the active record. A `Icybee\Modules\Files\Model` instance can be specified as well as a model identifier. If a model identifier is specified, the model is resolved when the $model property is accessed. Throws `InvalidArgumentException` if $model is neither a model identifier nor a `Icybee\Modules\Files\Model` instance. Overrides `Icybee\Modules\Nodes\Node::__construct`
`public integer`	# `save( )` If `Icybee\Modules\Files\File::HTTP_FILE` is defined, the `ICanBoogie\HTTP\File` instance is used to set the `Icybee\Modules\Files\File::$mime` and `Icybee\Modules\Files\File::$size` properties, as well as the `Icybee\Modules\Nodes\Node::$title` property if it is empty. If `Icybee\Modules\Files\File::HTTP_FILE` is defined, the `ICanBoogie\HTTP\File` instance is used to set the `Icybee\Modules\Files\File::$mime` and `Icybee\Modules\Files\File::$size` properties, as well as the `Icybee\Modules\Nodes\Node::$title` property if it is empty. After the record is saved, the `Icybee\Modules\Files\File::HTTP_FILE` property is removed. Also, the `Icybee\Modules\Files\File::$path` property is updated. Returns `integer` Primary key value of the active record. Overrides `Icybee\Modules\Nodes\Node::save`
`protected string`	# `get_extension( )` Returns the extension of the file. Returns the extension of the file. Note: The dot is included e.g. ".zip". Returns `string`
`public`	# `url( mixed $type = 'view' )`

Methods inherited from Icybee\Modules\Nodes\Node

__get(), alter_persistent_properties(), get_constructor(), get_css_class_names(), get_language(), get_site(), get_slug(), get_user(), lazy_get_native(), lazy_get_next(), lazy_get_previous(), lazy_get_translation(), lazy_get_translations(), lazy_get_translations_keys(), set_site(), set_user(), translation()

Methods inherited from ICanBoogie\ActiveRecord

__sleep(), delete(), get_model(), get_model_id()

Methods inherited from ICanBoogie\Object

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

Methods inherited from Brickrouge\CSSClassNames

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from Brickrouge\CSSClassNamesProperty

css_class(), get_css_class()

Methods used from ICanBoogie\ActiveRecord\CreatedAtProperty

get_created_at(), set_created_at()

Methods used from ICanBoogie\ActiveRecord\UpdatedAtProperty

get_updated_at(), set_updated_at()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

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

Magic methods summary

Constants summary

`string`	`PATH`	`'path'`	#
`string`	`MIME`	`'mime'`	#
`string`	`SIZE`	`'size'`	#
`string`	`DESCRIPTION`	`'description'`	#
`string`	`HTTP_FILE`	`'file'`	#

Constants inherited from Icybee\Modules\Nodes\Node

CONSTRUCTOR, CREATED_AT, IS_ONLINE, LANGUAGE, NATIVEID, NID, SITEID, SLUG, TITLE, UID, UPDATED_AT, UUID

Properties summary

`public string`	`$path`	# Path of the file, relative to the DOCUMENT_ROOT. Path of the file, relative to the DOCUMENT_ROOT.
`public string`	`$mime`	# MIME type of the file. MIME type of the file.
`public integer`	`$size`	# Size of the file. Size of the file.
`public string`	`$description`	# Description of the file. Description of the file.

Properties inherited from Icybee\Modules\Nodes\Node

$constructor, $is_online, $language, $nativeid, $nid, $siteid, $slug, $title, $uid, $uuid

Properties inherited from ICanBoogie\ActiveRecord

Magic properties

`public read-only string`	`$extension`		# The file extension. If any, the extension includes the dot, e.g. ".zip". The file extension. If any, the extension includes the dot, e.g. ".zip".

Magic properties inherited from Icybee\Modules\Nodes\Node

$created_at, $css_class, $native, $next, $previous, $site, $translation, $updated_at, $user

Magic properties inherited from ICanBoogie\ActiveRecord

$model, $model_id

Magic properties inherited from ICanBoogie\Object

Magic properties used from Brickrouge\CSSClassNamesProperty