FieldsService.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Forms;
 
use Elgg\Database\EntityTable;
use Elgg\EventsService;
use Elgg\I18n\Translator;
use Elgg\Traits\Loggable;
 
class FieldsService {
 
    use Loggable;
    
    protected array $fields = [];
 
    public function __construct(protected EventsService $events, protected Translator $translator, protected EntityTable $entityTable) {
    }
    
    public function get(string $type, string $subtype): array {
        if (isset($this->fields[$type][$subtype])) {
            return $this->fields[$type][$subtype];
        }
        
        $entity_class = $this->entityTable->getEntityClass($type, $subtype);
        $defaults = !empty($entity_class) ? $entity_class::getDefaultFields() : [];
        $priority = 100;
        foreach ($defaults as &$default_field) {
            if (!isset($default_field['priority'])) {
                $default_field['priority'] = $priority;
                $priority += 100;
            }
        }
 
        $result = (array) $this->events->triggerResults('fields', "{$type}:{$subtype}", [
            'type' => $type,
            'subtype' => $subtype,
        ], $defaults);
        
        $fields = [];
        // validate fields and generate labels
        foreach ($result as $field) {
            if (empty($field['name']) || empty($field['#type'])) {
                $this->getLogger()->warning("Field config for '{$type}:{$subtype}' is missing 'name' or '#type' in field: " . print_r($field, true));
                continue;
            }
            
            if (!isset($field['#label'])) {
                $label_key = "fields:{$type}:{$subtype}:{$field['name']}";
                if ($this->translator->languageKeyExists($label_key)) {
                    $field['#label'] = $this->translator->translate($label_key);
                }
            }
 
            if (!isset($field['#help'])) {
                $label_key = "fields:{$type}:{$subtype}:{$field['name']}:help";
                if ($this->translator->languageKeyExists($label_key)) {
                    $field['#help'] = $this->translator->translate($label_key);
                }
            }
 
            if (!isset($field['priority'])) {
                $field['priority'] = $priority;
                $priority += 100;
            }
 
            $fields[] = $field;
        }
 
        // sort fields by priority
        usort($fields, function ($a, $b) {
            return (int) $a['priority'] - (int) $b['priority'];
        });
 
        foreach ($fields as &$field) {
            // remove priority as we do not want it leaking to field vars
            unset($field['priority']);
        }
        
        $this->fields[$type][$subtype] = $fields;
        
        return $fields;
    }
}