Class ExtractTask

Language string extractor

Object

Shell

ExtractTask

Package: cake\cake\console\libs
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: tasks/extract.php

Properties summary

$__file public

string

Current file being processed
$__fileVersions public

array

History of file versions
$__filename public

string

Filename where to deposit translations
$__oneFile public

boolean

True if all strings should be merged into one file
$__output public

string

Destination path
$__strings public

array

Extracted strings
$__tokens public

array

Extracted tokens
$files public

array

Files from where to extract
$path public

string

Path to use when looking for strings

Inherited Properties

DbConfig, Dispatch, alias, args, className, command, interactive, name, params, shell, taskNames, tasks, uses _log

Method Summary

__buildFiles() public

Build the translate template file contents out of obtained strings
__extract() public

Extract text
__extractTokens() public

Extract tokens out of all files to be processed
__findVersion() public

Find the version number of a file looking for SVN commands
__formatString() public

Format a string to be added as a translateable string
__markerError() public

Indicate an invalid marker on a processed file
__mergeFiles() public

Merge output files
__searchDirectory() public

Search the specified path for files that may contain translateable strings
__store() public

Prepare a file to be stored
__writeFiles() public

Write the files that need to be stored
__writeHeader() public

Build the translation template header
basic() public

Will parse __(), __c() functions
execute() public

Execution method always used for tasks
extended() public

Will parse __d(), __dc(), __n(), __dn(), __dcn()
help() public

Show help options

Method Detail

__buildFiles() public ¶

__buildFiles( )

Build the translate template file contents out of obtained strings

__extractTokens() public ¶

__extractTokens( )

Extract tokens out of all files to be processed

__findVersion() public ¶

__findVersion( string $code , string $file )

Find the version number of a file looking for SVN commands

Parameters

string $code: Source code of file
string $file: File

__formatString() public ¶

__formatString( string $string )

Format a string to be added as a translateable string

Parameters

string $string: String to format

Returns

string
Formatted string

__markerError() public ¶

__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

__mergeFiles() public ¶

__mergeFiles( array $output )

Merge output files

Parameters

array $output: Output to merge

Returns

array
Merged output

__searchDirectory() public ¶

__searchDirectory( string $path = null )

Search the specified path for files that may contain translateable strings

Parameters

string $path optional null: Path (or set to null to use current)

Returns

array
Files

__store() public ¶

__store( string $file = 0 , string $input = 0 , array $fileList = array() , integer $get = 0 )

Prepare a file to be stored

Parameters

string $file optional 0: Filename
string $input optional 0: What to store
array $fileList optional array(): File list
integer $get optional 0: Set to 1 to get files to store, false to set

Returns

mixed
If $get == 1, files to store, otherwise void

__writeFiles() public ¶

__writeFiles( )

Write the files that need to be stored

__writeHeader() public ¶

__writeHeader( )

Build the translation template header

Returns

string
Translation template header

basic() public ¶

basic( string $functionName = '__' )

Will parse __(), __c() functions

Parameters

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

execute() public ¶

execute( )

Execution method always used for tasks

extended() public ¶

extended( string $functionName = '__d' , integer $shift = 0 , boolean $plural = false )

Will parse __d(), __dc(), __n(), __dn(), __dcn()

Parameters

string $functionName optional '__d': Function name that indicates translatable string (e.g: '__')
integer $shift optional 0: Number of parameters to shift to find translateable string
boolean $plural optional false: Set to true if function supports plural format, false otherwise

Methods inherited from Shell

__construct() public ¶

__construct( $dispatch )

Constructs this Shell instance.

Overrides

Object::__construct()

_checkArgs() public ¶

_checkArgs( integer $expectedNum , string $command = null )

Will check the number args matches otherwise throw an error

Parameters

integer $expectedNum: Expected number of paramters
string $command optional null: Command

_checkUnitTest() public ¶

_checkUnitTest( )

Action to create a Unit Test

Returns

boolean
Success

_controllerName() public ¶

_controllerName( string $name )

Creates the proper controller plural name for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Controller plural name

_controllerPath() public ¶

_controllerPath( string $name )

Creates the proper controller path for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Path to controller

_loadDbConfig() public ¶

_loadDbConfig( )

Loads database file and constructs DATABASE_CONFIG class makes $this->DbConfig available to subclasses

Returns

boolean

_loadModels() public ¶

_loadModels( )

if var $uses = true Loads AppModel file and constructs AppModel class makes $this->AppModel available to subclasses if var $uses is an array of models will load those models

Returns

boolean

_modelKey() public ¶

_modelKey( string $name )

Creates the proper singular model key for associations

Parameters

string $name: Controller class name

Returns

string
Singular model key

_modelName() public ¶

_modelName( string $name )

Creates the proper controller camelized name (singularized) for the specified name

Parameters

