Blame view

sources/lib/public/files.php 3.08 KB
03e52840d   Kload   Init
1
2
  <?php
  /**
31b7f2792   Kload   Upgrade to ownclo...
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
   * 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/>.
   *
   */
03e52840d   Kload   Init
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  
  /**
   * 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 {
  	/**
31b7f2792   Kload   Upgrade to ownclo...
39
40
  	 * Recusive deletion of folders
  	 * @param string path to the folder
03e52840d   Kload   Init
41
42
43
44
45
46
47
  	 * @return bool
  	 */
  	static function rmdirr( $dir ) {
  		return \OC_Helper::rmdirr( $dir );
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
48
  	 * Get the mimetype form a local file
03e52840d   Kload   Init
49
50
51
52
53
54
55
56
57
  	 * @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 ));
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
58
59
  	 * Search for files by mimetype
  	 * @param string mimetype
03e52840d   Kload   Init
60
61
  	 * @return array
  	 */
31b7f2792   Kload   Upgrade to ownclo...
62
  	static public function searchByMime( $mimetype ) {
03e52840d   Kload   Init
63
64
65
66
  		return(\OC\Files\Filesystem::searchByMime( $mimetype ));
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
67
  	 * Copy the contents of one stream to another
03e52840d   Kload   Init
68
69
70
71
72
73
74
75
76
77
  	 * @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;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
78
  	 * Create a temporary file with an unique filename
03e52840d   Kload   Init
79
80
81
82
83
84
85
86
87
88
  	 * @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 ));
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
89
  	 * Create a temporary folder with an unique filename
03e52840d   Kload   Init
90
91
92
93
94
95
96
97
98
99
  	 * @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
31b7f2792   Kload   Upgrade to ownclo...
100
101
  	 * @param string path
  	 * @param string filename
03e52840d   Kload   Init
102
103
104
105
106
107
108
  	 * @return string
  	 */
  	public static function buildNotExistingFileName( $path, $filename ) {
  		return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
109
110
  	 * Gets the Storage for an app - creates the needed folder if they are not
  	 * existant
03e52840d   Kload   Init
111
  	 * @param string appid
03e52840d   Kload   Init
112
113
114
115
116
117
  	 * @return \OC\Files\View
  	 */
  	public static function getStorage( $app ) {
  		return \OC_App::getStorage( $app );
  	}
  }