Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 5 |
|
0.00% |
0 / 3 |
CRAP | |
0.00% |
0 / 1 |
| WriterAwareTrait | |
0.00% |
0 / 5 |
|
0.00% |
0 / 3 |
30 | |
0.00% |
0 / 1 |
| setOutputWriter | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| write | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
6 | |||
| writeLine | |
0.00% |
0 / 2 |
|
0.00% |
0 / 1 |
6 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Trait for shared output functionality. |
| 5 | * |
| 6 | * PHP version 7 |
| 7 | * |
| 8 | * Copyright (c) Demian Katz 2016. |
| 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of the GNU General Public License version 2, |
| 12 | * as published by the Free Software Foundation. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License |
| 20 | * along with this program; if not, write to the Free Software |
| 21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
| 22 | * |
| 23 | * @category VuFind |
| 24 | * @package Harvest_Tools |
| 25 | * @author Demian Katz <demian.katz@villanova.edu> |
| 26 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 27 | * @link https://vufind.org/wiki/indexing:oai-pmh Wiki |
| 28 | */ |
| 29 | |
| 30 | namespace VuFindHarvest\ConsoleOutput; |
| 31 | |
| 32 | /** |
| 33 | * Trait for shared output functionality. |
| 34 | * |
| 35 | * @category VuFind |
| 36 | * @package Harvest_Tools |
| 37 | * @author Demian Katz <demian.katz@villanova.edu> |
| 38 | * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License |
| 39 | * @link https://vufind.org/wiki/indexing:oai-pmh Wiki |
| 40 | */ |
| 41 | trait WriterAwareTrait |
| 42 | { |
| 43 | /** |
| 44 | * Writer helper |
| 45 | * |
| 46 | * @var WriterInterface |
| 47 | */ |
| 48 | protected $outputWriter = null; |
| 49 | |
| 50 | /** |
| 51 | * Set an object to accept console output messages. |
| 52 | * |
| 53 | * @param WriterInterface $writer Writer object |
| 54 | * |
| 55 | * @return void |
| 56 | */ |
| 57 | public function setOutputWriter(WriterInterface $writer) |
| 58 | { |
| 59 | $this->outputWriter = $writer; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Write a string to the console output writer (if set). |
| 64 | * |
| 65 | * @param string $str String to write. |
| 66 | * |
| 67 | * @return void |
| 68 | */ |
| 69 | protected function write($str) |
| 70 | { |
| 71 | // Bypass output when silent: |
| 72 | if ($this->outputWriter) { |
| 73 | $this->outputWriter->write($str); |
| 74 | } |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Write a string w/newline to the console output writer (if set). |
| 79 | * |
| 80 | * @param string $str String to write. |
| 81 | * |
| 82 | * @return void |
| 83 | */ |
| 84 | protected function writeLine($str) |
| 85 | { |
| 86 | // Bypass output when silent: |
| 87 | if ($this->outputWriter) { |
| 88 | $this->outputWriter->writeLine($str); |
| 89 | } |
| 90 | } |
| 91 | } |