This is an old revision of the document!

PageService

Layer: Service · Source: lib/service/PageService.php:24 (lines 24–623)

final class PageService

Docblock Metadata

Tag	Value
`@category`	Service Class
`@author`	M.Noermoehammad
`@license`	MIT
`@version`	1.0
`@since`	Since Release 1.0

Inheritance

No parent, interface or trait. This is a root type.

Constants (0)

None.

Properties (0)

None declared.

Methods (29)

Visibility	Method	Summary	Line
public	`__construct()`	Initialize or instanstiate of class propertis	186
public	`setPageId()`	set page id	200
public	`setPageAuthor()`	setPageAuthor	211
public	`setPostDate()`	setPostDate	222
public	`setPostModified()`	setPostModified	234
public	`setPageImage()`	SetPageImage	245
public	`setPageTitle()`	set page title	256
public	`setPageSlug()`	set page slug	267
public	`setPageContent()`	set page content	278
public	`setMetaDesc()`	set meta description	289
public	`setPublish()`	set page status	300
public	`setPostType()`	Set post type	311
public	`setSticky()`	setSticky	324
public	`setComment()`	setComment	335
public	`setPageLocale()`	setPageLocale	346
public	`grabPages()`	grabPages	358
public	`grabPage()`	grabPage	371
public	`addPage()`	addPage	380
public	`modifyPage()`	modifyPage	419
public	`removePage()`	removePage	457
public	`postStatusDropDown()`	postStatusDropDown()	514
public	`commentStatusDropDown()`	commentStatusDropDown()	526
public	`localeDropDown()`	localeDropDown()	538
public	`getImageRadioButton()`	getImageRadioButton()	553
public	`createPageMedia()`	createPageMedia()	567
public	`createPageMediaMeta()`	createPageMediaMeta()	581
public	`pageAuthorId()`	pageAuthorId	592
public	`pageAuthorLevel()`	pageAuthorLevel	608
public	`totalPages()`	totalPages	619

__construct()

public function __construct(PageDao $pageDao, FormValidator $validator, Sanitize $sanitizer, MediaDao $mediaDao)

lines 186–192 (7)

Initialize or instanstiate of class propertis

Parameter	Type	Default	Description
`$pageDao`	''PageDao''	required	Data access for page records
`$validator`	''FormValidator''	required	Input validator
`$sanitizer`	''Sanitize''	required	Input sanitizer
`$mediaDao`	''MediaDao''	required	Data access for page media lookups and writes

setPageId()

public function setPageId($pageId)

lines 200–203 (4)

set page id

Parameter	Type	Default	Description
`$pageId`	`(untyped)`	required	none

Returns: (none declared)

setPageAuthor()

public function setPageAuthor($author)

lines 211–214 (4)

setPageAuthor

Parameter	Type	Default	Description
`$author`	`(untyped)`	required	none

Returns: (none declared)

setPostDate()

public function setPostDate($date_created)

lines 222–225 (4)

setPostDate

Parameter	Type	Default	Description
`$date_created`	`(untyped)`	required	none

Returns: (none declared)

setPostModified()

public function setPostModified($date_modified)

lines 234–237 (4)

setPostModified

Parameter	Type	Default	Description
`$date_modified`	`(untyped)`	required	none

Returns: (none declared)

setPageImage()

public function setPageImage($post_image)

lines 245–248 (4)

SetPageImage

Parameter	Type	Default	Description
`$post_image`	`(untyped)`	required	none

Returns: (none declared)

setPageTitle()

public function setPageTitle($title)

lines 256–259 (4)

set page title

Parameter	Type	Default	Description
`$title`	`(untyped)`	required	none

Returns: (none declared)

setPageSlug()

public function setPageSlug($slug)

lines 267–270 (4)

set page slug

Parameter	Type	Default	Description
`$slug`	`(untyped)`	required	none

Returns: (none declared)

setPageContent()

public function setPageContent($content)

lines 278–281 (4)

set page content

Parameter	Type	Default	Description
`$content`	`(untyped)`	required	none

Returns: (none declared)

setMetaDesc()

public function setMetaDesc($meta_desc)

lines 289–292 (4)

set meta description

Parameter	Type	Default	Description
`$meta_desc`	`(untyped)`	required	none

Returns: (none declared)

setPublish()

public function setPublish($page_status)

lines 300–303 (4)

set page status

Parameter	Type	Default	Description
`$page_status`	`(untyped)`	required	none

Returns: (none declared)

setPostType()

public function setPostType($post_type)

lines 311–314 (4)

Set post type

Parameter	Type	Default	Description
`$post_type`	`(untyped)`	required	none

Returns: (none declared)

setSticky()

public function setSticky($page_sticky)

lines 324–327 (4)

setSticky

stick to the top of the blog

