oikai_print_return() – Print information about the @return value

You appear to be a bot. Output may be restricted

Description

Print information about the @return value

Usage

$type = oikai_print_return( $refFunc, $docblock, $print );

Parameters

$refFunc

( object ) required – the reference function

$docblock

( object ) required – the docBlock

$print

( bool ) optional default: 1 – whether or not to print the output

Returns

type the data type returned by the function

Source

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

function oikai_print_return( $refFunc, $docblock, $print=true ) {
  // $returnsref = $refFunc->returnsReference();
  $tags = $docblock->getTags();
  $type = null;
  $description = null;
  foreach ( $tags as $tag ) {
    list( $tagname, $type, $description ) = explode( " ", $tag . " . . .", 3 );
    if ( ( $tagname == "@return" ) ) { 
      break;
    } else {
      $type = null;
      $description = null;
    }  
  }
  if ( $print ) {
    oikai_print_return_info( $type, $description );
  }
  return( $type );
}
 

 View on GitHub