Elgg
Version master
|
Public Member Functions | |
__construct (EventsService $events, HttpRequest $request) | |
Constructor. More... | |
setViewtype (string $viewtype= '') | |
Set the viewtype. More... | |
getViewtype () | |
Get the viewtype. More... | |
isValidViewtype (string $viewtype) | |
Checks if $viewtype is a string suitable for use as a viewtype name. More... | |
autoregisterViews (string $view_base, string $folder, string $viewtype) | |
Auto-registers views from a location. More... | |
findViewFile (string $view, string $viewtype) | |
Find the view file. More... | |
setViewDir (string $view, string $location, string $viewtype= '') | |
Set an alternative base location for a view. More... | |
registerViewtypeFallback (string $viewtype) | |
Register a viewtype to fall back to a default view if a view isn't found for that viewtype. More... | |
doesViewtypeFallback (string $viewtype) | |
Checks if a viewtype falls back to default. More... | |
renderDeprecatedView (string $view, array $vars, string $suggestion, string $version) | |
Display a view with a deprecation notice. More... | |
getViewList (string $view) | |
Get the views, including extensions, used to render a view. More... | |
renderView (string $view, array $vars=[], string $viewtype= '', bool $issue_missing_notice=null, array $extensions_tree=[]) | |
Renders a view. More... | |
viewExists (string $view, string $viewtype= '', bool $recurse=true) | |
Returns whether the specified view exists. More... | |
extendView (string $view, string $view_extension, int $priority=501) | |
Extends a view with another view. More... | |
unextendView (string $view, string $view_extension) | |
Unextends a view. More... | |
registerCacheableView (string $view) | |
Register a view a cacheable. More... | |
isCacheableView (string $view) | |
Is the view cacheable. More... | |
registerPluginViews (string $path) | |
Register a plugin's views. More... | |
mergeViewsSpec (array $spec) | |
Merge a specification of absolute view paths. More... | |
listViews (string $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... | |
Static Public Member Functions | |
static | canonicalizeViewName (string $alias) |
Takes a view name and returns the canonical name for that view. More... | |
Public Attributes | |
const | VIEW_HOOK = 'view' |
const | VIEW_VARS_HOOK = 'view_vars' |
const | OUTPUT_KEY = '__view_output' |
const | BASE_VIEW_PRIORITY = 500 |
Protected Member Functions | |
fileExists (string $path) | |
Wrapper for file_exists() that caches false results (the stat cache only caches true results). More... | |
Protected Attributes | |
$file_exists_cache = [] | |
Views service.
Definition at line 18 of file ViewsService.php.
Elgg\ViewsService::__construct | ( | EventsService | $events, |
HttpRequest | $request | ||
) |
Constructor.
EventsService | $events | Events service |
\Elgg\Http\Request | $request | Http Request |
Definition at line 92 of file ViewsService.php.
Elgg\ViewsService::autoregisterViews | ( | string | $view_base, |
string | $folder, | ||
string | $viewtype | ||
) |
Auto-registers views from a location.
string | $view_base | Optional The base of the view name without the view type. |
string | $folder | Required The folder to begin looking in |
string | $viewtype | The type of view we're looking at (default, rss, etc) |
Definition at line 211 of file ViewsService.php.
Elgg\ViewsService::cacheConfiguration | ( | SystemCache | $cache | ) |
Cache the configuration.
SystemCache | $cache | The system cache |
Definition at line 799 of file ViewsService.php.
|
static |
Takes a view name and returns the canonical name for that view.
string | $alias | The possibly non-canonical view name. |
Definition at line 180 of file ViewsService.php.
Elgg\ViewsService::configureFromCache | ( | SystemCache | $cache | ) |
Configure locations from the cache.
SystemCache | $cache | The system cache |
Definition at line 780 of file ViewsService.php.
Elgg\ViewsService::doesViewtypeFallback | ( | string | $viewtype | ) |
Checks if a viewtype falls back to default.
string | $viewtype | Viewtype |
Definition at line 323 of file ViewsService.php.
Elgg\ViewsService::extendView | ( | string | $view, |
string | $view_extension, | ||
int | $priority = 501 |
||
) |
Extends a view with another view.
string | $view | The view to extend. |
string | $view_extension | This view is added to $view |
int | $priority | The priority, from 0 to 1000, to add at (lowest numbers displayed first) |
Definition at line 562 of file ViewsService.php.
|
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.
string | $path | Path to the file |
Definition at line 458 of file ViewsService.php.
Elgg\ViewsService::findViewFile | ( | string | $view, |
string | $viewtype | ||
) |
Find the view file.
string | $view | View name |
string | $viewtype | Viewtype |
Definition at line 262 of file ViewsService.php.
Elgg\ViewsService::getInspectorData | ( | ) |
Elgg\ViewsService::getViewList | ( | string | $view | ) |
Get the views, including extensions, used to render a view.
Keys returned are view priorities. View existence is not checked.
string | $view | View name |
Definition at line 359 of file ViewsService.php.
Elgg\ViewsService::getViewtype | ( | ) |
Elgg\ViewsService::isCacheableView | ( | string | $view | ) |
Is the view cacheable.
string | $view | the view name |
Definition at line 635 of file ViewsService.php.
Elgg\ViewsService::isValidViewtype | ( | string | $viewtype | ) |
Checks if $viewtype is a string suitable for use as a viewtype name.
string | $viewtype | Potential viewtype name. Alphanumeric chars plus _ allowed. |
Definition at line 161 of file ViewsService.php.
Elgg\ViewsService::listViews | ( | string | $viewtype = 'default' | ) |
List all views in a viewtype.
string | $viewtype | Viewtype |
Definition at line 742 of file ViewsService.php.
Elgg\ViewsService::mergeViewsSpec | ( | array | $spec | ) |
Merge a specification of absolute view paths.
array | $spec | Specification viewtype => [ view_name => path or array of paths ] |
Definition at line 711 of file ViewsService.php.
Elgg\ViewsService::registerCacheableView | ( | string | $view | ) |
Register a view a cacheable.
string | $view | the view name |
Definition at line 622 of file ViewsService.php.
Elgg\ViewsService::registerPluginViews | ( | string | $path | ) |
Register a plugin's views.
string | $path | Base path of the plugin |
Definition at line 671 of file ViewsService.php.
Elgg\ViewsService::registerViewtypeFallback | ( | string | $viewtype | ) |
Register a viewtype to fall back to a default view if a view isn't found for that viewtype.
string | $viewtype | The viewtype to register |
Definition at line 312 of file ViewsService.php.
Elgg\ViewsService::renderDeprecatedView | ( | string | $view, |
array | $vars, | ||
string | $suggestion, | ||
string | $version | ||
) |
Display a view with a deprecation notice.
No missing view NOTICE is logged
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, ... |
Definition at line 339 of file ViewsService.php.
Elgg\ViewsService::renderView | ( | string | $view, |
array | $vars = [] , |
||
string | $viewtype = '' , |
||
bool | $issue_missing_notice = null , |
||
array | $extensions_tree = [] |
||
) |
Renders a view.
string | $view | Name of the view |
array | $vars | Variables to pass to the view |
string | $viewtype | Viewtype to use |
bool | $issue_missing_notice | Should a missing notice be issued |
array | $extensions_tree | Array of views that are before the current view in the extension path |
Definition at line 376 of file ViewsService.php.
Elgg\ViewsService::setViewDir | ( | string | $view, |
string | $location, | ||
string | $viewtype = '' |
||
) |
Set an alternative base location for a view.
string | $view | Name of the view |
string | $location | Full path to the view file |
string | $viewtype | The viewtype to register this under |
Definition at line 286 of file ViewsService.php.
Elgg\ViewsService::setViewtype | ( | string | $viewtype = '' | ) |
Set the viewtype.
string | $viewtype | Viewtype |
Definition at line 104 of file ViewsService.php.
Elgg\ViewsService::unextendView | ( | string | $view, |
string | $view_extension | ||
) |
Unextends a view.
string | $view | The view that was extended. |
string | $view_extension | This view that was added to $view |
Definition at line 594 of file ViewsService.php.
Elgg\ViewsService::viewExists | ( | string | $view, |
string | $viewtype = '' , |
||
bool | $recurse = true |
||
) |
Returns whether the specified view exists.
string | $view | The view name |
string | $viewtype | If set, forces the viewtype |
bool | $recurse | If false, do not check extensions |
Definition at line 514 of file ViewsService.php.
|
protected |
Definition at line 31 of file ViewsService.php.
const Elgg\ViewsService::BASE_VIEW_PRIORITY = 500 |
Definition at line 25 of file ViewsService.php.
const Elgg\ViewsService::OUTPUT_KEY = '__view_output' |
Definition at line 24 of file ViewsService.php.
const Elgg\ViewsService::VIEW_HOOK = 'view' |
Definition at line 22 of file ViewsService.php.
const Elgg\ViewsService::VIEW_VARS_HOOK = 'view_vars' |
Definition at line 23 of file ViewsService.php.