1. class
  2. Drush
  3. \
  4. Commands
  5. \
  6. field
  7. \
  8. FieldCreateCommands

FieldCreateCommands

class FieldCreateCommands extends DrushCommands implements CustomEventAwareInterface (View source)

Traits

EntityTypeBundleAskTrait
CustomEventAwareTrait
EntityTypeBundleValidationTrait
ProcessManagerAwareTrait
ExecTrait
ConfigAwareTrait
LoggerAwareTrait
IO
ConfiguresPrompts
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

CREATE

Properties

protected $uri from  ExecTrait
protected CommandData|null $commandData from  DrushCommands
InputInterface $input from  EntityTypeBundleAskTrait
EntityTypeBundleInfoInterface $entityTypeBundleInfo from  EntityTypeBundleAskTrait
EntityTypeManagerInterface $entityTypeManager from  EntityTypeBundleValidationTrait
protected ContentTranslationManagerInterface $contentTranslationManager

Methods

bool
startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

Starts a background browser/tab for the current site or a specified URL.

from  ExecTrait
static bool
programExists($program)

No description

from  ExecTrait
static string
getEditor(string|null $editor = null)

No description

from  ExecTrait
DrushConfig
getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

from  ConfigAwareTrait
void
configurePrompts(InputInterface $input)

Configure the prompt fallbacks.

from  ConfiguresPrompts
mixed
promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Prompt the user until the given validation callback passes.

from  ConfiguresPrompts
void
restorePrompts()

Restore the prompts output.

from  ConfiguresPrompts
bool
runningUnitTests()

No description

from  ConfiguresPrompts
__construct(FieldTypePluginManagerInterface $fieldTypePluginManager, WidgetPluginManager $widgetPluginManager, SelectionPluginManagerInterface $selectionPluginManager, EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $entityTypeBundleInfo, ModuleHandlerInterface $moduleHandler, EntityFieldManagerInterface $entityFieldManager)

No description

DrushStyle
io()

Override Robo's IO function with our custom style.

from  DrushCommands
DrushLoggerManager|null
logger()

Returns a logger object.

from  DrushCommands
void
printFile(string $file)

Print the contents of a file.

from  DrushCommands
preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

