summaryrefslogtreecommitdiffstats
path: root/lib/public/files/node/folder.php
blob: 7b3ae80f0d757ad89a1365a21d9e570866539154 (plain)
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
<?php
/**
 * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */

namespace OCP\Files\Node;

use OC\Files\Cache\Cache;
use OC\Files\Cache\Scanner;
use OC\Files\NotFoundException;
use OC\Files\NotPermittedException;

interface Folder extends Node {
	/**
	 * @param string $path path relative to the folder
	 * @return string
	 * @throws \OC\Files\NotPermittedException
	 */
	public function getFullPath($path);

	/**
	 * @param string $path
	 * @throws \OC\Files\NotFoundException
	 * @return string
	 */
	public function getRelativePath($path);

	/**
	 * check if a node is a (grand-)child of the folder
	 *
	 * @param \OC\Files\Node\Node $node
	 * @return bool
	 */
	public function isSubNode($node);

	/**
	 * get the content of this directory
	 *
	 * @throws \OC\Files\NotFoundException
	 * @return Node[]
	 */
	public function getDirectoryListing();

	/**
	 * Get the node at $path
	 *
	 * @param string $path
	 * @return \OC\Files\Node\Node
	 * @throws \OC\Files\NotFoundException
	 */
	public function get($path);

	/**
	 * @param string $path
	 * @return bool
	 */
	public function nodeExists($path);

	/**
	 * @param string $path
	 * @return Folder
	 * @throws NotPermittedException
	 */
	public function newFolder($path);

	/**
	 * @param string $path
	 * @return File
	 * @throws NotPermittedException
	 */
	public function newFile($path);

	/**
	 * search for files with the name matching $query
	 *
	 * @param string $query
	 * @return Node[]
	 */
	public function search($query);

	/**
	 * search for files by mimetype
	 *
	 * @param string $mimetype
	 * @return Node[]
	 */
	public function searchByMime($mimetype);

	/**
	 * @param $id
	 * @return Node[]
	 */
	public function getById($id);

	public function getFreeSpace();

	/**
	 * @return bool
	 */
	public function isCreatable();
}