WARNING: API IN FLUX. More...

Public Member Functions
	__construct (PluginHooksService $hooks, Logger $logger)
	Constructor. More...

	canonicalizeViewName ($alias)
	Takes a view name and returns the canonical name for that view. More...

	autoregisterViews ($view_base, $folder, $viewtype)
	private More...

	findViewFile ($view, $viewtype)
	Find the view file. More...

	setViewDir ($view, $location, $viewtype= '')

	registerViewtypeFallback ($viewtype)
	private More...

	doesViewtypeFallback ($viewtype)
	private More...

	renderDeprecatedView ($view, array $vars, $suggestion, $version)
	Display a view with a deprecation notice. More...

	getViewList ($view)
	Get the views, including extensions, used to render a view. More...

	renderView ($view, array $vars=[], $ignored=false, $viewtype= '', $issue_missing_notice=true)
	private More...

	viewExists ($view, $viewtype= '', $recurse=true)
	private More...

	extendView ($view, $view_extension, $priority=501)
	private More...

	viewIsExtended ($view)
	Is the given view extended? More...

	viewHasHookHandlers ($view)
	Do hook handlers exist to modify the view? More...

	unextendView ($view, $view_extension)
	private More...

	registerCacheableView ($view)
	private More...

	isCacheableView ($view)
	private More...

	registerPluginViews ($path, &$failed_dir= '')
	Register a plugin's views. More...

	mergeViewsSpec (array $spec)
	Merge a specification of absolute view paths. More...

	listViews ($viewtype= 'default')
	List all views in a viewtype. More...

	getInspectorData ()
	Get inspector data. More...

	configureFromCache (SystemCache $cache)
	Configure locations from the cache. More...

	cacheConfiguration (SystemCache $cache)
	Cache the configuration. More...

Public Attributes
const	VIEW_HOOK = 'view'

const	VIEW_VARS_HOOK = 'view_vars'

const	OUTPUT_KEY = '__view_output'

	$view_path

Protected Member Functions
	fileExists ($path)
	Wrapper for file_exists() that caches false results (the stat cache only caches true results). More...

Protected Attributes
	$file_exists_cache = []

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Use the elgg_* versions instead.

private

Since: 1.9.0

Definition at line 17 of file ViewsService.php.

Constructor & Destructor Documentation

Elgg\ViewsService::__construct	(	PluginHooksService	$hooks,
		Logger	$logger
	)

Constructor.

Parameters

PluginHooksService	$hooks	The hooks service
Logger	$logger	Logger

Definition at line 88 of file ViewsService.php.

Member Function Documentation

Elgg\ViewsService::autoregisterViews	(	$view_base,
		$folder,
		$viewtype
	)

private

Definition at line 128 of file ViewsService.php.

Elgg\ViewsService::cacheConfiguration ( SystemCache $cache )

Cache the configuration.

Parameters

SystemCache $cache The system cache

Returns: void private

Definition at line 674 of file ViewsService.php.

Elgg\ViewsService::canonicalizeViewName ( $alias )

Takes a view name and returns the canonical name for that view.

Parameters

string $alias The possibly non-canonical view name.

Returns: string The canonical view name.

Definition at line 100 of file ViewsService.php.

Elgg\ViewsService::configureFromCache ( SystemCache $cache )

Configure locations from the cache.

Parameters

SystemCache $cache The system cache

Returns: bool private

Definition at line 651 of file ViewsService.php.

Elgg\ViewsService::doesViewtypeFallback ( $viewtype )

private

Definition at line 217 of file ViewsService.php.

Elgg\ViewsService::extendView	(	$view,
		$view_extension,
		$priority = `501`
	)

private

Definition at line 422 of file ViewsService.php.

Elgg\ViewsService::fileExists ( $path )

protected

Wrapper for file_exists() that caches false results (the stat cache only caches true results).

This saves us from many unneeded file stat calls when a common view uses a fallback.

Parameters

string $path Path to the file

Returns: bool

Definition at line 340 of file ViewsService.php.

Elgg\ViewsService::findViewFile	(	$view,
		$viewtype
	)

