Docs For Class ArgumentRenderer

Description

An ArgumentRenderer provides functionallity to print/render/format a list of arguments.

version: $Id: ArgumentRenderer.class.php,v 1.6 2006/01/13 16:11:05 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/utilities/ArgumentRenderer.class.php (line 16)

Method Summary

string renderManyArguments (array $arguments, [boolean $isDetailed = false], [boolean $shouldPrint = false], integer $trim)

string renderOneArgument (mixed $argument, [boolean $isDetailed = false], [boolean $shouldPrint = false], integer $trim)

Methods

renderManyArguments (line 116)

Renders many arguments.

Renders many arguments by printing their types and values and comma delimiting them. In 'detailed' mode, includes some additional information (i.e., for arrays, prints all elements of the array; for objects, prints the object structure).

return: The output of the method. This will be output to the browser if $shouldPrint is set to TRUE. Returns FALSE, if something goes wrong.
access: public

string renderManyArguments (array $arguments, [boolean $isDetailed = false], [boolean $shouldPrint = false], integer $trim)

array $arguments: The arguments to render.
boolean $isDetailed: If TRUE, will print additional details.
boolean $shouldPrint: If TRUE, will print on screen; If FALSE, will not
integer $trim: If >0, will trim the argument to to the given length print, but just return the result as a string.

renderOneArgument (line 32)

Renders one argument.

Renders one argument by printing its type and value. In 'detailed' mode, includes some additional information (i.e., for arrays, prints all elements of the array; for objects, prints the object structure).

return: The output of the method. This will be output to the browser if $shouldPrint is set to TRUE.
access: public

string renderOneArgument (mixed $argument, [boolean $isDetailed = false], [boolean $shouldPrint = false], integer $trim)

mixed $argument: The argument to render.
boolean $isDetailed: If TRUE, will print additional details.
boolean $shouldPrint: If TRUE, will print on screen; If FALSE, will not print, but just return the result as a string.
integer $trim: If >0, will trim the argument to to the given length