UploadFaviconController  

class UploadFaviconController extends UploadImageController

Properties

$serializer from ShowForumController
$include from ShowForumController
string[] $optionalInclude <p>The relationships that are available to be included.</p> from AbstractSerializeController
$maxLimit <p>The maximum number of records that can be requested.</p> from AbstractSerializeController
$limit <p>The number of records included by default.</p> from AbstractSerializeController
string[] $sortFields <p>The fields that are available to be sorted by.</p> from AbstractSerializeController
array<string,string>|null $sort <p>The default sort field and order to use.</p> from AbstractSerializeController
static protected $container from AbstractSerializeController
static protected $beforeDataCallbacks from AbstractSerializeController
static protected $beforeSerializationCallbacks from AbstractSerializeController
static protected string[][] $loadRelations from AbstractSerializeController
static protected array<string,callable> $loadRelationCallables from AbstractSerializeController
protected $uploadDir from UploadImageController
protected $fileExtension from UploadImageController
protected $filePathSettingKey
protected $filenamePrefix

Methods

ResponseInterface
handle(ServerRequestInterface $request)

No description

from AbstractSerializeController
mixed
data(ServerRequestInterface $request, Document $document)

<p>Get the data to be serialized and assigned to the response document.</p>

from UploadImageController
ElementInterface
createElement(mixed $data, SerializerInterface $serializer)

<p>Create a PHP JSON-API Element for output in the document.</p>

from AbstractShowController
array
getRelationsToLoad(Collection $models)

<p>Returns the relations to load added by extenders.</p>

from AbstractSerializeController
array
getRelationCallablesToLoad(Collection $models)

<p>Returns the relation callables to load added by extenders.</p>

from AbstractSerializeController
void
loadRelations(Collection $models, array $relations, ServerRequestInterface $request = null)

<p>Eager loads the required relationships.</p>

from AbstractSerializeController
array
extractInclude(ServerRequestInterface $request)

No description

from AbstractSerializeController
array
extractFields(ServerRequestInterface $request)

No description

from AbstractSerializeController
array|null
extractSort(ServerRequestInterface $request)

No description

from AbstractSerializeController
int
extractOffset(ServerRequestInterface $request)

No description

from AbstractSerializeController
int
extractLimit(ServerRequestInterface $request)

No description

from AbstractSerializeController
array
extractFilter(ServerRequestInterface $request)

No description

from AbstractSerializeController
Parameters
buildParameters(ServerRequestInterface $request)

No description

from AbstractSerializeController
bool
sortIsDefault(ServerRequestInterface $request)

No description

from AbstractSerializeController
void
setSerializer(string $serializer)

<p>Set the serializer that will serialize data for the endpoint.</p>

from AbstractSerializeController
void
addInclude(array|string $name)

<p>Include the given relationship by default.</p>

from AbstractSerializeController
void
removeInclude(array|string $name)

<p>Don't include the given relationship by default.</p>

from AbstractSerializeController
void
addOptionalInclude(array|string $name)

<p>Make the given relationship available for inclusion.</p>

from AbstractSerializeController
void
removeOptionalInclude(array|string $name)

<p>Don't allow the given relationship to be included.</p>

from AbstractSerializeController
void
setLimit(int $limit)

<p>Set the default number of results.</p>

from AbstractSerializeController
void
setMaxLimit(int $max)

<p>Set the maximum number of results.</p>

from AbstractSerializeController
void
addSortField(array|string $field)

<p>Allow sorting results by the given field.</p>

from AbstractSerializeController
void
removeSortField(array|string $field)

<p>Disallow sorting results by the given field.</p>

from AbstractSerializeController
void
setSort(array $sort)

<p>Set the default sort order for the results.</p>

from AbstractSerializeController
static Container
getContainer()

No description

from AbstractSerializeController
static void
setContainer(Container $container)

No description

from AbstractSerializeController
static void
addDataPreparationCallback(string $controllerClass, callable $callback)

No description

from AbstractSerializeController
static void
addSerializationPreparationCallback(string $controllerClass, callable $callback)

No description

from AbstractSerializeController
static void
setLoadRelations(string $controllerClass, array $relations)

No description

from AbstractSerializeController
static void
setLoadRelationCallables(string $controllerClass, array $relations)

No description

from AbstractSerializeController
__construct(SettingsRepositoryInterface $settings, Factory $filesystemFactory, TranslatorInterface $translator, ImageManager $imageManager)

No description

EncodedImageInterface
makeImage(UploadedFileInterface $file)

No description

Details

