class FieldBaseOverrideCreateCommands extends DrushCommands (View source)

Traits

ProcessManagerAwareTrait
LoggerAwareTrait
IO
ConfigAwareTrait

Constants

REQ

OPT

EXIT_SUCCESS

EXIT_FAILURE

EXIT_FAILURE_WITH_CLARITY

Properties

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

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.

static bool
programExists($program)

No description

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

No description

getConfig()

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

__construct(EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $entityTypeBundleInfo, EntityFieldManagerInterface $entityFieldManager)

No description

SymfonyStyle
io()

Override Robo's IO function with our custom style.

DrushLoggerManager|null
logger()

Returns a logger object.

void
printFile(string $file)

Print the contents of a file.

preHook(CommandData $commandData)

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

printFileTopic(CommandData $commandData)

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

HandlerStack
getStack()

Get a Guzzle handler stack that uses the Drush logger.

array
getFieldableEntityTypes()

No description

string|null
askEntityType()

No description

string|null
askBundle()

No description

void
validateEntityType(string $entityTypeId)

No description

void
validateBundle(string $entityTypeId, string $bundle)

No description

create(ContainerInterface $container)

No description

void
baseOverrideCreateField(string|null $entityType = null, string|null $bundle = null, array $options = ['field-name' => InputOption::VALUE_REQUIRED, 'field-label' => InputOption::VALUE_REQUIRED, 'field-description' => InputOption::VALUE_REQUIRED, 'is-required' => InputOption::VALUE_REQUIRED, 'show-machine-names' => InputOption::VALUE_OPTIONAL])

Create a new base field override

void
complete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

string|null
askFieldName(string $entityType)

No description

string
askFieldLabel(string $default)

No description

string|null
askFieldDescription(string|null $default)

No description

bool
askRequired(bool $default)

No description

BaseFieldOverride
createBaseFieldOverride(string $entityType, string $bundle, string $fieldName, $fieldLabel, $fieldDescription, bool $isRequired)

No description

void
logResult(BaseFieldOverride $baseFieldOverride)

No description

BaseFieldDefinition|null
getBaseFieldDefinition(string $entityType, string $fieldName)

No description

Details

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

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

static bool programExists($program)

No description

Parameters

$program

Return Value

bool

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

No description

Parameters

string|null $editor

Return Value

string

DrushConfig getConfig()

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

__construct(EntityTypeManagerInterface $entityTypeManager, EntityTypeBundleInfoInterface $entityTypeBundleInfo, EntityFieldManagerInterface $entityFieldManager)

No description

Parameters

EntityTypeManagerInterface $entityTypeManager
EntityTypeBundleInfoInterface $entityTypeBundleInfo
EntityFieldManagerInterface $entityFieldManager

protected SymfonyStyle io()

Override Robo's IO function with our custom style.

Return Value

SymfonyStyle

protected DrushLoggerManager|null logger()

Returns a logger object.

Return Value

DrushLoggerManager|null

protected void printFile(string $file)

Print the contents of a file.

Parameters

string $file

Full path to a file.

Return Value

void

preHook(CommandData $commandData)

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

Parameters

CommandData $commandData

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.

protected HandlerStack getStack()

Get a Guzzle handler stack that uses the Drush logger.

protected array getFieldableEntityTypes()

No description

Return Value

array

protected string|null askEntityType()

No description

Return Value

string|null

protected string|null askBundle()

No description

Return Value

string|null

protected void validateEntityType(string $entityTypeId)

No description

Parameters

string $entityTypeId

Return Value

void

protected void validateBundle(string $entityTypeId, string $bundle)

No description

Parameters

string $entityTypeId
string $bundle

Return Value

void

static FieldBaseOverrideCreateCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

FieldBaseOverrideCreateCommands

void baseOverrideCreateField(string|null $entityType = null, string|null $bundle = null, array $options = ['field-name' => InputOption::VALUE_REQUIRED, 'field-label' => InputOption::VALUE_REQUIRED, 'field-description' => InputOption::VALUE_REQUIRED, 'is-required' => InputOption::VALUE_REQUIRED, 'show-machine-names' => InputOption::VALUE_OPTIONAL])

Create a new base field override

Parameters

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

Return Value

void

See also

FieldConfigEditForm
FieldStorageConfigEditForm

void complete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

Parameters

CompletionInput $input
CompletionSuggestions $suggestions

Return Value

void

protected string|null askFieldName(string $entityType)

No description

Parameters

string $entityType

Return Value

string|null

protected string askFieldLabel(string $default)

No description

Parameters

string $default

Return Value

string

protected string|null askFieldDescription(string|null $default)

No description

Parameters

string|null $default

Return Value

string|null

protected bool askRequired(bool $default)

No description

Parameters

bool $default

Return Value

bool

protected BaseFieldOverride createBaseFieldOverride(string $entityType, string $bundle, string $fieldName, $fieldLabel, $fieldDescription, bool $isRequired)

No description

Parameters

string $entityType
string $bundle
string $fieldName
$fieldLabel
$fieldDescription
bool $isRequired

Return Value

BaseFieldOverride

protected void logResult(BaseFieldOverride $baseFieldOverride)

No description

Parameters

BaseFieldOverride $baseFieldOverride

Return Value

void

protected BaseFieldDefinition|null getBaseFieldDefinition(string $entityType, string $fieldName)

No description

Parameters

string $entityType
string $fieldName

Return Value

BaseFieldDefinition|null