From 76dac45ebaf104b312a8527a05424601ca9d520a Mon Sep 17 00:00:00 2001
From: ewinslow <ewinslow@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Mon, 6 Sep 2010 02:42:09 +0000
Subject: Refs #2220: Pulled most classes / interfaces out of lib files (except
 query.php and exception.php) into "classes" folder.  Replaced inline classes
 with "require_once" statements for now.  Ran unit tests to verify
 functionality before committing.

git-svn-id: http://code.elgg.org/elgg/trunk@6908 36083f99-b078-4883-b0ff-0f9b5a30f544
---
 engine/classes/ElggFilestore.php | 115 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 115 insertions(+)
 create mode 100644 engine/classes/ElggFilestore.php

(limited to 'engine/classes/ElggFilestore.php')

diff --git a/engine/classes/ElggFilestore.php b/engine/classes/ElggFilestore.php
new file mode 100644
index 000000000..3311842a9
--- /dev/null
+++ b/engine/classes/ElggFilestore.php
@@ -0,0 +1,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);
+}
\ No newline at end of file
-- 
cgit v1.2.3