Find the view file.

Parameters

string	$view	View name
string	$viewtype	Viewtype

Returns: string Empty string if not found private

Definition at line 171 of file ViewsService.php.

Elgg\ViewsService::getInspectorData ( )

Get inspector data.

Returns: array

private

Definition at line 626 of file ViewsService.php.

Elgg\ViewsService::getViewList ( $view )

Get the views, including extensions, used to render a view.

Keys returned are view priorities. View existence is not checked.

Parameters

string $view View name

Returns: string[] private

Definition at line 253 of file ViewsService.php.

Elgg\ViewsService::isCacheableView ( $view )

private

Definition at line 498 of file ViewsService.php.

Elgg\ViewsService::listViews ( $viewtype = 'default' )

List all views in a viewtype.

Parameters

string $viewtype Viewtype

Returns: string[]

private

Definition at line 612 of file ViewsService.php.

Elgg\ViewsService::mergeViewsSpec ( array $spec )

Merge a specification of absolute view paths.

Parameters

array $spec Specification viewtype => [ view_name => path or array of paths ]

private

Definition at line 577 of file ViewsService.php.

Elgg\ViewsService::registerCacheableView ( $view )

private

Definition at line 489 of file ViewsService.php.

Elgg\ViewsService::registerPluginViews	(		$path,
		&	$failed_dir = `''`
	)

Register a plugin's views.

Parameters

string	$path	Base path of the plugin
string	$failed_dir	This var is set to the failed directory if registration fails

Returns: bool

private

Definition at line 535 of file ViewsService.php.

Elgg\ViewsService::registerViewtypeFallback ( $viewtype )

private

Definition at line 210 of file ViewsService.php.

Elgg\ViewsService::renderDeprecatedView	(		$view,
		array	$vars,
			$suggestion,
			$version
	)

Display a view with a deprecation notice.

No missing view NOTICE is logged

See also: elgg_view()

Parameters

string	$view	The name and location of the view to use
array	$vars	Variables to pass to the view
string	$suggestion	Suggestion with the deprecation message
string	$version	Human-readable release version: 1.7, 1.8, ...

Returns: string The parsed view private

Definition at line 234 of file ViewsService.php.

Elgg\ViewsService::renderView	(		$view,
		array	$vars = `[]`,
			$ignored = `false`,
			$viewtype = `''`,
			$issue_missing_notice = `true`
	)

private

Definition at line 264 of file ViewsService.php.

Elgg\ViewsService::setViewDir	(	$view,
		$location,
		$viewtype = `''`
	)

Parameters

string	$view	Name of the view
string	$location	Full path to the view file
string	$viewtype	The viewtype to register this under

private

Definition at line 191 of file ViewsService.php.

Elgg\ViewsService::unextendView	(	$view,
		$view_extension
	)

private

Definition at line 468 of file ViewsService.php.

Elgg\ViewsService::viewExists	(	$view,
		$viewtype = `''`,
		$recurse = `true`
	)

private

Definition at line 381 of file ViewsService.php.

Elgg\ViewsService::viewHasHookHandlers ( $view )

Do hook handlers exist to modify the view?

Parameters

string $view View name

Returns: bool

Definition at line 461 of file ViewsService.php.

Elgg\ViewsService::viewIsExtended ( $view )

Is the given view extended?

Parameters

string $view View name

Returns: bool

Definition at line 448 of file ViewsService.php.

Member Data Documentation

Elgg\ViewsService::$file_exists_cache = []

protected

Definition at line 27 of file ViewsService.php.

Elgg\ViewsService::$view_path

Definition at line 80 of file ViewsService.php.

const Elgg\ViewsService::OUTPUT_KEY = '__view_output'

Definition at line 21 of file ViewsService.php.

const Elgg\ViewsService::VIEW_HOOK = 'view'

Definition at line 19 of file ViewsService.php.

const Elgg\ViewsService::VIEW_VARS_HOOK = 'view_vars'

Definition at line 20 of file ViewsService.php.

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

engine/classes/Elgg/ViewsService.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation