PEAR_Size
[ class tree: PEAR_Size ] [ index: PEAR_Size ] [ all elements ]

Class: PEAR_Size_CLI

Source Location: /PEAR_Size-0.2.0/Size/Size_CLI.php

Class Overview


This class invokes the PEAR_Size for command line scripts.


Author(s):

Version:

  • Release: 0.2.0

Copyright:

  • 2008 Ken Guest

Methods


Inherited Variables

Inherited Methods


Class Details

[line 26]
This class invokes the PEAR_Size for command line scripts.


[ Top ]


Method Detail

appName   [line 61]

string appName( )

return name of app/script using this class.
  • Access: public

[ Top ]

run   [line 168]

integer run( [mixed $options = null])

run
  • See: Console_Table
  • Access: public

Parameters:

mixed   $options     optional array of options as returned by getopt

[ Top ]

setAppName   [line 79]

void setAppName( string $name)

set application name (used by plugins to PEAR etc)
  • Access: public

Parameters:

string   $name     application name

[ Top ]

usage   [line 95]

void usage( [mixed $error = null])

usage

Display either given error message, which can be in an array, or the usage screen.

  • Access: public

Parameters:

mixed   $error     string or array of strings of error messages to display. If null, which is the default, the usage screen is displayed.

[ Top ]


Documentation generated on Thu, 05 Nov 2009 10:00:03 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.