DieSchittigs-ContaoContentApiBundle-File.md

DieSchittigs\ContaoContentApiBundle\File

File augments FilesModel for the API.

• Class name: File
• Namespace: DieSchittigs\ContaoContentApiBundle
• Parent class: DieSchittigs\ContaoContentApiBundle\AugmentedContaoModel

Properties

$fileObj

private mixed $fileObj = array('id', 'uuid', 'name', 'extension', 'singleSRC', 'meta', 'size', 'filesModel')

• Visibility: private
• This property is static.

$model

public mixed $model = null

• Visibility: public

Methods

__construct

mixed DieSchittigs\ContaoContentApiBundle\File::__construct(string $uuid, mixed $size)

constructor.

• Visibility: public

Arguments

• $uuid string - <p>uuid of the FilesModel</p>
• $size mixed - <p>Object or serialized string representing the (image) size</p>

children

mixed DieSchittigs\ContaoContentApiBundle\File::children(string $uuid, integer $depth)

Recursively load file (directory) children.

• Visibility: private
• This method is static.

Arguments

• $uuid string - <p>uuid of the FilesModel</p>
• $depth integer - <p>How deep do you want to fetch children?</p>

get

mixed DieSchittigs\ContaoContentApiBundle\File::get(string $path, integer $depth)

Recursively load file by path.

• Visibility: public
• This method is static.

Arguments

• $path string - <p>Path of the FilesModel</p>
• $depth integer - <p>How deep do you want to fetch children?</p>

toJson

mixed DieSchittigs\ContaoContentApiBundle\ContaoJsonSerializable::toJson()

• Visibility: public
• This method is defined by DieSchittigs\ContaoContentApiBundle\ContaoJsonSerializable

__get

mixed DieSchittigs\ContaoContentApiBundle\AugmentedContaoModel::__get(string $property)

Get the value from the attached model.

• Visibility: public
• This method is defined by DieSchittigs\ContaoContentApiBundle\AugmentedContaoModel

Arguments

• $property string - <p>key</p>

__set

mixed DieSchittigs\ContaoContentApiBundle\AugmentedContaoModel::__set(string $property, mixed $value)

Set the value in the attached model.

• Visibility: public
• This method is defined by DieSchittigs\ContaoContentApiBundle\AugmentedContaoModel

Arguments

• $property string - <p>key</p>
• $value mixed - <p>value</p>