Blame view

sources/lib/public/files.php 3.01 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
  <?php
  /**
  * ownCloud
  *
  * @author Frank Karlitschek
  * @copyright 2012 Frank Karlitschek frank@owncloud.org
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
  * License as published by the Free Software Foundation; either
  * version 3 of the License, or any later version.
  *
  * This library 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 AFFERO GENERAL PUBLIC LICENSE for more details.
  *
  * You should have received a copy of the GNU Affero General Public
  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
  *
  */
  
  /**
   * Public interface of ownCloud for apps to use.
   * Files Class
   *
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP;
  
  /**
   * This class provides access to the internal filesystem abstraction layer. Use
   * this class exlusively if you want to access files
   */
  class Files {
  	/**
  	 * @brief Recusive deletion of folders
  	 * @param string $dir path to the folder
  	 *
  	 * @return bool
  	 */
  	static function rmdirr( $dir ) {
  		return \OC_Helper::rmdirr( $dir );
  	}
  
  	/**
  	 * get the mimetype form a local file
  	 * @param string path
  	 * @return string
  	 * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
  	 */
  	static function getMimeType( $path ) {
  		return(\OC_Helper::getMimeType( $path ));
  	}
  
  	/**
  	 * search for files by mimetype
  	 *
  	 * @param string $query
  	 * @return array
  	 */
  	static public function searchByMime($mimetype) {
  		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
  	}
  
  	/**
  	 * copy the contents of one stream to another
  	 * @param resource source
  	 * @param resource target
  	 * @return int the number of bytes copied
  	 */
  	public static function streamCopy( $source, $target ) {
  		list($count, $result) = \OC_Helper::streamCopy( $source, $target );
  		return $count;
  	}
  
  	/**
  	 * create a temporary file with an unique filename
  	 * @param string postfix
  	 * @return string
  	 *
  	 * temporary files are automatically cleaned up after the script is finished
  	 */
  	public static function tmpFile( $postfix='' ) {
  		return(\OC_Helper::tmpFile( $postfix ));
  	}
  
  	/**
  	 * create a temporary folder with an unique filename
  	 * @return string
  	 *
  	 * temporary files are automatically cleaned up after the script is finished
  	 */
  	public static function tmpFolder() {
  		return(\OC_Helper::tmpFolder());
  	}
  
  	/**
  	 * Adds a suffix to the name in case the file exists
  	 *
  	 * @param $path
  	 * @param $filename
  	 * @return string
  	 */
  	public static function buildNotExistingFileName( $path, $filename ) {
  		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
  	}
  
  	/**
  	 * @param string appid
  	 * @param $app app
  	 * @return \OC\Files\View
  	 */
  	public static function getStorage( $app ) {
  		return \OC_App::getStorage( $app );
  	}
  }