Elgg\Page\PageOwnerService Class Reference

Holds page owner related functions. More...

Public Member Functions
	__construct (Request $request, EntityTable $entity_table, EventsService $events, Invoker $invoker)
	Constructor. More...
	setPageOwnerGuid (int $guid=0)
	Sets a new page owner guid. More...
	getPageOwnerGuid ()
	Return the current page owner guid. More...
	getPageOwnerEntity ()
	Returns the page owner entity. More...

Protected Member Functions
	detectPageOwnerFromRoute ()
	Detects page owner from route. More...

Protected Attributes
	$request
	$entity_table
	$events
	$invoker
	$page_owner_guid = 0

Detailed Description

Holds page owner related functions.

Definition at line 19 of file PageOwnerService.php.

Constructor & Destructor Documentation

Elgg\Page\PageOwnerService::__construct	(	Request	$request,
		EntityTable	$entity_table,
		EventsService	$events,
		Invoker	$invoker
	)

Constructor.

Parameters

Request	$request	Request
EntityTable	$entity_table	Entity table
EventsService	$events	Events
Invoker	$invoker	Invoker

Definition at line 54 of file PageOwnerService.php.

Member Function Documentation

Elgg\Page\PageOwnerService::detectPageOwnerFromRoute ( )

protected

Detects page owner from route.

Returns

int detected page owner guid or void if none detected

Definition at line 73 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::getPageOwnerEntity

(

)

Returns the page owner entity.

Returns

the current page owner or null if none.

Definition at line 117 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::getPageOwnerGuid

(

)

Return the current page owner guid.

Returns

int

Definition at line 108 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::setPageOwnerGuid

(

int

$guid = 0

)

Sets a new page owner guid.

Parameters

int

$guid

the new page owner

Returns

void

Exceptions

RangeException

Definition at line 95 of file PageOwnerService.php.

Member Data Documentation

Elgg\Page\PageOwnerService::$entity_table

protected

Definition at line 29 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::$events

protected

Definition at line 34 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::$invoker

protected

Definition at line 39 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::$page_owner_guid = 0

protected

Definition at line 44 of file PageOwnerService.php.

Elgg\Page\PageOwnerService::$request

protected

Definition at line 24 of file PageOwnerService.php.

---

The documentation for this class was generated from the following file:

• engine/classes/Elgg/Page/PageOwnerService.php