Overview

Namespaces

  • Charcoal
    • App
      • Action
      • Config
      • Handler
      • Middleware
      • Module
      • Route
      • Script
      • ServiceProvider
      • Template

Classes

  • AbstractScript

Interfaces

  • CronScriptInterface
  • ScriptInterface

Traits

  • ArgScriptTrait
  • CronScriptTrait
  • PathScriptTrait
  • Overview
  • Namespace
  • Class

Trait ArgScriptTrait

Additional utilities for handling arguments and inputs.

Namespace: Charcoal\App\Script
Located at Charcoal/App/Script/ArgScriptTrait.php
Methods summary
protected array|Traversable
# parseAsArray( mixed $var, string $delimiter = '[\s,]+' )

Resolve the given value as a collection of values.

Resolve the given value as a collection of values.

If the given value is a string, it will be split.

Parameters

$var
An argument to split.
$delimiter
The boundary string.

Returns

array|Traversable

Throws

InvalidArgumentException
If the value cannot be parsed into an array.
protected Charcoal\App\Script\ArgScriptTrait
# parseArguments( )

Parse command line arguments into script properties.

Parse command line arguments into script properties.

Returns

Charcoal\App\Script\ArgScriptTrait

Throws

RuntimeException
If a checkbox/radio argument has no options.
API documentation generated by ApiGen