Elgg  Version 3.0
/root/Elgg/engine/classes/Elgg/FormsService.php

Convenience function for generating a form from a view in a standard location.This function assumes that the body of the form is located at "forms/$action" and sets the action by default to "action/$action". Automatically wraps the forms/$action view with a <form> tag and inserts the anti-csrf security tokens.

This automatically appends elgg-form-action-name to the form's class. It replaces any slashes with dashes (blog/save becomes elgg-form-blog-save)

echo elgg_view_form('login');

This would assume a "login" form body to be at "forms/login" and would set the action of the form to "http://yoursite.com/action/login".

If elgg_view('forms/login') is: <input type="text" name="username"> <input type="password" name="password">

Then elgg_view_form('login') generates: <form action="http://yoursite.com/action/login" method="post"> ...security tokens... <input type="text" name="username"> <input type="password" name="password"> </form>

Parameters
string$actionThe name of the action. An action name does not include the leading "action/". For example, "login" is an action name.
array$form_vars$vars passed to the "input/form" view
  • 'ajax' bool If true, the form will be submitted with an ajax request
array$body_vars$vars passed to the "forms/<action>" view
Returns
string The complete form
<?php
namespace Elgg;
class FormsService {
use Loggable;
private $views;
private $rendering;
private $footer = '';
public function __construct(ViewsService $views, LoggerInterface $logger) {
$this->views = $views;
$this->logger = $logger;
}
public function render($action, $form_vars = [], $body_vars = []) {
'action' => elgg_generate_action_url($action, [], false),
'method' => 'post',
'ajax' => false,
];
// append elgg-form class to any class options set
$form_vars['class'] = (array) elgg_extract('class', $form_vars, []);
$form_vars['class'][] = 'elgg-form-' . preg_replace('/[^a-z0-9]/i', '-', $action);
$form_vars = array_merge($defaults, $form_vars);
if (!isset($form_vars['enctype']) && strtolower($form_vars['method']) == 'post') {
$form_vars['enctype'] = 'multipart/form-data';
}
if (elgg_extract('ajax', $form_vars)) {
$form_vars['class'][] = 'elgg-js-ajax-form';
unset($form_vars['ajax']);
}
$form_vars['action_name'] = $action;
$form_vars['ignore_empty_body'] = (bool) elgg_extract('ignore_empty_body', $form_vars, false);
if (!isset($form_vars['body'])) {
$this->rendering = true;
$this->footer = '';
// Render form body
$body = $this->views->renderView("forms/$action", $body_vars);
if (!empty($body)) {
// Grab the footer if one was set during form rendering
$body .= $this->views->renderView('elements/forms/footer', [
'footer' => $this->getFooter(),
'action_name' => $action,
'body_vars' => $body_vars,
'form_vars' => $form_vars,
]);
}
$this->rendering = false;
$form_vars['body'] = $body;
}
return elgg_view('input/form', $form_vars);
}
public function setFooter($footer = '') {
if (!$this->rendering) {
$this->logger->error('Form footer can only be set and retrieved during form rendering, '
. 'anywhere in elgg_view_form() call stack (e.g. form view, extending views, or view hooks)');
return false;
}
$this->footer = $footer;
return true;
}
public function getFooter() {
if (!$this->rendering) {
$this->logger->error('Form footer can only be set and retrieved during form rendering, '
. 'anywhere in elgg_view_form() call stack (e.g. form view, extending views, or view hooks)');
return false;
}
return $this->footer;
}
}