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

Class: PEAR_Size_CLI

Source Location: /PEAR_Size-1.0.0RC1/PEAR/Size/CLI.php

Class Overview


This class invokes the PEAR_Size for command line scripts.


Author(s):

Version:

  • Release: @PACKAGE_VERSION@

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 171]

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 96]

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 Sat, 01 Aug 2015 01:30:09 +0000 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.