Class ExtractTask

_addTranslation()source protected

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

Add a translation to the internal translations property

Takes care of duplicate translations

Parameters

string $category

The category

string $domain

The domain

string $msgid

The message string

array $details optional array()

The file and line references

_buildFiles()source protected

_buildFiles( )

Build the translate template file contents out of obtained strings

_extract()source protected

_extract( )

Extract text

_extractPluginValidationMessages()source protected

_extractPluginValidationMessages( string $plugin null )

Extract validation messages from application or plugin models

Parameters

string $plugin optional null

Plugin name or null to process application models

_extractTokens()source protected

_extractTokens( )

Extract tokens out of all files to be processed

_extractValidationMessages()source protected

_extractValidationMessages( )

Looks for models in the application and extracts the validation messages to be added to the translation map

_formatString()source protected

_formatString( string $string )

Format a string to be added as a translatable string

Parameters

string $string

String to format

Returns

_getPaths()source protected

_getPaths( )

Method to interact with the User and get path selections.

_getStrings()source protected

_getStrings( integer $position , integer $target )

Get the strings from the position forward

Parameters

integer $position

$position Actual position on tokens array

integer $target

Number of strings to extract

Returns

_isExtractingApp()source protected

_isExtractingApp( )

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.

Returns

_isPathUsable()source protected

_isPathUsable( string $path )

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

Parameters

string $path

Path to folder

Returns

_markerError()source protected

_markerError( string $file , integer $line , string $marker , integer $count )

Indicate an invalid marker on a processed file

Parameters

string $file

File where invalid marker resides

integer $line

Line number

string $marker

Marker found

integer $count

Count

_parse()source protected

_parse( string $functionName , array $map )

Parse tokens

Parameters

string $functionName

Function name that indicates translatable string (e.g: '__')

array $map

Array containing what variables it will find (e.g: category, domain, singular, plural)

_processValidationRules()source protected

_processValidationRules( string $field , array $rules , string $file , string $domain , string $category 'LC_MESSAGES' )

Process a validation rule for a field and looks for a message to be added to the translation map

Parameters

string $field

the name of the field that is being processed

array $rules

the set of validation rules for the field

string $file

the file name where this validation rule was found

string $domain

default domain to bind the validations to

string $category optional 'LC_MESSAGES'

the translation category

_searchFiles()source protected

_searchFiles( )

Search files that may contain translatable strings

_store()source protected

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

Prepare a file to be stored

Parameters

string $category

The category

string $domain

The domain

string $header

The header content.

string $sentence

The sentence to store.

_writeFiles()source protected

_writeFiles( )

Write the files that need to be stored

_writeHeader()source protected

_writeHeader( )

Build the translation template header

Returns

execute()source public

execute( )

Execution method always used for tasks

getOptionParser()source public

getOptionParser( )

Gets the option parser instance and configures it.

Returns