Class lajax\projectscanner\scanners\JsScanner

All Classes | Properties | Methods

Inheritance	lajax\projectscanner\scanners\JsScanner » lajax\projectscanner\scanners\FileScannerAbstract » yii\base\Object
Implements	lajax\projectscanner\scanners\ScannerInterface
Available since version	1.0

Class for processing JavaScript files.

Language elements detected in JavaScript files: "lajax.t" functions

lajax.t('language element');
lajax.t('language element {replace}', {replace:'String'});
lajax.t('language element');
lajax.t('language element {replace}', {replace:'String'});

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$category	string	Default JavaScript category.	lajax\projectscanner\scanners\JsScanner
$extension	string	Extension of JavaScript files.	lajax\projectscanner\scanners\JsScanner
$scanner	lajax\projectscanner\Scanner	Object containing the detected language elements	lajax\projectscanner\scanners\FileScannerAbstract
$translators	array	List of the JavaScript function for translating messages.	lajax\projectscanner\scanners\JsScanner

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$files	array	Array to store paths to project files.	lajax\projectscanner\scanners\FileScannerAbstract

Public Methods

Hide inherited methods

Method	Description	Defined By
execute()	Start scanning JavaScript files.	lajax\projectscanner\scanners\JsScanner
scanProject()	Scanning project filesistem.	lajax\projectscanner\scanners\FileScannerAbstract

Protected Methods

Hide inherited methods

Method	Description	Defined By
checkTokens()		lajax\projectscanner\scanners\FileScannerAbstract
containsTranslator()	Determines whether the file has any of the translators.	lajax\projectscanner\scanners\FileScannerAbstract
extractMessages()	Extracts messages from a file	lajax\projectscanner\scanners\FileScannerAbstract
getLanguageItem()	Returns language elements in the token buffer.	lajax\projectscanner\scanners\JsScanner
isValidCategory()	Determines whether the category received as a parameter can be processed.	lajax\projectscanner\scanners\FileScannerAbstract
tokensEqual()	Finds out if two PHP tokens are equal	lajax\projectscanner\scanners\FileScannerAbstract

Property Details

$category public property

Default JavaScript category.

public string $category = 'javascript'

$extension public property

Extension of JavaScript files.

public string $extension = '*.js'

$translators public property

List of the JavaScript function for translating messages.

public array $translators = ['lajax.t']

Method Details

execute() public method

Start scanning JavaScript files.

public void execute ( )

getLanguageItem() protected method

Returns language elements in the token buffer.

If there is no recognisable language element in the array, returns null.

protected array\|null getLanguageItem ( $buffer )
$buffer	array