e0f55e4f50b0b3d5db5c6d2ee8a9c776e5f73f72
[mailer.git] / inc / classes / interfaces / io / file / class_FileOutputStreamer.php
1 <?php
2 /**
3  * An interface for file output operations.
4  *
5  * @author              Roland Haeder <webmaster@mxchange.org>
6  * @version             0.3.0
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.mxchange.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface FileOutputStreamer extends Streamable {
25         /**
26          * Saves streamed (that are mostly serialized objects) data to files or
27          * external servers.
28          *
29          * @param               $fileName               The local file's name including full path
30          * @param               $dataArray      Array containing the compressor's extension
31          *                                              and streamed data
32          * @return      void
33          * @throws      NullPointerException    If an instance is null
34          * @throws      NoObjectException               If the instance is not an object
35          *                                                              instance
36          * @throws      MissingMethodException  If a required method is missing.
37          */
38         function saveFile ($fileName, $dataArray);
39 }
40
41 //
42 ?>