Function __global->cms_verify_parameters_phpdoc

Definitions

sources/developer_tools.php

  • Verify the parameters passed into the *calling* function match the PHPDoc specification for that function.Useful when testing robustness of APIs where the CQC and ocProducts PHP are not suitable.For example, when web APIs are plumbed into the software's APIs and you need to ensure the types are coming in correctly.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$dev_only boolean No No False N/A N/A Whether to only run the checks in dev-mode

Preview

Code (PHP)

/**
 * Verify the parameters passed into the *calling* function match the PHPDoc specification for that function.Useful when testing robustness of APIs where the CQC and ocProducts PHP are not suitable.For example, when web APIs are plumbed into the software's APIs and you need to ensure the types are coming in correctly.
 *
 * @param  boolean $dev_only Whether to only run the checks in dev-mode
 */

function cms_verify_parameters_phpdoc(bool $dev_only = false)