Language string extractor
int
1
Default error code
int
0
Default success code
int
Count number of marker errors found
array<string>
An array of directories to exclude.
bool
Holds whether this call should extract the CakePHP Lib messages
string
Current file being processed
array<string>
Files from where to extract
bool
Displays marker error(s) if true
bool
Merge all domain strings into the default.pot file
array<callableCake\Datasource\Locator\LocatorInterface>
A list of overridden model factory functions.
string
The model type to use.
string
Destination path
array<string>
Paths to use when looking for strings
array<string, mixed>
Contains all content waiting to be written
Cake\ORM\Locator\LocatorInterface|null
Table locator instance
array
Extracted tokens
array<string, mixed>
Extracted strings indexed by domain.
string|null
This object's default table alias.
string|null
This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
string
The name of this command.
Constructor
Add a translation to the internal translations property
Build the translate template file contents out of obtained strings
Extract text
Extract tokens out of all files to be processed
Format a string to be added as a translatable string
Method to interact with the user and get path selections.
Get the strings from the position forward
Returns whether this execution is meant to extract string only from directories in folder represented by the APP constant, i.e. this task is extracting strings from same application.
Checks whether a given path is usable for writing.
Indicate an invalid marker on a processed file
Parse tokens
Search files that may contain translatable strings
Set the modelClass property based on conventions.
Prepare a file to be stored
Write the files that need to be stored
Build the translation template header
Halt the the current process with a StopException.
Gets the option parser instance and configures it.
Check whether the old and new output are the same, thus unchanged
Get the command name.
Output help content
Execute the command
Execute another command with the provided set of arguments.
Convenience method to get a table instance.
Get the command description.
Get the model type to be used by this class
Get the command name.
Get the option parser.
Get the root command name.
Gets the table locator.
Hook method invoked by CakePHP when a command is about to be executed.
Loads and constructs repository objects required by this object
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Override a existing callable to generate repositories of a given type.
Run the command.
Set the model type to be used by this class
Set the name this command uses in the collection.
Set the output level based on the Arguments.
Sets the table locator.
__construct()
Constructor
By default CakePHP will construct command objects when building the CommandCollection for your application.
_addTranslation(string $domain, string $msgid, array $details = []): void
Add a translation to the internal translations property
Takes care of duplicate translations
string
$domain The domain
string
$msgid The message string
array
$details optional Context and plural form if any, file and line references
void
_buildFiles(Cake\Console\Arguments $args): void
Build the translate template file contents out of obtained strings
Cake\Console\Arguments
$args Console arguments
void
_extract(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void
Extract text
Cake\Console\Arguments
$args The Arguments instance
Cake\Console\ConsoleIo
$io The io instance
void
_extractTokens(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void
Extract tokens out of all files to be processed
Cake\Console\Arguments
$args The io instance
Cake\Console\ConsoleIo
$io The io instance
void
_formatString(string $string): string
Format a string to be added as a translatable string
string
$string String to format
string
_getPaths(Cake\Console\ConsoleIo $io): void
Method to interact with the user and get path selections.
Cake\Console\ConsoleIo
$io The io instance.
void
_getStrings(int $position, int $target): array
Get the strings from the position forward
int
$position Actual position on tokens array
int
$target Number of strings to extract
array
_isExtractingApp(): bool
Returns whether this execution is meant to extract string only from directories in folder represented by the APP constant, i.e. this task is extracting strings from same application.
bool
_isPathUsable(string $path): bool
Checks whether a given path is usable for writing.
string
$path Path to folder
bool
_markerError(Cake\Console\ConsoleIo $io, string $file, int $line, string $marker, int $count): void
Indicate an invalid marker on a processed file
Cake\Console\ConsoleIo
$io The io instance.
string
$file File where invalid marker resides
int
$line Line number
string
$marker Marker found
int
$count Count
void
_parse(Cake\Console\ConsoleIo $io, string $functionName, array $map): void
Parse tokens
Cake\Console\ConsoleIo
$io The io instance
string
$functionName Function name that indicates translatable string (e.g: '__')
array
$map Array containing what variables it will find (e.g: domain, singular, plural)
void
_searchFiles(): void
Search files that may contain translatable strings
void
_setModelClass(string $name): void
Set the modelClass property based on conventions.
If the property is already set it will not be overwritten
string
$name Class name.
void
_store(string $domain, string $header, string $sentence): void
Prepare a file to be stored
string
$domain The domain
string
$header The header content.
string
$sentence The sentence to store.
void
_writeFiles(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void
Write the files that need to be stored
Cake\Console\Arguments
$args The command arguments.
Cake\Console\ConsoleIo
$io The console io
void
_writeHeader(string $domain): string
Build the translation template header
string
$domain Domain
string
abort(int $code = self::CODE_ERROR): void
Halt the the current process with a StopException.
int
$code optional The exit code to use.
void
Cake\Console\Exception\StopException
buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser
Gets the option parser instance and configures it.
Cake\Console\ConsoleOptionParser
$parser The parser to configure
Cake\Console\ConsoleOptionParser
checkUnchanged(string $oldFile, int $headerLength, string $newFileContent): bool
Check whether the old and new output are the same, thus unchanged
Compares the sha1 hashes of the old and new file without header.
string
$oldFile The existing file.
int
$headerLength The length of the file header in bytes.
string
$newFileContent The content of the new file.
bool
defaultName(): string
Get the command name.
Returns the command name based on class name. For e.g. for a command with class name UpdateTableCommand
the default name returned would be 'update_table'
.
string
displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void
Output help content
Cake\Console\ConsoleOptionParser
$parser The option parser.
Cake\Console\Arguments
$args The command arguments.
Cake\Console\ConsoleIo
$io The console io
void
execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int|null
Execute the command
Cake\Console\Arguments
$args The command arguments.
Cake\Console\ConsoleIo
$io The console io
int|null
executeCommand(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null
Execute another command with the provided set of arguments.
If you are using a string command name, that command's dependencies will not be resolved with the application container. Instead you will need to pass the command as an object with all of its dependencies.
Cake\Console\CommandInterface|string
$command The command class name or command instance.
array
$args optional The arguments to invoke the command with.
Cake\Console\ConsoleIo|null
$io optional The ConsoleIo instance to use for the executed command.
int|null
fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table
Convenience method to get a table instance.
string|null
$alias optional The alias name you want to get. Should be in CamelCase format. If null
then the value of $defaultTable property is used.
array<string, mixed>
$options optional The options you want to build the table with. If a table has already been loaded the registry options will be ignored.
Cake\ORM\Table
Cake\Core\Exception\CakeException
getDescription(): string
Get the command description.
string
getModelType(): string
Get the model type to be used by this class
string
getName(): string
Get the command name.
string
getOptionParser(): Cake\Console\ConsoleOptionParser
Get the option parser.
You can override buildOptionParser() to define your options & arguments.
Cake\Console\ConsoleOptionParser
RuntimeException
getRootName(): string
Get the root command name.
string
getTableLocator(): Cake\ORM\Locator\LocatorInterface
Gets the table locator.
Cake\ORM\Locator\LocatorInterface
initialize(): void
Hook method invoked by CakePHP when a command is about to be executed.
Override this method and implement expensive/important setup steps that should not run on every command run. This method will be called before the options and arguments are validated and processed.
void
loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface
Loads and constructs repository objects required by this object
Typically used to load ORM Table objects as required. Can also be used to load other types of repository objects your application uses.
If a repository provider does not return an object a MissingModelException will be thrown.
string|null
$modelClass optional Name of model class to load. Defaults to $this->modelClass. The name can be an alias like 'Post'
or FQCN like App\Model\Table\PostsTable::class
.
string|null
$modelType optional The type of repository to load. Defaults to the getModelType() value.
Cake\Datasource\RepositoryInterface
Cake\Datasource\Exception\MissingModelException
UnexpectedValueException
log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string
$message Log message.
string|int
$level optional Error level.
array|string
$context optional Additional log data relevant to this message.
bool
modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void
Override a existing callable to generate repositories of a given type.
string
$type The name of the repository type the factory function is for.
Cake\Datasource\Locator\LocatorInterface|callable
$factory The factory function used to create instances.
void
run(array $argv, Cake\Console\ConsoleIo $io): int|null
Run the command.
array
$argv Cake\Console\ConsoleIo
$io int|null
setModelType(string $modelType): $this
Set the model type to be used by this class
string
$modelType The model type
$this
setName(string $name): $this
Set the name this command uses in the collection.
Generally invoked by the CommandCollection when the command is added. Required to have at least one space in the name so that the root command can be calculated.
string
$name $this
setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void
Set the output level based on the Arguments.
Cake\Console\Arguments
$args The command arguments.
Cake\Console\ConsoleIo
$io The console io
void
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this
Sets the table locator.
Cake\ORM\Locator\LocatorInterface
$tableLocator LocatorInterface instance.
$this
Count number of marker errors found
int
An array of directories to exclude.
array<string>
Holds whether this call should extract the CakePHP Lib messages
bool
Current file being processed
string
Files from where to extract
array<string>
Displays marker error(s) if true
bool
Merge all domain strings into the default.pot file
bool
A list of overridden model factory functions.
array<callableCake\Datasource\Locator\LocatorInterface>
The model type to use.
string
Destination path
string
Paths to use when looking for strings
array<string>
Contains all content waiting to be written
array<string, mixed>
Table locator instance
Cake\ORM\Locator\LocatorInterface|null
Extracted tokens
array
Extracted strings indexed by domain.
array<string, mixed>
This object's default table alias.
string|null
This object's primary model class name. Should be a plural form. CakePHP will not inflect the name.
Example: For an object named 'Comments', the modelClass would be 'Comments'. Plugin classes should use Plugin.Comments
style names to correctly load models from the correct plugin.
Use empty string to not use auto-loading on this object. Null auto-detects based on controller name.
string|null
The name of this command.
string
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Command.I18nExtractCommand.html