CoolCMS API

SettingService
in package
implements ServiceInterface

Tags
implements

Table of Contents

Interfaces

ServiceInterface
Contract of the front service layer.

Properties

$mapper  : SettingMapper

Methods

__construct()  : mixed
find()  : T|null
Finds one entity by id.
findAll()  : T[], 1: int}
Finds all entities matching the criteria.
findBy()  : T|null
Finds one entity by filters.
get()  : mixed
getAll()  : array<int, array<string, mixed>>
getTotalCount()  : int|null

Properties

Methods

find()

Finds one entity by id.

public find(int $id[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null

use get().

Parameters
$id : int
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

findAll()

Finds all entities matching the criteria.

public findAll([array<string|int, mixed> $filters = [] ][, array<string|int, mixed>|null $orderBy = null ][, int|null $offset = null ][, int|null $limit = null ][, array<string|int, mixed>|null $columns = null ][, bool $computeTotalCount = false ][, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T[], 1: int}

use getAll().

Parameters
$filters : array<string|int, mixed> = []
$orderBy : array<string|int, mixed>|null = null
$offset : int|null = null
$limit : int|null = null
$columns : array<string|int, mixed>|null = null
$computeTotalCount : bool = false
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T[], 1: int} —

[items, totalCount]

findBy()

Finds one entity by filters.

public findBy(array<string|int, mixed> $filters[, string|array<string|int, mixed> $includes = [] ][, bool|null $useCache = null ]) : T|null

use get().

Parameters
$filters : array<string|int, mixed>
$includes : string|array<string|int, mixed> = []
$useCache : bool|null = null
Return values
T|null

get()

public get(int $moduleId, string $propertyName) : mixed
Parameters
$moduleId : int
$propertyName : string

getAll()

public getAll() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

getTotalCount()

public getTotalCount() : int|null

no replacement; the front end settings do not count records.

Return values
int|null
On this page

Search results