Console_Parameter Klassenreferenz

Öffentliche Methoden
	registerParams ($params)
	parse ($parameter)
	__get ($key)

Ausführliche Beschreibung

Interpretiert Konsolenparameter und speichert diese in einem assoziativen Feld.

Autor

jan

Definiert in Zeile 23 der Datei Console_Parameter.php.

Dokumentation der Elementfunktionen

__get()

__get

(

$key

)

Die Parameter können direkt über die Klasse abgefragt werden. Der Wert eines unbekannten bzw. nicht gesetzten Parameters ist false.

Parameter

string

$key

Rückgabe

unknown

Definiert in Zeile 145 der Datei Console_Parameter.php.

parse()

parse

(

$parameter

)

Die Parameter durchlaufen.

  // Beispiel:
  $params = new Console_Parameter();
  $params->registerParams(
     array(
        'hilfe' => array(
           'short' => 'h',
           'long'  => 'help'
      ),
   )
);
 
  try
  {
     array_shift($argv); // den Programmnamen aus argv entfernen
     $params->parse($argv);
  } catch(Exception $e)
  {
     echo $e->getMessage()."\n";
  }

Parameter

$params

üblicherweise $argv

Definiert in Zeile 76 der Datei Console_Parameter.php.

Benutzt Console_Parameter_Exception\UNKNOWN_OPTION.

registerParams()

registerParams

(

$params

)

Parameter registrieren

// Beispiel:
$_parameter = array(
   'hilfe' => array(
                 'short' => 'h',
                 'long'  => 'help'
              )
)
$params = new Console_Parameter();
$params->registerParams( $_parameter );

Parameter

$params

Assoc zur Parameter Registrierung.

Definiert in Zeile 44 der Datei Console_Parameter.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /media/ssd/workspace/egocms/develop/lib/base/Console_Parameter.php