oikai_print_param_info() – Print a function’s parameters in a definition list

You appear to be a bot. Output may be restricted

Description

Print a function's parameters in a definition list

Usage

oikai_print_param_info( $param, $type, $name, $description );

Parameters

$param

( ReflectionParameter ) required – the nth parameter

$type

( string ) optional default: mixed – parameter type. e.g. string, integer, array, mixed, post or an object type

$name

( string ) optional – parameter name – should match $param->getName()

$description

( string ) optional – parameter description

Returns

void

Source

File name: oik-shortcodes/shortcodes/oik-api-importer.php
Lines:

function oikai_print_param_info( $param, $type="mixed", $name=null, $description=null ) {
  //bw_trace2(); 
  //bw_backtrace();
  if ( null == $name ) {
    $name = "$" . $param->getName();
  } 
  $pos = $param->getPosition();
  $pos++;
  //bw_trace2( $pos, "pos" );
  $optional = $param->isOptional();
  //bw_trace2( $optional, "optional" );

  //bw_trace2( $param, "param" );
  //bw_trace2( $type );
  //bw_trace2( $name );
  //bw_trace2( $description );
  if ( $param->isDefaultValueAvailable() ) {
    $constant = $param->isDefaultValueConstant();
    if ( $constant ) {
      $default = $param->getDefaultValueConstantName();
    } else {
      $default = $param->getDefaultValue();
    }
  } else {
    $default = null;
  }  
  //bw_trace2( $default, "Default: ");
  $passedbyref = $param->isPassedByReference();
  //bw_trace2( $passedbyref, "passed by ref" );
  
  stag( "dt" );
  e( $name );
  etag( "dt" );
  stag( "dd" );
  $dd = "( $type ) ";
  $dd .= ( $optional ) ? "<i>optional</i>" : "<i>required</i>" ;
  $dd .= " ";
  $dd .= ( $default )  ? "default: " . $default : "";
  $dd .= " - ";
  //$dd .= esc_html( substr( $description, 0, -5 ));
  e( $dd );
  //$description = substr( $description, 0, -5 );
  $description = ltrim( $description, "- " );
  oikai_format_description( $description );
  etag( "dd" );
} 
 

 View on GitHub