FormsService.php

Go to the documentation of this file.

<?php
 
namespace Elgg;
 
use Elgg\Exceptions\DomainException;
use Elgg\Exceptions\InvalidArgumentException;
use Elgg\Exceptions\LogicException;
use Elgg\Forms\FieldsService;
use Elgg\Javascript\ESMService;
use Elgg\Traits\Loggable;
 
class FormsService {
 
    use Loggable;
 
    protected bool $rendering = false;
 
    protected string $footer = '';
 
    public function __construct(
        protected ViewsService $views,
        protected EventsService $events,
        protected ESMService $esm,
        protected FieldsService $fields,
    ) {
    }
 
    public function render(string $action, array $form_vars = [], array $body_vars = []): string {
        $defaults = [
            'action' => elgg_generate_action_url($action, [], false),
            'method' => 'post',
            'ajax' => false,
            'sticky_enabled' => false,
            'sticky_form_name' => $action,
            'sticky_ignored_fields' => [],
        ];
 
        // append elgg-form class to any class options set
        $form_vars['class'] = elgg_extract_class($form_vars, [
            '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)) {
            $this->esm->import('input/form-ajax');
            $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);
        
        $form_vars['prevent_double_submit'] = (bool) elgg_extract('prevent_double_submit', $form_vars, true);
        
        if (!isset($form_vars['body'])) {
            // prepare body vars
            $body_vars = (array) $this->events->triggerResults('form:prepare:fields', $action, $form_vars, $body_vars);
            
            $this->rendering = true;
            $this->footer = '';
 
            // Render form body
            $body = $this->views->renderView("forms/{$action}", $body_vars);
 
            if (!empty($body)) {
                // wrap form body
                $body = $this->views->renderView('elements/forms/body', [
                    'body' => $body,
                    'action_name' => $action,
                    'body_vars' => $body_vars,
                    'form_vars' => $form_vars,
                ]);
                
                // 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 renderEntity(string $entity_type, string $entity_subtype, ?\ElggEntity $entity = null, array $vars = []): string {
        if ($entity instanceof \ElggEntity && ($entity->getType() !== $entity_type || $entity->getSubtype() !== $entity_subtype)) {
            throw new InvalidArgumentException("The provided entity doesn't match the given entity type/subtype");
        }
        
        $view = (string) elgg_extract('view', $vars, $this->getFormView($entity_type, $entity_subtype));
        $action = (string) elgg_extract('action', $vars, $this->getFormAction($entity_type, $entity_subtype));
        
        $fields = $this->fields->get($entity_type, $entity_subtype);
        $fields = (array) $this->events->triggerResults('form:register:fields', "{$entity_type}:{$entity_subtype}", [
            'entity' => $entity,
            'entity_type' => $entity_type,
            'entity_subtype' => $entity_subtype,
        ], $fields);
        
        $default_form_vars = [
            'sticky_enabled' => true,
            'action' => $action,
        ];
        $form_vars = array_merge((array) elgg_extract('form_vars', $vars), $default_form_vars);
        
        $default_body_vars = [
            'entity_type' => $entity_type,
            'entity_subtype' => $entity_subtype,
            'entity' => $entity,
            'fields' => $fields,
        ];
        $body_vars = array_merge((array) elgg_extract('body_vars', $vars), $default_body_vars);
        
        return $this->render($view, $form_vars, $body_vars);
    }
    
    protected function getFormView(string $entity_type, string $entity_subtype): string {
        $forms = [
            "{$entity_type}/{$entity_subtype}/edit",
            "{$entity_subtype}/edit",
        ];
        
        foreach ($forms as $view) {
            if (elgg_view_exists("forms/{$view}")) {
                return $view;
            }
        }
        
        return 'entity/edit';
    }
    
    protected function getFormAction(string $entity_type, string $entity_subtype): string {
        $actions = [
            "{$entity_type}/{$entity_subtype}/edit",
            "{$entity_subtype}/edit",
        ];
        
        foreach ($actions as $action) {
            if (elgg_action_exists($action)) {
                return elgg_generate_action_url($action, [], false);
            }
        }
        
        throw new DomainException("No form action found for {$entity_type}/{$entity_subtype}");
    }
 
    public function setFooter(string $footer = ''): void {
        if (!$this->rendering) {
            throw new LogicException('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 events)');
        }
 
        $this->footer = $footer;
    }
 
    public function getFooter(): string {
        if (!$this->rendering) {
            throw new LogicException('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 events)');
        }
 
        return $this->footer;
    }
}