API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\Admin\Script\TranslationTranslateScript

Find all strings to be translated in mustache or php files

Summary

Methods
Properties
Constants
setDependencies()
defaultArguments()
run()
globRecursive()
base()
getPath()
path()
getFileType()
fileType()
file()
fromCSV()
toCSV()
translateCSV()
origLanguage()
oppositeLanguages()
locales()
columns()
enclosure()
separator()
maxRecursiveLevel()
No public properties found
No constants found
setModelFactory()
modelFactory()
propertyToInput()
$fileType
$output
$path
$locales
N/A
booleanInput()
passwordInput()
$modelFactory
N/A

Properties

$fileType

$fileType : string

Type

string

$output

$output : string

Type

string

$path

$path : string

Type

string

$locales

$locales : array

Type

array

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Type

\Charcoal\Factory\FactoryInterface

Methods

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

\Pimple\Container $container

Pimple DI container.

defaultArguments()

defaultArguments() : array

Valid arguments: - path : path/to/files - type : mustache | php

Returns

array

run()

run(\Psr\Http\Message\RequestInterface  $request, \Psr\Http\Message\ResponseInterface  $response) : \Psr\Http\Message\ResponseInterface

Parameters

\Psr\Http\Message\RequestInterface $request

A PSR-7 compatible Request instance.
\Psr\Http\Message\ResponseInterface $response

A PSR-7 compatible Response instance.

Returns

\Psr\Http\Message\ResponseInterface

globRecursive()

globRecursive(string  $pattern, integer  $flags) : array

Parameters

string $pattern

The pattern to search.
integer $flags

The glob flags.

Returns

array

base()

base() : string

BASE URL Realpath

Returns

string

path()

path() : string

Returns

string

fileType()

fileType() : string

Returns

string

file()

file() : string

Returns

string

fromCSV()

fromCSV() : array

Returns associative array 'original text' => [ 'translation' => 'translation text', 'context' => 'filename' ]

Returns

array

translateCSV()

translateCSV(array  $data) : array

Parameters

array $data

The translation data.

Returns

array

origLanguage()

origLanguage() : string

Returns

string —

lang ident

oppositeLanguages()

oppositeLanguages() : \Charcoal\Admin\Script\Translation\[type]

Get opposite languages from DATABASE

Returns

\Charcoal\Admin\Script\Translation\[type] —

[description]

locales()

locales() : array

Locales set in config.json Expects languages | file | default_language

Returns

array

columns()

columns() : array

Columns of CSV file This is already built to take multiple languages

Returns

array

enclosure()

enclosure() : string

Returns

string

separator()

separator() : string

Returns

string

maxRecursiveLevel()

maxRecursiveLevel() : integer

Returns

integer

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\AdminScript

Parameters

\Charcoal\Factory\FactoryInterface $factory

The factory used to create models.

Returns

\Charcoal\Admin\AdminScript —

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

\Charcoal\Factory\FactoryInterface —

The model factory.

propertyToInput()

propertyToInput(\Charcoal\Property\PropertyInterface  $prop) : mixed

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

mixed

booleanInput()

booleanInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI input from a boolean property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input

passwordInput()

passwordInput(\Charcoal\Property\PropertyInterface  $prop) : \League\CLImate\TerminalObject\Dynamic\Input

Get a CLI password input (hidden) from a password property.

Parameters

\Charcoal\Property\PropertyInterface $prop

The property to retrieve input from.

Returns

\League\CLImate\TerminalObject\Dynamic\Input