Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 5
 CRAP
0.00% covered (danger)
0.00%
0 / 1
tao_helpers_translation_TranslationFileWriter
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 5
 30
0.00% covered (danger)
0.00%
0 / 1
 __construct
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
 2
 write
n/a
0 / 0
n/a
0 / 0
 0
 setTranslationFile
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getFilePath
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 2
 setFilePath
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getTranslationFile
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2008-2010 (original work) Deutsche Institut für Internationale Pädagogische Forschung
19 *                         (under the project TAO-TRANSFER);
20 *               2009-2012 (update and modification) Public Research Centre Henri Tudor
21 *                         (under the project TAO-SUSTAIN & TAO-DEV);
22 *
23 */
24
25/**
26 * A Writing class for TranslationFiles. Must be implemented by a concrete class
27 * a given Translation Format such as XLIFF, PO, ... The write method must be
28 * by subclasses.
29 *
30 * @abstract
31 * @access public
32 * @author Jerome Bogaerts
33 * @package tao
34 * @since 2.2
35
36 * @version 1.0
37 */
38abstract class tao_helpers_translation_TranslationFileWriter
39{
40    // --- ASSOCIATIONS ---
41
42
43    // --- ATTRIBUTES ---
44
45    /**
46     * Short description of attribute filePath
47     *
48     * @access private
49     * @var string
50     */
51    private $filePath = '';
52
53    /**
54     * Short description of attribute translationFile
55     *
56     * @access private
57     * @var TranslationFile
58     */
59    private $translationFile = null;
60
61    // --- OPERATIONS ---
62
63    /**
64     * Creates a new instance of TranslationFileWriter.
65     *
66     * @access public
67     * @author firstname and lastname of author, <author@example.org>
68     * @param  string filePath
69     * @param  TranslationFile translationFile
70     * @return mixed
71     */
72    public function __construct($filePath, tao_helpers_translation_TranslationFile $translationFile)
73    {
74
75        $this->filePath = $filePath;
76        $this->translationFile = $translationFile;
77    }
78
79    /**
80     * Reads a translation file to persist a TranslationFile in a specific
81     * Subclasses must implement this method to meet the requirement of the
82     * they support such as XLIFF or PO files.
83     *
84     * @abstract
85     * @access public
86     * @author firstname and lastname of author, <author@example.org>
87     * @return mixed
88     */
89    abstract public function write();
90
91    /**
92     * Sets the TranslationFile that has to be serialized.
93     *
94     * @access public
95     * @author firstname and lastname of author, <author@example.org>
96     * @param  TranslationFile translationFile
97     * @return mixed
98     */
99    public function setTranslationFile(tao_helpers_translation_TranslationFile $translationFile)
100    {
101
102        $this->translationFile = $translationFile;
103    }
104
105    /**
106     * Gets the location where the file must be written.
107     *
108     * @access public
109     * @author firstname and lastname of author, <author@example.org>
110     * @return string
111     */
112    public function getFilePath()
113    {
114        $returnValue = (string) '';
115
116
117        return $this->filePath;
118
119
120        return (string) $returnValue;
121    }
122
123    /**
124     * Sets the location where the file has to be written.
125     *
126     * @access public
127     * @author firstname and lastname of author, <author@example.org>
128     * @param  string filePath
129     * @return mixed
130     */
131    public function setFilePath($filePath)
132    {
133
134        $this->filePath = $filePath;
135    }
136
137    /**
138     * Short description of method getTranslationFile
139     *
140     * @access protected
141     * @author firstname and lastname of author, <author@example.org>
142     * @return tao_helpers_translation_TranslationFile
143     */
144    protected function getTranslationFile()
145    {
146        $returnValue = null;
147
148
149        $returnValue = $this->translationFile;
150
151
152        return $returnValue;
153    }
154}