blob: 3311842a9f376b2b3f8afd1f8b6d8fee98a2567e (
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
105
106
107
108
109
110
111
112
113
114
115
|
<?php
/**
* @class ElggFilestore
* This class defines the interface for all elgg data repositories.
* @author Curverider Ltd
*/
abstract class ElggFilestore {
/**
* Attempt to open the file $file for storage or writing.
*
* @param ElggFile $file
* @param string $mode "read", "write", "append"
* @return mixed A handle to the opened file or false on error.
*/
abstract public function open(ElggFile $file, $mode);
/**
* Write data to a given file handle.
*
* @param mixed $f The file handle - exactly what this is depends on the file system
* @param string $data The binary string of data to write
* @return int Number of bytes written.
*/
abstract public function write($f, $data);
/**
* Read data from a filestore.
*
* @param mixed $f The file handle
* @param int $length Length in bytes to read.
* @param int $offset The optional offset.
* @return mixed String of data or false on error.
*/
abstract public function read($f, $length, $offset = 0);
/**
* Seek a given position within a file handle.
*
* @param mixed $f The file handle.
* @param int $position The position.
*/
abstract public function seek($f, $position);
/**
* Return a whether the end of a file has been reached.
*
* @param mixed $f The file handle.
* @return boolean
*/
abstract public function eof($f);
/**
* Return the current position in an open file.
*
* @param mixed $f The file handle.
* @return int
*/
abstract public function tell($f);
/**
* Close a given file handle.
*
* @param mixed $f
*/
abstract public function close($f);
/**
* Delete the file associated with a given file handle.
*
* @param ElggFile $file
*/
abstract public function delete(ElggFile $file);
/**
* Return the size in bytes for a given file.
*
* @param ElggFile $file
*/
abstract public function getFileSize(ElggFile $file);
/**
* Return the filename of a given file as stored on the filestore.
*
* @param ElggFile $file
*/
abstract public function getFilenameOnFilestore(ElggFile $file);
/**
* Get the filestore's creation parameters as an associative array.
* Used for serialisation and for storing the creation details along side a file object.
*
* @return array
*/
abstract public function getParameters();
/**
* Set the parameters from the associative array produced by $this->getParameters().
*/
abstract public function setParameters(array $parameters);
/**
* Get the contents of the whole file.
*
* @param mixed $file The file handle.
* @return mixed The file contents.
*/
abstract public function grabFile(ElggFile $file);
/**
* Return whether a file physically exists or not.
*
* @param ElggFile $file
*/
abstract public function exists(ElggFile $file);
}
|
