aboutsummaryrefslogtreecommitdiff
path: root/h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php
diff options
context:
space:
mode:
authorAntonio Gallo <tonicucoz@gmail.com>2010-10-17 13:29:57 +0000
committerAntonio Gallo <tonicucoz@gmail.com>2010-10-17 13:29:57 +0000
commit232aa1924c8c0f10d87b210b46c9f061af5c844c (patch)
tree2351f2aaff7ad244f60358954e4711692fb8aadc /h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php
parenta17e3e0495bee3705d3c1e5ead2db1a8359e64e9 (diff)
added files
Diffstat (limited to 'h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php')
-rw-r--r--h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php99
1 files changed, 99 insertions, 0 deletions
diff --git a/h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php b/h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php
new file mode 100644
index 0000000..b942663
--- /dev/null
+++ b/h-source/External/swiftmailer/lib/classes/Swift/KeyCache.php
@@ -0,0 +1,99 @@
+<?php
+
+/*
+ * This file is part of SwiftMailer.
+ * (c) 2004-2009 Chris Corbyn
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+//@require 'Swift/InputByteStream.php';
+//@require 'Swift/OutputByteStream.php';
+
+/**
+ * Provides a mechanism for storing data using two keys.
+ * @package Swift
+ * @subpackage KeyCache
+ * @author Chris Corbyn
+ */
+interface Swift_KeyCache
+{
+
+ /** Mode for replacing existing cached data */
+ const MODE_WRITE = 1;
+
+ /** Mode for appending data to the end of existing cached data */
+ const MODE_APPEND = 2;
+
+ /**
+ * Set a string into the cache under $itemKey for the namespace $nsKey.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @param string $string
+ * @param int $mode
+ * @see MODE_WRITE, MODE_APPEND
+ */
+ public function setString($nsKey, $itemKey, $string, $mode);
+
+ /**
+ * Set a ByteStream into the cache under $itemKey for the namespace $nsKey.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @param Swift_OutputByteStream $os
+ * @param int $mode
+ * @see MODE_WRITE, MODE_APPEND
+ */
+ public function importFromByteStream($nsKey, $itemKey, Swift_OutputByteStream $os,
+ $mode);
+
+ /**
+ * Provides a ByteStream which when written to, writes data to $itemKey.
+ * NOTE: The stream will always write in append mode.
+ * If the optional third parameter is passed all writes will go through $is.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @param Swift_InputByteStream $is, optional
+ * @return Swift_InputByteStream
+ */
+ public function getInputByteStream($nsKey, $itemKey,
+ Swift_InputByteStream $is = null);
+
+ /**
+ * Get data back out of the cache as a string.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @return string
+ */
+ public function getString($nsKey, $itemKey);
+
+ /**
+ * Get data back out of the cache as a ByteStream.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @param Swift_InputByteStream $is to write the data to
+ */
+ public function exportToByteStream($nsKey, $itemKey, Swift_InputByteStream $is);
+
+ /**
+ * Check if the given $itemKey exists in the namespace $nsKey.
+ * @param string $nsKey
+ * @param string $itemKey
+ * @return boolean
+ */
+ public function hasKey($nsKey, $itemKey);
+
+ /**
+ * Clear data for $itemKey in the namespace $nsKey if it exists.
+ * @param string $nsKey
+ * @param string $itemKey
+ */
+ public function clearKey($nsKey, $itemKey);
+
+ /**
+ * Clear all data in the namespace $nsKey if it exists.
+ * @param string $nsKey
+ */
+ public function clearAll($nsKey);
+
+}