API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\AdminAdminScript

Summary

Methods
Properties
Constants
setDependencies()
No public properties found
No constants found
setModelFactory()
modelFactory()
propertyToInput()
No protected properties found
N/A
booleanInput()
passwordInput()
$modelFactory
N/A

Properties

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

Methods

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

\Pimple\Container $container

Pimple DI container.

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\AdminScript

Parameters

\Charcoal\Factory\FactoryInterface $factory

The factory used to create models.

Returns

\Charcoal\Admin\AdminScript —

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

\Charcoal\Factory\FactoryInterface —

The model factory.

propertyToInput()

propertyToInput(\Charcoal\Property\PropertyInterface  $prop) : mixed

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

mixed

booleanInput()

booleanInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI input from a boolean property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input

passwordInput()

passwordInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI password input (hidden) from a password property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input