Elgg  Version 6.2
input.php
Go to the documentation of this file.
1 <?php
20 function get_input(string $variable, $default = null, bool $filter_result = true) {
21  return _elgg_services()->request->getParam($variable, $default, $filter_result);
22 }
23 
34 function set_input(string $variable, $value): void {
35  _elgg_services()->request->setParam($variable, $value, true);
36 }
37 
50 function elgg_get_request_data(bool $filter_result = true): array {
51  return _elgg_services()->request->getParams($filter_result);
52 }
53 
63 function elgg_get_title_input(string $variable = 'title', string $default = ''): string {
64  $raw_input = get_input($variable, $default, false);
65  return htmlspecialchars($raw_input ?? '', ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
66 }
67 
78  return elgg_trigger_event_results('sanitize', 'input', [], $input);
79 }
80 
89 function elgg_is_valid_email(string $address): bool {
90  return _elgg_services()->accounts->isValidEmail($address);
91 }
92 
105 function elgg_make_sticky_form(string $form_name, array $ignored_field_names = []): void {
106  _elgg_services()->stickyForms->makeStickyForm($form_name, $ignored_field_names);
107 }
108 
121 function elgg_clear_sticky_form(string $form_name): void {
122  _elgg_services()->stickyForms->clearStickyForm($form_name);
123 }
124 
133 function elgg_is_sticky_form(string $form_name): bool {
134  return _elgg_services()->stickyForms->isStickyForm($form_name);
135 }
136 
148 function elgg_get_sticky_value(string $form_name, string $variable = '', $default = null, bool $filter_result = true) {
149  return _elgg_services()->stickyForms->getStickyValue($form_name, $variable, $default, $filter_result);
150 }
151 
161 function elgg_get_sticky_values(string $form_name, bool $filter_result = true): array {
162  return _elgg_services()->stickyForms->getStickyValues($form_name, $filter_result);
163 }
164 
176 function elgg_is_empty($value): bool {
177  return Elgg\Values::isEmpty($value);
178 }
179 
193 function _elgg_htmlawed_tag_post_processor(string $tag, array|int $attributes = 0): string {
194  if ($attributes === 0) {
195  // This is a closing tag. Prevent further processing to avoid inserting a duplicate tag
196  return "</{$tag}>";
197  }
198 
199  $attributes = (array) elgg_trigger_event_results('attributes', 'htmlawed', [
200  'attributes' => $attributes,
201  'tag' => $tag,
202  ], $attributes);
203 
204  $result = '';
205  foreach ($attributes as $attr => $value) {
206  if ($tag === 'img' && $attr === 'alt' && $value === 'image') {
207  // htmlAwed adds a default alt to all images
208  // but according to WCAG the default for decorative image should be an empty alt attribute
209  $value = '';
210  }
211 
212  $result .= " {$attr}=\"{$value}\"";
213  }
214 
215  return "<{$tag}{$result}>";
216 }
217 
226 function elgg_string_to_array(string $string): array {
227  $ar = explode(',', $string);
228  $ar = array_map('trim', $ar);
229  $ar = array_map('strip_tags', $ar);
230 
231  $ar = array_filter($ar, function($string) {
232  return !elgg_is_empty($string);
233  });
234 
235  $ar = array_unique($ar);
236 
237  // reset keys
238  return array_values($ar);
239 }
return[ 'admin/delete_admin_notices'=>['access'=> 'admin'], 'admin/menu/save'=>['access'=> 'admin'], 'admin/plugins/activate'=>['access'=> 'admin'], 'admin/plugins/activate_all'=>['access'=> 'admin'], 'admin/plugins/deactivate'=>['access'=> 'admin'], 'admin/plugins/deactivate_all'=>['access'=> 'admin'], 'admin/plugins/set_priority'=>['access'=> 'admin'], 'admin/security/security_txt'=>['access'=> 'admin'], 'admin/security/settings'=>['access'=> 'admin'], 'admin/security/regenerate_site_secret'=>['access'=> 'admin'], 'admin/site/cache/invalidate'=>['access'=> 'admin'], 'admin/site/flush_cache'=>['access'=> 'admin'], 'admin/site/icons'=>['access'=> 'admin'], 'admin/site/set_maintenance_mode'=>['access'=> 'admin'], 'admin/site/set_robots'=>['access'=> 'admin'], 'admin/site/theme'=>['access'=> 'admin'], 'admin/site/unlock_upgrade'=>['access'=> 'admin'], 'admin/site/settings'=>['access'=> 'admin'], 'admin/upgrade'=>['access'=> 'admin'], 'admin/upgrade/reset'=>['access'=> 'admin'], 'admin/user/ban'=>['access'=> 'admin'], 'admin/user/bulk/ban'=>['access'=> 'admin'], 'admin/user/bulk/delete'=>['access'=> 'admin'], 'admin/user/bulk/unban'=>['access'=> 'admin'], 'admin/user/bulk/validate'=>['access'=> 'admin'], 'admin/user/change_email'=>['access'=> 'admin'], 'admin/user/delete'=>['access'=> 'admin'], 'admin/user/login_as'=>['access'=> 'admin'], 'admin/user/logout_as'=>[], 'admin/user/makeadmin'=>['access'=> 'admin'], 'admin/user/resetpassword'=>['access'=> 'admin'], 'admin/user/removeadmin'=>['access'=> 'admin'], 'admin/user/unban'=>['access'=> 'admin'], 'admin/user/validate'=>['access'=> 'admin'], 'annotation/delete'=>[], 'avatar/upload'=>[], 'comment/save'=>[], 'diagnostics/download'=>['access'=> 'admin'], 'entity/chooserestoredestination'=>[], 'entity/delete'=>[], 'entity/mute'=>[], 'entity/restore'=>[], 'entity/subscribe'=>[], 'entity/trash'=>[], 'entity/unmute'=>[], 'entity/unsubscribe'=>[], 'login'=>['access'=> 'logged_out'], 'logout'=>[], 'notifications/mute'=>['access'=> 'public'], 'plugins/settings/remove'=>['access'=> 'admin'], 'plugins/settings/save'=>['access'=> 'admin'], 'plugins/usersettings/save'=>[], 'register'=>['access'=> 'logged_out', 'middleware'=>[\Elgg\Router\Middleware\RegistrationAllowedGatekeeper::class,],], 'river/delete'=>[], 'settings/notifications'=>[], 'settings/notifications/subscriptions'=>[], 'user/changepassword'=>['access'=> 'public'], 'user/requestnewpassword'=>['access'=> 'public'], 'useradd'=>['access'=> 'admin'], 'usersettings/save'=>[], 'widgets/add'=>[], 'widgets/delete'=>[], 'widgets/move'=>[], 'widgets/save'=>[],]
Definition: actions.php:73
$attributes
Elgg AJAX loader.
Definition: ajax_loader.php:10
_elgg_services()
Get the global service provider.
Definition: elgglib.php:353
elgg_make_sticky_form(string $form_name, array $ignored_field_names=[])
Save form submission data (all GET and POST vars) into a session cache.
Definition: input.php:105
elgg_is_valid_email(string $address)
Validates an email address.
Definition: input.php:89
elgg_get_sticky_value(string $form_name, string $variable='', $default=null, bool $filter_result=true)
Get a specific value from cached form submission data.
Definition: input.php:148
elgg_is_sticky_form(string $form_name)
Does form submission data exist for this form?
Definition: input.php:133
elgg_string_to_array(string $string)
Takes in a comma-separated string and returns an array of uniquely trimmed and stripped strings.
Definition: input.php:226
elgg_sanitize_input($input)
Filter input from a given string based on registered events.
Definition: input.php:77
elgg_get_request_data(bool $filter_result=true)
Returns all values parsed from the current request, including $_GET and $_POST values,...
Definition: input.php:50
elgg_get_title_input(string $variable='title', string $default='')
Get an HTML-escaped title from input.
Definition: input.php:63
get_input(string $variable, $default=null, bool $filter_result=true)
Parameter input functions.
Definition: input.php:20
_elgg_htmlawed_tag_post_processor(string $tag, array|int $attributes=0)
Post processor for tags in htmlawed.
Definition: input.php:193
elgg_clear_sticky_form(string $form_name)
Remove form submission data from the session.
Definition: input.php:121
elgg_is_empty($value)
Check if a value isn't empty, but allow 0 and '0'.
Definition: input.php:176
set_input(string $variable, $value)
Sets an input value that may later be retrieved by get_input.
Definition: input.php:34
elgg_get_sticky_values(string $form_name, bool $filter_result=true)
Get all submission data cached for a form.
Definition: input.php:161
$value
Definition: generic.php:51
$default
Definition: checkbox.php:30
elgg_trigger_event_results(string $event, string $type, array $params=[], $returnvalue=null)
Triggers an event where it is expected that the mixed return value could be manipulated by event call...
Definition: events.php:117
if(!is_string($title)|| $title==='') $tag
Definition: title.php:15
if(elgg_is_empty( $input))
Definition: input.php:10
$input
Definition: input.php:9