nextcloud/lib/public/files.php

118 lines
3.1 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
2012-05-26 21:14:24 +04:00
* @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
*
*/
2012-08-29 10:38:33 +04:00
// 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;
2012-05-19 12:36:57 +04:00
/**
2013-02-11 20:44:02 +04:00
* This class provides access to the internal filesystem abstraction layer. Use
* this class exlusively if you want to access files
2012-05-19 12:36:57 +04:00
*/
class Files {
/**
* Recusive deletion of folders
* @param string path to the folder
2013-01-07 02:54:18 +04:00
* @return bool
*/
static function rmdirr( $dir ) {
2013-01-07 02:54:18 +04:00
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
*/
2012-09-07 17:22:01 +04:00
static function getMimeType( $path ) {
return(\OC_Helper::getMimeType( $path ));
}
/**
* Search for files by mimetype
* @param string mimetype
* @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
*/
2012-09-07 17:22:01 +04:00
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
*/
2012-09-07 17:22:01 +04:00
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
*/
2012-09-07 17:22:01 +04:00
public static function tmpFolder() {
return(\OC_Helper::tmpFolder());
}
/**
* Adds a suffix to the name in case the file exists
* @param string path
* @param string filename
* @return string
*/
2012-09-07 17:22:01 +04:00
public static function buildNotExistingFileName( $path, $filename ) {
return(\OC_Helper::buildNotExistingFileName( $path, $filename ));
}
2012-09-08 18:02:11 +04:00
/**
* Gets the Storage for an app - creates the needed folder if they are not
* existant
2012-09-08 18:02:11 +04:00
* @param string appid
2012-10-10 15:18:36 +04:00
* @return \OC\Files\View
2012-09-08 18:02:11 +04:00
*/
public static function getStorage( $app ) {
return \OC_App::getStorage( $app );
}
}