[-FEATURE] Remove xml export in fullsearch, deprecate t3lib_xml
[Packages/TYPO3.CMS.git] / t3lib / interfaces / file / Service / Publishing / Publisher.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2012 Andreas Wolf <andreas.wolf@ikt-werk.de>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Interface for FAL Publisher
30 *
31 * @author Andreas Wolf <andreas.wolf@ikt-werk.de>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 interface t3lib_file_Service_Publishing_Publisher {
36 public function __construct(t3lib_file_Storage $publishingTarget, array $configuration);
37
38 /**
39 * Publishes a file to this publisher's public space
40 *
41 * @param t3lib_file_FileInterface $fileObject
42 * @return string The URI of the published file
43 */
44 public function publishFile(t3lib_file_FileInterface $fileObject);
45
46 /**
47 * Publishes a collection of files, if necessary also recursively.
48 *
49 * @param t3lib_file_Folder $folder
50 * @return void
51 */
52 public function publishFolder(t3lib_file_Folder $folder);
53
54 /**
55 * Returns TRUE if a file has been published.
56 *
57 * @param t3lib_file_FileInterface $fileObject
58 * @return boolean
59 */
60 public function isPublished(t3lib_file_FileInterface $fileObject);
61
62 /**
63 * Returns the public URL of a given file. Will throw an exception if the file is not public.
64 *
65 * @param t3lib_file_FileInterface $fileObject
66 * @return string
67 */
68 public function getPublicUrl(t3lib_file_FileInterface $fileObject);
69 }
70
71 ?>