in AbstractSerializeController at line 96
ResponseInterface handle(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

ResponseInterface

in UploadImageController at line 37
mixed data(ServerRequestInterface $request, Document $document)

<p>Get the data to be serialized and assigned to the response document.</p>

Parameters

ServerRequestInterface $request
Document $document

Return Value

mixed

in AbstractShowController at line 17
protected ElementInterface createElement(mixed $data, SerializerInterface $serializer)

<p>Create a PHP JSON-API Element for output in the document.</p>

Parameters

mixed $data
SerializerInterface $serializer

Return Value

ElementInterface

in AbstractSerializeController at line 149
protected array getRelationsToLoad(Collection $models)

<p>Returns the relations to load added by extenders.</p>

Parameters

Collection $models

Return Value

array

in AbstractSerializeController at line 167
protected array getRelationCallablesToLoad(Collection $models)

<p>Returns the relation callables to load added by extenders.</p>

Parameters

Collection $models

Return Value

array

in AbstractSerializeController at line 183
protected void loadRelations(Collection $models, array $relations, ServerRequestInterface $request = null)

<p>Eager loads the required relationships.</p>

Parameters

Collection $models
array $relations
ServerRequestInterface $request

Return Value

void

in AbstractSerializeController at line 241
protected array extractInclude(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

Exceptions

InvalidParameterException

in AbstractSerializeController at line 248
protected array extractFields(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

in AbstractSerializeController at line 256
protected array|null extractSort(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array|null

Exceptions

InvalidParameterException

in AbstractSerializeController at line 264
protected int extractOffset(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

int

Exceptions

InvalidParameterException

in AbstractSerializeController at line 272
protected int extractLimit(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

int

Exceptions

InvalidParameterException

in AbstractSerializeController at line 277
protected array extractFilter(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

array

in AbstractSerializeController at line 282
protected Parameters buildParameters(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

Parameters

in AbstractSerializeController at line 287
protected bool sortIsDefault(ServerRequestInterface $request)

Parameters

ServerRequestInterface $request

Return Value

bool

in AbstractSerializeController at line 295
void setSerializer(string $serializer)

<p>Set the serializer that will serialize data for the endpoint.</p>

Parameters

string $serializer

Return Value

void

in AbstractSerializeController at line 303
void addInclude(array|string $name)

<p>Include the given relationship by default.</p>

Parameters

array|string $name

Return Value

void

in AbstractSerializeController at line 311
void removeInclude(array|string $name)

<p>Don't include the given relationship by default.</p>

Parameters

array|string $name

Return Value

void

in AbstractSerializeController at line 319
void addOptionalInclude(array|string $name)

<p>Make the given relationship available for inclusion.</p>

Parameters

array|string $name

Return Value

void

in AbstractSerializeController at line 327
void removeOptionalInclude(array|string $name)

<p>Don't allow the given relationship to be included.</p>

Parameters

array|string $name

Return Value

void

in AbstractSerializeController at line 335
void setLimit(int $limit)

<p>Set the default number of results.</p>

Parameters

int $limit

Return Value

void

in AbstractSerializeController at line 343
void setMaxLimit(int $max)

<p>Set the maximum number of results.</p>

Parameters

int $max

Return Value

void

in AbstractSerializeController at line 351
void addSortField(array|string $field)

<p>Allow sorting results by the given field.</p>

Parameters

array|string $field

Return Value

void

in AbstractSerializeController at line 359
void removeSortField(array|string $field)

<p>Disallow sorting results by the given field.</p>

Parameters

array|string $field

Return Value

void

in AbstractSerializeController at line 367
void setSort(array $sort)

<p>Set the default sort order for the results.</p>

Parameters

array $sort

Return Value

void

in AbstractSerializeController at line 372
static Container getContainer()

Return Value

Container

in AbstractSerializeController at line 380
static void setContainer(Container $container)

Parameters

Container $container

Return Value

void

in AbstractSerializeController at line 388
static void addDataPreparationCallback(string $controllerClass, callable $callback)

Parameters

string $controllerClass
callable $callback

Return Value

void

in AbstractSerializeController at line 400
static void addSerializationPreparationCallback(string $controllerClass, callable $callback)

Parameters

string $controllerClass
callable $callback

Return Value

void

in AbstractSerializeController at line 412
static void setLoadRelations(string $controllerClass, array $relations)

Parameters

string $controllerClass
array $relations

Return Value

void

in AbstractSerializeController at line 424
static void setLoadRelationCallables(string $controllerClass, array $relations)

Parameters

string $controllerClass
array $relations

Return Value

void

at line 25
__construct(SettingsRepositoryInterface $settings, Factory $filesystemFactory, TranslatorInterface $translator, ImageManager $imageManager)

Parameters

SettingsRepositoryInterface $settings
Factory $filesystemFactory
TranslatorInterface $translator
ImageManager $imageManager

at line 34
protected EncodedImageInterface makeImage(UploadedFileInterface $file)

Parameters

UploadedFileInterface $file

Return Value

EncodedImageInterface