from  DrushCommands
initHook($input, AnnotationData $annotationData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

from  DrushCommands
printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

from  DrushCommands
HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

from  DrushCommands
ProcessManager
processManager()

This method overrides the trait in order to provide a more specific return type.

from  DrushCommands
array
getFieldableEntityTypes()

No description

from  EntityTypeBundleAskTrait
string|null
askEntityType()

No description

from  EntityTypeBundleAskTrait
string|null
askBundle()

No description

from  EntityTypeBundleAskTrait
void
validateEntityType(string $entityTypeId)

No description

from  EntityTypeBundleValidationTrait
void
validateBundle(string $entityTypeId, string $bundle)

No description

from  EntityTypeBundleValidationTrait
static FieldCreateCommands
create(ContainerInterface $container)

No description

void
setContentTranslationManager(ContentTranslationManagerInterface|null $manager = null)

No description

void
fieldCreate(string|null $entityType = null, string|null $bundle = null, array $options = ['field-name' => InputOption::VALUE_REQUIRED, 'field-label' => InputOption::VALUE_REQUIRED, 'field-description' => InputOption::VALUE_OPTIONAL, 'field-type' => InputOption::VALUE_REQUIRED, 'field-widget' => InputOption::VALUE_REQUIRED, 'is-required' => InputOption::VALUE_OPTIONAL, 'is-translatable' => InputOption::VALUE_OPTIONAL, 'cardinality' => InputOption::VALUE_REQUIRED, 'target-type' => InputOption::VALUE_OPTIONAL, 'target-bundle' => InputOption::VALUE_OPTIONAL, 'show-machine-names' => InputOption::VALUE_OPTIONAL, 'existing-field-name' => InputOption::VALUE_OPTIONAL, 'existing' => false])

Create a new field

void
complete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

string|null
askExistingFieldName()

No description

string
askFieldName()

No description

string
askFieldLabel()

No description

string|null
askFieldDescription()

No description

string
askFieldType()

No description

string|null
askFieldWidget()

No description

bool
askRequired()

No description

bool
askTranslatable()

No description

int
askCardinality()

No description

FieldConfigInterface
createField()

No description

FieldStorageConfigInterface
createFieldStorage()

No description

void
createFieldDisplay(string $context)

No description

EntityDisplayInterface|null
getEntityDisplay(string $context)

No description

void
logResult(FieldConfigInterface $field)

No description

string
generateFieldName(string $source, string $bundle)

No description

bool
fieldExists(string $fieldName, string $entityType, string $bundle)

No description

bool
fieldStorageExists(string $fieldName, string $entityType)

No description

array
getExistingFieldStorageOptions(string $entityType, string $bundle, bool $showMachineNames)

No description

bool
hasContentTranslation()

No description

void
ensureOption(string $name, callable $asker, bool $required)

No description

Details

in ExecTrait at line 28
bool startBrowser(string|null $uri = null, int $sleep = 0, int|null $port = null, string|bool $browser = false)

Starts a background browser/tab for the current site or a specified URL.

Uses a non-blocking Process call, so Drush execution will continue.

Parameters

string|null $uri

Optional URI or site path to open in browser. If omitted, or if a site path is specified, the current site home page uri will be prepended if the site's hostname resolves.
int $sleep
int|null $port
string|bool $browser

Return Value

bool

TRUE if browser was opened. FALSE if browser was disabled by the user or a default browser could not be found.

in ExecTrait at line 92
static bool programExists($program)

No description

Parameters

$program

Return Value

bool

in ExecTrait at line 104
static string getEditor(string|null $editor = null)

No description

Parameters

string|null $editor

Return Value

string

in ConfigAwareTrait at line 19
DrushConfig getConfig()

Replaces same method in ConfigAwareTrait in order to provide a DrushConfig as return type. Helps with IDE completion.

Return Value

DrushConfig

See also

https://stackoverflow.com/a/37687295.

in ConfiguresPrompts at line 30
protected void configurePrompts(InputInterface $input)

Configure the prompt fallbacks.

Parameters

InputInterface $input

Return Value

void

in ConfiguresPrompts at line 148
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Prompt the user until the given validation callback passes.

Parameters

Closure $prompt
bool|string $required
Closure|null $validate

Return Value

mixed

in ConfiguresPrompts at line 179
protected void restorePrompts()

Restore the prompts output.

Return Value

void

in ConfiguresPrompts at line 184
protected bool runningUnitTests()

No description

Return Value

bool

at line 43
__construct(FieldTypePluginManagerInterface $fieldTypePluginManager, WidgetPluginManager $widgetPluginManager, SelectionPluginManagerInterface $selectionPluginManager, EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $entityTypeBundleInfo, ModuleHandlerInterface $moduleHandler, EntityFieldManagerInterface $entityFieldManager)

No description

Parameters

FieldTypePluginManagerInterface $fieldTypePluginManager
WidgetPluginManager $widgetPluginManager
SelectionPluginManagerInterface $selectionPluginManager
EntityTypeManagerInterface $entityTypeManager
EntityTypeBundleInfoInterface $entityTypeBundleInfo
ModuleHandlerInterface $moduleHandler
EntityFieldManagerInterface $entityFieldManager

in DrushCommands at line 60
protected DrushStyle io()

Override Robo's IO function with our custom style.

Return Value

DrushStyle

in DrushCommands at line 74
DrushLoggerManager|null logger()

Returns a logger object.

Return Value

DrushLoggerManager|null

in DrushCommands at line 86
protected void printFile(string $file)

Print the contents of a file.

Parameters

string $file

Full path to a file.

Return Value

void

in DrushCommands at line 108
preHook(CommandData $commandData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

Parameters

CommandData $commandData

in DrushCommands at line 117
initHook($input, AnnotationData $annotationData)

Persist commandData for use in primary command callback. Used by 'topic' commands.

Parameters

$input
AnnotationData $annotationData

in DrushCommands at line 130
protected printFileTopic(CommandData $commandData)

Print the contents of a file. The path comes from the @topic annotation.

Parameters

CommandData $commandData

Full path to a file.

in DrushCommands at line 141
protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

Return Value

HandlerStack

See also

https://stackoverflow.com/questions/32681165/how-do-you-log-all-api-calls-using-guzzle-6.

in DrushCommands at line 151
ProcessManager processManager()

This method overrides the trait in order to provide a more specific return type.

Return Value

ProcessManager

in EntityTypeBundleAskTrait at line 22
protected array getFieldableEntityTypes()

No description

Return Value

array

in EntityTypeBundleAskTrait at line 32
protected string|null askEntityType()

No description

Return Value

string|null

in EntityTypeBundleAskTrait at line 50
protected string|null askBundle()

No description

Return Value

string|null

in EntityTypeBundleValidationTrait at line 16
protected void validateEntityType(string $entityTypeId)

No description

Parameters

string $entityTypeId

Return Value

void

in EntityTypeBundleValidationTrait at line 25
protected void validateBundle(string $entityTypeId, string $bundle)

No description

Parameters

string $entityTypeId
string $bundle

Return Value

void

at line 55
static FieldCreateCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

FieldCreateCommands

at line 74
void setContentTranslationManager(ContentTranslationManagerInterface|null $manager = null)

No description

Parameters

ContentTranslationManagerInterface|null $manager

Return Value

void

at line 87
void fieldCreate(string|null $entityType = null, string|null $bundle = null, array $options = ['field-name' => InputOption::VALUE_REQUIRED, 'field-label' => InputOption::VALUE_REQUIRED, 'field-description' => InputOption::VALUE_OPTIONAL, 'field-type' => InputOption::VALUE_REQUIRED, 'field-widget' => InputOption::VALUE_REQUIRED, 'is-required' => InputOption::VALUE_OPTIONAL, 'is-translatable' => InputOption::VALUE_OPTIONAL, 'cardinality' => InputOption::VALUE_REQUIRED, 'target-type' => InputOption::VALUE_OPTIONAL, 'target-bundle' => InputOption::VALUE_OPTIONAL, 'show-machine-names' => InputOption::VALUE_OPTIONAL, 'existing-field-name' => InputOption::VALUE_OPTIONAL, 'existing' => false])

Create a new field

Parameters

string|null $entityType
string|null $bundle
array $options

Return Value

void

See also

FieldConfigEditForm
FieldStorageConfigEditForm

at line 203
void complete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

Parameters

CompletionInput $input
CompletionSuggestions $suggestions

Return Value

void

at line 256
protected string|null askExistingFieldName()

No description

Return Value

string|null

at line 270
protected string askFieldName()

No description

Return Value

string

at line 303
protected string askFieldLabel()

No description

Return Value

string

at line 308
protected string|null askFieldDescription()

No description

Return Value

string|null

at line 313
protected string askFieldType()

No description

Return Value

string

at line 330
protected string|null askFieldWidget()

No description

Return Value

string|null

at line 361
protected bool askRequired()

No description

Return Value

bool

at line 366
protected bool askTranslatable()

No description

Return Value

bool

at line 375
protected int askCardinality()

No description

Return Value

int

at line 400
protected FieldConfigInterface createField()

No description

Return Value

FieldConfigInterface

at line 428
protected FieldStorageConfigInterface createFieldStorage()

No description

Return Value

FieldStorageConfigInterface

at line 454
protected void createFieldDisplay(string $context)

No description

Parameters

string $context

Return Value

void

at line 496
protected EntityDisplayInterface|null getEntityDisplay(string $context)

No description

Parameters

string $context

Return Value

EntityDisplayInterface|null

at line 508
protected void logResult(FieldConfigInterface $field)

No description

Parameters

FieldConfigInterface $field

Return Value

void

at line 539
protected string generateFieldName(string $source, string $bundle)

No description

Parameters

string $source
string $bundle

Return Value

string

at line 557
protected bool fieldExists(string $fieldName, string $entityType, string $bundle)

No description

Parameters

string $fieldName
string $entityType
string $bundle

Return Value

bool

at line 564
protected bool fieldStorageExists(string $fieldName, string $entityType)

No description

Parameters

string $fieldName
string $entityType

Return Value

bool

at line 571
protected array getExistingFieldStorageOptions(string $entityType, string $bundle, bool $showMachineNames)

No description

Parameters

string $entityType
string $bundle
bool $showMachineNames

Return Value

array

at line 602
protected bool hasContentTranslation()

No description

Return Value

bool

at line 611
protected void ensureOption(string $name, callable $asker, bool $required)

No description

Parameters

string $name
callable $asker
bool $required

Return Value

void