NetteGettextExtractor.php

<?php

/**
 * GettextExtractor
 * 
 * Cool tool for automatic extracting gettext strings for translation
 *
 * Works best with Nette Framework
 * 
 * This source file is subject to the New BSD License.
 *
 * @copyright  Copyright (c) 2009 Karel Klima
 * @license    New BSD License
 * @package    Nette Extras
 * @version    GettextExtractor 2.0, 2009-10-21
 */

require dirname(__FILE__) . '/GettextExtractor.php';

/**
 * NetteGettextExtractor tool - designed specially for use with Nette Framework
 *
 * @author     Karel Klima
 * @copyright  Copyright (c) 2009 Karel Klíma
 * @package    Nette Extras
 */ 
class NetteGettextExtractor extends GettextExtractor
{
	/** @var array */
	protected $functionMap = array(
		// standard translation functions
		'translate' 	=> 1,
		'_' 			=> 1,
		// form translations
		'setText'		=> 1,
		'setEmptyValue' => 1,
		'addButton'		=> 2,
		'addCheckbox' 	=> 2,
		'addError'		=> 1,
		'addFile'		=> 2,
		'addGroup'		=> 1,
		'addImage'		=> 3,
		'addMultiSelect' => 2,
		'addPassword' 	=> 2,
		'addRadioList' 	=> 2,
		'addRule'		=> 2,
		'addSelect' 	=> 2,
		'addSubmit'		=> 2,
		'addText'		=> 2,
		'addTextArea' 	=> 2
	);
	
	/**
	 * Setup mandatory filters
	 * @param string|bool $logToFile
	 */
	public function __construct($logToFile = FALSE)
	{
		parent::__construct($logToFile);
		
		// Clean up...
		$this->removeAllFilters();
		
		// Set basic filters
		$this->setFilter('php', 'PHP')
			->setFilter('phtml', 'PHP')
			->setFilter('phtml', 'NetteLatte')
			->setFilter('latte', 'NetteLatte')
			->setFilter('latte', 'PHP');
			
		$php = $this->getFilter('PHP');
		$php->addFunction('translate')
			->addFunction('_');
			
		$this->getFilter('NetteLatte')->addPrefix('!_')->addPrefix('_');
	}
	
	/**
	 * Optional setup of Forms translations
	 * @return NetteGettextExtractor
	 */
	public function setupForms()
	{
		$php = $this->getFilter('PHP');
		$php->addFunction('setText')
			->addFunction('setEmptyValue')
			->addFunction('setValue')
			->addFunction('addButton', 2)
			->addFunction('addCheckbox', 2)
			->addFunction('addError')
			->addFunction('addFile', 2)
			->addFunction('addGroup')
			->addFunction('addImage', 3)
			->addFunction('addmultiSelect', 2)
			->addFunction('addPassword', 2)
			->addFunction('addRadioList', 2)
			->addFunction('addRule', 2)
			->addFunction('addSelect', 2)
			->addFunction('addSubmit', 2)
			->addFunction('addText', 2)
			->addFunction('addTextArea', 2);
			
		return $this;
	}
	
	/**
	 * Optional setup of DataGrid component translations
	 * @return NetteGettextExtractor
	 */
	public function setupDataGrid()
	{
		$php = $this->getFilter('PHP');
		$php->addFunction('addColumn', 2)
			->addFunction('addNumericColumn', 2)
			->addFunction('addDateColumn', 2)
			->addFunction('addCheckboxColumn', 2)
			->addFunction('addImageColumn', 2)
			->addFunction('addPositionColumn', 2)
			->addFunction('addActionColumn')
			->addFunction('addAction');
			
		return $this;
	}
}