class FieldBaseInfoCommands extends DrushCommands (View source)

Traits

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

renderArray($key, $value, FormatterOptions $options)

No description

renderBoolean($key, $value, FormatterOptions $options)

No description

RowsOfFields
getRowsOfFieldsByFieldDefinitions(array $fieldDefinitions)

No description

create(ContainerInterface $container)

No description

RowsOfFields
info(string|null $entityType = null, array $options = ['format' => 'table'])

List all base fields of an entity type

void
complete(CompletionInput $input, CompletionSuggestions $suggestions)

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

renderArray($key, $value, FormatterOptions $options)

No description

Parameters

$key
$value
FormatterOptions $options

renderBoolean($key, $value, FormatterOptions $options)

No description

Parameters

$key
$value
FormatterOptions $options

protected RowsOfFields getRowsOfFieldsByFieldDefinitions(array $fieldDefinitions)

No description

Parameters

array $fieldDefinitions

Return Value

RowsOfFields

static FieldBaseInfoCommands create(ContainerInterface $container)

No description

Parameters

ContainerInterface $container

Return Value

FieldBaseInfoCommands

RowsOfFields info(string|null $entityType = null, array $options = ['format' => 'table'])

List all base fields of an entity type

Parameters

string|null $entityType
array $options

Return Value

RowsOfFields

void complete(CompletionInput $input, CompletionSuggestions $suggestions)

No description

Parameters

CompletionInput $input
CompletionSuggestions $suggestions

Return Value

void