• Home
• Cake
• Shell
• Task
• ExtractTask

PHP Class Cake\Shell\Task\ExtractTask

Show file Open project: cakephp/cakephp Class Usage Examples

Protected Properties

Property	Type	Description
$_exclude	array	An array of directories to exclude.
$_extractCore	boolean	Holds whether this call should extract the CakePHP Lib messages
$_file	string	Current file being processed
$_files	array	Files from where to extract
$_merge	boolean	Merge all domain strings into the default.pot file
$_output	string	Destination path
$_paths	array	Paths to use when looking for strings
$_storage	array	Contains all content waiting to be write
$_tokens	array	Extracted tokens
$_translations	array	Extracted strings indexed by domain.
$_validationDomain	boolean	Holds the validation string domain to use for validation messages when extracting

Public Methods

Method	Description
getOptionParser ( ) : Cake\Console\ConsoleOptionParser	Gets the option parser instance and configures it.
main ( ) : void	Execution method always used for tasks

Protected Methods

Method	Description
_addTranslation ( string $domain, string $msgid, array $details = [] ) : void	Add a translation to the internal translations property
_buildFiles ( ) : void	Build the translate template file contents out of obtained strings
_extract ( ) : void	Extract text
_extractTokens ( ) : void	Extract tokens out of all files to be processed
_formatString ( string $string ) : string	Format a string to be added as a translatable string
_getPaths ( ) : void	Method to interact with the User and get path selections.
_getStrings ( integer &$position, integer $target ) : array	Get the strings from the position forward
_isExtractingApp ( ) : boolean	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 ( string $path ) : boolean	Checks whether or not a given path is usable for writing.
_markerError ( string $file, integer $line, string $marker, integer $count ) : void	Indicate an invalid marker on a processed file
_parse ( string $functionName, array $map ) : void	Parse tokens
_searchFiles ( ) : void	Search files that may contain translatable strings
_store ( string $domain, string $header, string $sentence ) : void	Prepare a file to be stored
_welcome ( ) : void	No welcome message.
_writeFiles ( ) : void	Write the files that need to be stored
_writeHeader ( ) : string	Build the translation template header

Method Details

Property Details