oikai_reflect_usage() – Display the Syntax for calling the API

You appear to be a bot. Output may be restricted

Description

Display the Syntax for calling the API

Usage

oikai_reflect_usage( $refFunc, $docblock, $funcname );

Parameters

$refFunc

( object ) required – reflection object

$docblock

( object ) required – the docblock object

$funcname

( string ) required – the function or method name

Returns

void

Source

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

function oikai_reflect_usage( $refFunc, $docblock, $funcname ) {
  h2( "Usage");
  stag( "pre", null, null, "lang=PHP" );
  $return_type = oikai_print_return( $refFunc, $docblock, false );
  if ( $return_type ) {
   e ( "$" . $return_type . " = ");
  }
  e( "$funcname(" );
  $sep = " $";
  $param = null;
  if ( $refFunc && $refFunc->getParameters() && count( $refFunc->getParameters() ) ) {
    foreach( $refFunc->getParameters() as $param ) {
      e ( $sep );
      e( $param->getName() );
      $sep = ", $";
    }
  }  
  if ( $param ) { 
    e( " " );
  }  
  e ( ");" );   
  etag( "pre" );
}
 

 View on GitHub