string $name: Name

Returns

string
Camelized and singularized controller name

_modelNameFromKey() public ¶

_modelNameFromKey( string $key )

Creates the proper model name from a foreign key

Parameters

string $key: Foreign key

Returns

string
Model name

_pluralHumanName() public ¶

_pluralHumanName( string $name )

Creates the plural human name used in views

Parameters

string $name: Controller name

Returns

string
Plural human name

_pluralName() public ¶

_pluralName( string $name )

Creates the plural name for views

Parameters

string $name: Name to use

Returns

string
Plural name for views

_singularHumanName() public ¶

_singularHumanName( string $name )

Creates the singular human name used in views

Parameters

string $name: Controller name

Returns

string
Singular human name

_singularName() public ¶

_singularName( string $name )

creates the singular name for use in views.

Parameters

string $name

Returns

string
$name

_welcome() public ¶

_welcome( )

Displays a header for the shell

createFile() public ¶

createFile( string $path , string $contents )

Creates a file at given path

Parameters

string $path: Where to put the file.
string $contents: Content to put in the file.

Returns

boolean
Success

err() public ¶

err( string $string )

Outputs to the stderr filehandle.

Parameters

string $string: Error text to output.

error() public ¶

error( string $title , string $msg )

Displays a formatted error message and exits the application

Parameters

string $title: Title of the error message
string $msg: Error message

getAdmin() public ¶

getAdmin( )

Checks for Configure::read('Routing.admin') and forces user to input it if not enabled

Returns

string
Admin route to use

hr() public ¶

hr( boolean $newline = false )

Outputs a series of minus characters to the standard output, acts as a visual separator.

Parameters

boolean $newline optional false: If true, the outputs gets an added newline.

in() public ¶

in( string $prompt , mixed $options = null , string $default = null )

Prompts the user for input, and returns it.

Parameters

string $prompt: Prompt text.
mixed $options optional null: Array or string of options.
string $default optional null: Default input value.

Returns

Either
the default value, or the user-provided input.

initialize() public ¶

initialize( )

Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution

loadTasks() public ¶

loadTasks( )

Loads tasks defined in var $tasks

Returns

boolean

out() public ¶

out( string $string , boolean $newline = true )

Outputs to the stdout filehandle.

Parameters

string $string: String to output.
boolean $newline optional true: If true, the outputs gets an added newline.

shortPath() public ¶

shortPath( string $file )

Makes absolute file path easier to read

Parameters

string $file: Absolute file path

Returns

sting
short path

startup() public ¶

startup( )

Starts up the the Shell allows for checking and configuring prior to command or main execution can be overriden in subclasses

Methods inherited from Object

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

API for logging events.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$__file` ¶

public string

Current file being processed

null

`$__fileVersions` ¶

public array

History of file versions

array()

`$__filename` ¶

public string

Filename where to deposit translations

'default'

`$__oneFile` ¶

public boolean

True if all strings should be merged into one file

true

`$__output` ¶

public string

Destination path

null

`$__strings` ¶

public array

Extracted strings

array()

`$__tokens` ¶

public array

Extracted tokens

array()

`$files` ¶

public array

Files from where to extract

array()

`$path` ¶

public string

Path to use when looking for strings

null

Classes

Functions

Class ExtractTask

Properties summary

Inherited Properties

Method Summary

__buildFiles() public

__extract() public

__extractTokens() public

__findVersion() public

__formatString() public

__markerError() public

__mergeFiles() public

__searchDirectory() public

__store() public

__writeFiles() public

__writeHeader() public

basic() public

execute() public

extended() public

help() public

Method Detail

__buildFiles() public ¶

__extract() public ¶

__extractTokens() public ¶

__findVersion() public ¶

Parameters

__formatString() public ¶

Parameters

Returns

__markerError() public ¶

Parameters

__mergeFiles() public ¶

Parameters

Returns

__searchDirectory() public ¶

Parameters

Returns

__store() public ¶

Parameters

Returns

__writeFiles() public ¶

__writeHeader() public ¶

Returns

basic() public ¶

Parameters

execute() public ¶

extended() public ¶

Parameters

help() public ¶

Overrides

Methods inherited from Shell

__construct() public ¶

Overrides

_checkArgs() public ¶

Parameters

_checkUnitTest() public ¶

Returns

_controllerName() public ¶

Parameters

Returns

_controllerPath() public ¶

Parameters

Returns

_loadDbConfig() public ¶

Returns

_loadModels() public ¶

Returns

_modelKey() public ¶

Parameters

Returns

_modelName() public ¶

Parameters

Returns

_modelNameFromKey() public ¶

Parameters

Returns

_pluralHumanName() public ¶

Parameters

Returns

`$__file` ¶

`$__fileVersions` ¶

`$__filename` ¶

`$__oneFile` ¶