<?php /** * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; under version 2 * of the License (non-upgradable). * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * Copyright (c) 2008-2010 (original work) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER); * 2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV); * */ /** * A TranslationExtractor instance extracts TranslationUnits from a given source * as an Item, source code, ... * * @abstract * @access public * @author Jerome Bogaerts * @package tao * @since 2.2 * @version 1.0 */ abstract class tao_helpers_translation_TranslationExtractor { // --- ASSOCIATIONS --- // --- ATTRIBUTES --- /** * Short description of attribute paths * * @access private * @var array */ private $paths = []; /** * Short description of attribute translationUnits * * @access private * @var array */ private $translationUnits = []; // --- OPERATIONS --- /** * Creates a new Instance of TranslationExtractor. * * @access public * @author firstname and lastname of author, <author@example.org> * @param array paths * @return mixed */ public function __construct($paths) { $this->setPaths($paths); } /** * Any subclass of TranslationExtractor must implement this method aiming at * TranslationUnits from a given source and set the translationUnit member * the class. * * @abstract * @access public * @author firstname and lastname of author, <author@example.org> * @return mixed */ abstract public function extract(); /** * Sets an array of paths where the translations have to be extracted. * * @access public * @author firstname and lastname of author, <author@example.org> * @param array paths * @return mixed */ public function setPaths($paths) { $this->paths = $paths; } /** * Gets an array of paths where the translations have to be extracted * * @access public * @author firstname and lastname of author, <author@example.org> * @return array */ public function getPaths() { $returnValue = []; $returnValue = $this->paths; return (array) $returnValue; } /** * Gets an array of TranslationUnit instances that were generated during the * of the TranslationExtractor::extract method. * * @access public * @author firstname and lastname of author, <author@example.org> * @return array */ public function getTranslationUnits() { $returnValue = []; $returnValue = $this->translationUnits; return (array) $returnValue; } /** * Sets an array of TranslationUnit instances that will be generated during * invokation of the TranslationExtractor::extract method. * * @access protected * @author firstname and lastname of author, <author@example.org> * @param array translationUnits * @return mixed */ protected function setTranslationUnits($translationUnits) { $this->translationUnits = $translationUnits; } } /* end of abstract class tao_helpers_translation_TranslationExtractor */