Constants summary

• int
  CODE_ERROR
  1
• int
  CODE_SUCCESS
  0

Properties summary

• $_countMarkerError protected
  int

  Count number of marker errors found

• $_exclude protected
  string[]

  An array of directories to exclude.

• $_extractCore protected
  bool

  Holds whether this call should extract the CakePHP Lib messages

• $_file protected
  string

  Current file being processed

• $_files protected
  string[]

  Files from where to extract

• $_markerError protected
  bool

  Displays marker error(s) if true

• $_merge protected
  bool

  Merge all domain strings into the default.pot file

• $_modelFactories protected
  (callable|\Cake\Datasource\Locator\LocatorInterface)[]

  A list of overridden model factory functions.

• $_modelType protected
  string

  The model type to use.

• $_output protected
  string

  Destination path

• $_paths protected
  string[]

  Paths to use when looking for strings

• $_relativePaths protected
  bool

  Use relative paths in the pot files rather than full path

• $_storage protected
  array

  Contains all content waiting to be write

• $_tableLocator protected
  \Cake\ORM\Locator\LocatorInterface|null

  Table locator instance

• $_tokens protected
  array

  Extracted tokens

• $_translations protected
  array

  Extracted strings indexed by domain.

• $modelClass protected
  string|null

  This object's primary model class name. Should be a plural form.

• $name protected
  string

  The name of this command.

Method Summary

• __construct() public

  Constructor

• _addTranslation() protected

  Add a translation to the internal translations property

• _buildFiles() protected

  Build the translate template file contents out of obtained strings

• _extract() protected

  Extract text

• _extractTokens() protected

  Extract tokens out of all files to be processed

• _formatString() protected

  Format a string to be added as a translatable string

• _getPaths() protected

  Method to interact with the user and get path selections.

• _getStrings() protected

  Get the strings from the position forward

• _isExtractingApp() protected

  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.

• _isPathUsable() protected

  Checks whether or not a given path is usable for writing.

• _markerError() protected

  Indicate an invalid marker on a processed file

• _parse() protected

  Parse tokens

• _searchFiles() protected

  Search files that may contain translatable strings

• _setModelClass() protected

  Set the modelClass property based on conventions.

• _store() protected

  Prepare a file to be stored

• _writeFiles() protected

  Write the files that need to be stored

• _writeHeader() protected

  Build the translation template header

• abort() public

  Halt the the current process with a StopException.

• buildOptionParser() public

  Gets the option parser instance and configures it.

• checkUnchanged() protected

  Check whether the old and new output are the same, thus unchanged

• defaultName() public static

  Get the command name.

• displayHelp() protected

  Output help content

• execute() public

  Execute the command

• executeCommand() public

  Execute another command with the provided set of arguments.

• getModelType() public

  Get the model type to be used by this class

• getName() public

  Get the command name.

• getOptionParser() public

  Get the option parser.

• getRootName() public

  Get the root command name.

• getTableLocator() public

  Gets the table locator.

• initialize() public

  Hook method invoked by CakePHP when a command is about to be executed.

• loadModel() public

  Loads and constructs repository objects required by this object

• log() public

  Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

• modelFactory() public

  Override a existing callable to generate repositories of a given type.

• run() public

  Run the command.

• setModelType() public

  Set the model type to be used by this class

• setName() public

  Set the name this command uses in the collection.

• setOutputLevel() protected

  Set the output level based on the Arguments.

• setTableLocator() public

  Sets the table locator.

Method Detail

__construct()

_addTranslation(string $domain, string $msgid, array $details)

_buildFiles(\Cake\Console\Arguments $args)

_extract(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

_extractTokens(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

_formatString(string $string)

_getPaths(\Cake\Console\ConsoleIo $io)

_getStrings(int $position, int $target)

_isExtractingApp()

_isPathUsable(mixed $path)

_markerError(mixed $io, string $file, int $line, string $marker, int $count)

_parse(\Cake\Console\ConsoleIo $io, string $functionName, array $map)

_searchFiles()

_setModelClass(string $name)

_store(string $domain, string $header, string $sentence)

_writeFiles(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

_writeHeader(string $domain)

abort(int $code)

buildOptionParser(\Cake\Console\ConsoleOptionParser $parser)

checkUnchanged(string $oldFile, int $headerLength, string $newFileContent)

defaultName()

displayHelp(\Cake\Console\ConsoleOptionParser $parser, \Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

execute(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

executeCommand(mixed $command, array $args, ?\Cake\Console\ConsoleIo $io)

getModelType()

getName()

getOptionParser()

getRootName()

getTableLocator()

initialize()

loadModel(?string $modelClass, ?string $modelType)

log(string $message, mixed $level, mixed $context)

modelFactory(string $type, mixed $factory)

run(array $argv, \Cake\Console\ConsoleIo $io)

setModelType(string $modelType)

setName(string $name)

setOutputLevel(\Cake\Console\Arguments $args, \Cake\Console\ConsoleIo $io)

setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)

Property Detail