Elgg  Version 3.0
Public Member Functions | List of all members
Elgg\FormsService Class Reference

WARNING: API IN FLUX. More...

Public Member Functions

 __construct (ViewsService $views, LoggerInterface $logger)
 Constructor. More...
 
 render ($action, $form_vars=[], $body_vars=[])
 
 setFooter ($footer= '')
 Sets form footer and defers its rendering until the form view and extensions have been rendered. More...
 
 getFooter ()
 Returns currently set footer, or false if not in the form rendering stack. More...
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Use the elgg_* versions instead.

Definition at line 15 of file FormsService.php.

Constructor & Destructor Documentation

Elgg\FormsService::__construct ( ViewsService  $views,
LoggerInterface  $logger 
)

Constructor.

Parameters
ViewsService$viewsViews service
LoggerInterface$loggerLogger service

Definition at line 40 of file FormsService.php.

Member Function Documentation

Elgg\FormsService::getFooter ( )

Returns currently set footer, or false if not in the form rendering stack.

Returns
string|false

Definition at line 157 of file FormsService.php.

Elgg\FormsService::render (   $action,
  $form_vars = [],
  $body_vars = [] 
)

Definition at line 80 of file FormsService.php.

Elgg\FormsService::setFooter (   $footer = '')

Sets form footer and defers its rendering until the form view and extensions have been rendered.

Deferring footer rendering allows plugins to extend the form view while maintaining logical DOM structure. Footer will be rendered using 'elements/forms/footer' view after form body has finished rendering

Parameters
string$footerFooter
Returns
bool

Definition at line 141 of file FormsService.php.


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