Function Module_admin_setupwizard->get_effective_step

Definitions

adminzone/pages/modules/admin_setupwizard.php

  • Get the effective step number, when missing steps are considered.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$step integer No No required parameter N/A N/A System step number

Returns

  • Effective step number
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the effective step number, when missing steps are considered.
 *
 * @param  integer $step System step number
 * @return integer Effective step number
 */

protected function get_effective_step(int $step) : int