Parameter	Type	Default	Description
`$page_sticky`	`(untyped)`	required	none

Returns: (none declared)

setComment()

public function setComment($comment_status)

lines 335–338 (4)

setComment

Parameter	Type	Default	Description
`$comment_status`	`(untyped)`	required	none

Returns: (none declared)

setPageLocale()

public function setPageLocale($page_locale)

lines 346–349 (4)

setPageLocale

Parameter	Type	Default	Description
`$page_locale`	`(untyped)`	required	none

Returns: (none declared)

grabPages()

public function grabPages($type, $orderBy = &#039;ID&#039;, $author = null)

lines 358–361 (4)

grabPages

Parameter	Type	Default	Description
`$type`	`(untyped)`	required	none
`$orderBy`	`(untyped)`	'`ID`'	none
`$author`	`(untyped)`	`null`	none

Returns: (none declared) — mixed

grabPage()

public function grabPage($id)

lines 371–374 (4)

grabPage

Parameter	Type	Default	Description
`$id`	`(untyped)`	required	none

Returns: (none declared) — mixed

addPage()

public function addPage()

lines 380–411 (32)

addPage

Takes no parameters.

Returns: (none declared)

modifyPage()

public function modifyPage()

lines 419–451 (33)

modifyPage

Updating an existing page record

Takes no parameters.

Returns: (none declared)

removePage()

public function removePage()

lines 457–503 (47)

removePage

Takes no parameters.

Returns: (none declared)

postStatusDropDown()

public function postStatusDropDown($selected = &quot;&quot;)

lines 514–517 (4)

postStatusDropDown()

select box post status

Parameter	Type	Default	Description
`$selected`	`(untyped)`	`“”`	none

Returns: (none declared) — string

commentStatusDropDown()

public function commentStatusDropDown($selected = &quot;&quot;)

lines 526–529 (4)

commentStatusDropDown()

Parameter	Type	Default	Description
`$selected`	`(untyped)`	`“”`	none

Returns: (none declared) — string

localeDropDown()

public function localeDropDown($selected = &quot;&quot;)

lines 538–541 (4)

localeDropDown()

Parameter	Type	Default	Description
`$selected`	`(untyped)`	`“”`	none

Returns: (none declared) — string

getImageRadioButton()

public function getImageRadioButton($checked = null): string

lines 553–556 (4)

getImageRadioButton()

Featured-image radio list for the page form, delegated to MediaDao so controllers never build a DAO themselves.

Parameter	Type	Default	Description
`$checked`	`(untyped)`	`null`	Media ID pre-selected in the list

Returns: string — string HTML radio list

createPageMedia()

public function createPageMedia(array $bind): string

lines 567–570 (4)

createPageMedia()

Persist a page media record through the injected MediaDao.

Parameter	Type	Default	Description
`$bind`	`array`	required	Media column values

Returns: string — string New media ID as returned by the DAO

createPageMediaMeta()

public function createPageMediaMeta(array $bind): void

lines 581–584 (4)

createPageMediaMeta()

Persist a page media meta record through the injected MediaDao.

Parameter	Type	Default	Description
`$bind`	`array`	required	Media meta column values

Returns: void — void

pageAuthorId()

public function pageAuthorId()

lines 592–600 (9)

pageAuthorId

Takes no parameters.

Returns: (none declared) — void|bool if true it will be return session otherwise it will be false

pageAuthorLevel()

public function pageAuthorLevel()

lines 608–611 (4)

pageAuthorLevel

Takes no parameters.

Returns: (none declared) — void|bool - return bool - false if it is not session

totalPages()

public function totalPages(array $data = []): ?int

lines 619–622 (4)

totalPages

Parameter	Type	Default	Description
`$data`	`array`	`[]`	none

Returns: ?int — integer|null

Imports

Alias	Fully-qualified name
`FormValidator`	''Scriptlog\Core\FormValidator''
`Sanitize`	''Scriptlog\Core\Sanitize''
`Session`	''Scriptlog\Core\Session''
`MediaDao`	''Scriptlog\Dao\MediaDao''
`PageDao`	''Scriptlog\Dao\PageDao''

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.

Scriptlog Documentation

Table of Contents

PageService

Docblock Metadata

Inheritance

Constants (0)

Properties (0)

Methods (29)

__construct()

setPageId()

setPageAuthor()

setPostDate()

setPostModified()

setPageImage()

setPageTitle()

setPageSlug()

setPageContent()

setMetaDesc()

setPublish()

setPostType()

setSticky()

setComment()

setPageLocale()

grabPages()

grabPage()

addPage()

modifyPage()

removePage()

postStatusDropDown()

commentStatusDropDown()

localeDropDown()

getImageRadioButton()

createPageMedia()

createPageMediaMeta()

pageAuthorId()

pageAuthorLevel()

totalPages()

Imports