Function __global->rain_get_special_icons

Definitions

sources/realtime_rain.php

  • Returns a map with an icon and multiplicity parameter (that may be null).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$ip_address ?IP No No required parameter N/A N/A An IP address (used to check against bots) (null: no IP)
$timestamp TIME No No required parameter N/A N/A A timestamp (used to check for logged sent e-mails)
$user_agent ?string No No Null N/A N/A A user agent (used to check against phones) (null: no user agent)
$news ?string No No Null N/A N/A News ticker news (null: no news ticker news)

Returns

  • Map with an icon and multiplicity parameter
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Returns a map with an icon and multiplicity parameter (that may be null).
 *
 * @param  ?IP $ip_address An IP address (used to check against bots) (null: no IP)
 * @param  TIME $timestamp A timestamp (used to check for logged sent e-mails)
 * @param  ?string $user_agent A user agent (used to check against phones) (null: no user agent)
 * @param  ?string $news News ticker news (null: no news ticker news)
 * @return array Map with an icon and multiplicity parameter
 */
function rain_get_special_icons(?string $ip_address, int $timestamp, ?string $user_agent = null, ?string $news = null) : array