Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\WidgetsService Class Reference

Public Member Functions

 getWidgets ($owner_guid, $context)
 
 createWidget ($owner_guid, $handler, $context, $access_id=null)
 
 canEditLayout ($context, $user_guid=0)
 
 registerType (WidgetDefinition $definition)
 
 unregisterType ($id)
 
 validateType ($id, $context=null,\ElggEntity $container=null)
 Checks if a widget type exists for a given id. More...
 
 getAllTypes ()
 private More...
 
 getNameById ($id, $context= '',\ElggEntity $container=null)
 Returns widget name based on id. More...
 
 getTypes (array $params=[])
 

Detailed Description

Definition at line 17 of file WidgetsService.php.

Member Function Documentation

Elgg\WidgetsService::canEditLayout (   $context,
  $user_guid = 0 
)
See Also
elgg_can_edit_widget_layout private
Since
1.9.0

Definition at line 115 of file WidgetsService.php.

Elgg\WidgetsService::createWidget (   $owner_guid,
  $handler,
  $context,
  $access_id = null 
)
See Also
elgg_create_widget private
Since
1.9.0

Definition at line 77 of file WidgetsService.php.

Elgg\WidgetsService::getAllTypes ( )

private

Since
1.9.0

Definition at line 205 of file WidgetsService.php.

Elgg\WidgetsService::getNameById (   $id,
  $context = '',
\ElggEntity  $container = null 
)

Returns widget name based on id.

Parameters
string$idWidget identifier
string$contextContext to check
\ElggEntity$containerOptional limit widget definitions to a container
Returns
string|boolean

private

Since
2.2.0

Definition at line 221 of file WidgetsService.php.

Elgg\WidgetsService::getTypes ( array  $params = [])
Parameters
$paramsAssociative array of params used to determine what to return

array ( 'context' => string (defaults to elgg_get_context()), 'exact' => bool (defaults to false), 'container' => (defaults to null) )

Returns
[]

private

Since
1.9.0

Definition at line 246 of file WidgetsService.php.

Elgg\WidgetsService::getWidgets (   $owner_guid,
  $context 
)
See Also
elgg_get_widgets private
Since
1.9.0

Definition at line 35 of file WidgetsService.php.

Elgg\WidgetsService::registerType ( WidgetDefinition  $definition)
Parameters
WidgetDefinitionDefinition of the widget
Returns
bool
See Also
elgg_register_widget_type private
Since
1.9.0

Definition at line 145 of file WidgetsService.php.

Elgg\WidgetsService::unregisterType (   $id)
Parameters
string$id
Returns
bool
See Also
elgg_unregister_widget_type private
Since
1.9.0

Definition at line 167 of file WidgetsService.php.

Elgg\WidgetsService::validateType (   $id,
  $context = null,
\ElggEntity  $container = null 
)

Checks if a widget type exists for a given id.

Parameters
string$idWidget identifier
string$contextOptional context to check
\ElggEntity$containerOptional limit widget definitions to a container
See Also
elgg_is_widget_type private
Since
1.9.0

Definition at line 186 of file WidgetsService.php.


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