Documentation

Page
in package

Page service, used for content management.

Table of Contents

Properties

$aclService  : AclService
$pageForm  : Page
$pageMapper  : Page
$storageConfig  : array<string|int, mixed>
$storageService  : FileStorage
$translator  : Translator

Methods

__construct()  : mixed
createPage()  : bool
Creates a new Page.
deletePage()  : void
Removes a page.
getPage()  : Page|null
Returns a single page.
getPageById()  : Page|null
Returns a single page by its id.
getPageForm()  : Page
Get the Page form.
getPageParents()  : array<string|int, Page|null>
Returns the parent pages of a page if those exist.
getPages()  : array<string, Page}>}>}>
Returns an associative array of all pages in a tree-like structure.
getTranslator()  : Translator
Get the translator.
savePageData()  : Page
updatePage()  : bool
uploadImage()  : string
Upload an image to be displayed on a page.

Properties

$pageMapper read-only

private Page $pageMapper

$storageConfig read-only

private array<string|int, mixed> $storageConfig

$translator read-only

private Translator $translator

Methods

__construct()

public __construct(AclService $aclService, Translator $translator, FileStorage $storageService, Page $pageMapper, Page $pageForm, array<string|int, mixed> $storageConfig) : mixed
Parameters
$aclService : AclService
$translator : Translator
$storageService : FileStorage
$pageMapper : Page
$pageForm : Page
$storageConfig : array<string|int, mixed>
Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

createPage()

Creates a new Page.

public createPage(Parameters $data) : bool
Parameters
$data : Parameters

form post data

Tags
throws
ORMException
Return values
bool

deletePage()

Removes a page.

public deletePage(int $pageId) : void
Parameters
$pageId : int

the id of the page to remove

Tags
throws
ORMException

getPage()

Returns a single page.

public getPage(Languages $language, string $category[, string|null $subCategory = null ][, string|null $name = null ]) : Page|null
Parameters
$language : Languages
$category : string
$subCategory : string|null = null
$name : string|null = null
Return values
Page|null

getPageById()

Returns a single page by its id.

public getPageById(int $pageId) : Page|null
Parameters
$pageId : int
Return values
Page|null

getPageForm()

Get the Page form.

public getPageForm() : Page
Return values
Page

getPageParents()

Returns the parent pages of a page if those exist.

public getPageParents(Page $page, Languages $language) : array<string|int, Page|null>
Parameters
$page : Page
$language : Languages
Return values
array<string|int, Page|null>

getPages()

Returns an associative array of all pages in a tree-like structure.

public getPages() : array<string, Page}>}>}>
Return values
array<string, Page}>}>}>

getTranslator()

Get the translator.

public getTranslator() : Translator
Return values
Translator

savePageData()

public savePageData(Page $page, array<string|int, mixed> $data) : Page
Parameters
$page : Page
$data : array<string|int, mixed>
Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
Page

updatePage()

public updatePage(Page $page, array<string|int, mixed> $data) : bool
Parameters
$page : Page
$data : array<string|int, mixed>
Tags
throws
ORMException
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
bool

uploadImage()

Upload an image to be displayed on a page.

public uploadImage(array<string|int, mixed> $files) : string
Parameters
$files : array<string|int, mixed>
Tags
phpcsSuppress

SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification

Return values
string

        
On this page

Search results