1. class
  2. SilverStripe
  3. \
  4. GraphQL
  5. \
  6. Scaffolding
  7. \
  8. Scaffolders
  9. \
  10. ArgumentScaffolder

ArgumentScaffolder

class ArgumentScaffolder implements ConfigurationApplier (View source)

Properties

string $argName

Methods

__construct(string $argName, string $typeStr)

ArgumentScaffolder constructor

$this
setRequired(bool $bool)

Sets the argument as required

$this
setDescription(string $description)

Sets the argument description

$this
setDefaultValue(mixed $value)

Sets the default value of the argument

string
getDescription()

No description

mixed
getDefaultValue()

No description

bool
isRequired()

No description

applyConfig(array $config)

Applies an array of configuration to the scaffolder

array
toArray(Manager $manager = null)

Creates an array suitable for a map of args in a field

Details

at line 45
__construct(string $argName, string $typeStr)

ArgumentScaffolder constructor

Parameters

string $argName

Name of the argument
string $typeStr

A string describing the type (see TypeParser)

at line 63
$this setRequired(bool $bool)

Sets the argument as required

Parameters

bool $bool

Return Value

$this

at line 76
$this setDescription(string $description)

Sets the argument description

Parameters

string $description

Return Value

$this

at line 89
$this setDefaultValue(mixed $value)

Sets the default value of the argument

Parameters

mixed $value

Return Value

$this

at line 99
string getDescription()

Return Value

string

at line 107
mixed getDefaultValue()

Return Value

mixed

at line 115
bool isRequired()

Return Value

bool

at line 125
applyConfig(array $config)

Applies an array of configuration to the scaffolder

Parameters

array $config

at line 145
array toArray(Manager $manager = null)

Creates an array suitable for a map of args in a field

Parameters

Manager $manager

Return Value

array