Function Block_main_custom_gfx->_do_image

Definitions

sources/blocks/main_custom_gfx.php

  • Utility method for writing text onto images.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$cache_id ID_TEXT No No required parameter N/A N/A ID
&$map array Yes No required parameter N/A N/A A map of parameters
$img_path URLPATH No No required parameter N/A N/A The image path

Returns

  • URL of completed image OR Tempcode error
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Utility method for writing text onto images.
 *
 * @param  ID_TEXT $cache_id ID
 * @param  array $map A map of parameters
 * @param  URLPATH $img_path The image path
 * @return mixed URL of completed image OR Tempcode error
 */
public function _do_image(string $cache_id, array &$map, string $img_path)