Function __global->_get_schedule_code_prefix

Definitions

sources/calendar2.php

  • Helper for getting the Commandr prefix for scheduled calendar events.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$hook ID_TEXT No No required parameter N/A N/A Hook to run under systems/commandr_scheduled
$id string No No required parameter N/A N/A Unspecified identifier for the resource behind this scheduled event, for future querying to find said event; also passed to the Commandr hook

Returns

  • Commandr command prefix before adding json parameters
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Helper for getting the Commandr prefix for scheduled calendar events.
 *
 * @param  ID_TEXT $hook Hook to run under systems/commandr_scheduled
 * @param  string $id Unspecified identifier for the resource behind this scheduled event, for future querying to find said event; also passed to the Commandr hook
 * @return string Commandr command prefix before adding json parameters
 */

function _get_schedule_code_prefix(string $hook, string $id) : string