Function __global->rain_truncate_for_title

Definitions

sources/realtime_rain.php

  • Make a realtime event bubble's title fit in the available space.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$text string No No required parameter N/A N/A Idealised title

Returns

  • Cropped title, with tooltip for full title
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Make a realtime event bubble's title fit in the available space.
 *
 * @param  string $text Idealised title
 * @return Tempcode Cropped title, with tooltip for full title
 */
function rain_truncate_for_title(string $text) : object