Version 1
[yaffs-website] / vendor / zendframework / zend-feed / src / Reader / ReaderImportInterface.php
diff --git a/vendor/zendframework/zend-feed/src/Reader/ReaderImportInterface.php b/vendor/zendframework/zend-feed/src/Reader/ReaderImportInterface.php
new file mode 100644 (file)
index 0000000..0a2edd1
--- /dev/null
@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Feed\Reader;
+
+interface ReaderImportInterface
+{
+    /**
+     * Import a feed by providing a URI
+     *
+     * @param  string $uri The URI to the feed
+     * @param  string $etag OPTIONAL Last received ETag for this resource
+     * @param  string $lastModified OPTIONAL Last-Modified value for this resource
+     * @return Feed\FeedInterface
+     * @throws Exception\RuntimeException
+     */
+    public static function import($uri, $etag = null, $lastModified = null);
+
+    /**
+     * Import a feed from a remote URI
+     *
+     * Performs similarly to import(), except it uses the HTTP client passed to
+     * the method, and does not take into account cached data.
+     *
+     * Primary purpose is to make it possible to use the Reader with alternate
+     * HTTP client implementations.
+     *
+     * @param  string $uri
+     * @param  Http\ClientInterface $client
+     * @return self
+     * @throws Exception\RuntimeException if response is not an Http\ResponseInterface
+     */
+    public static function importRemoteFeed($uri, Http\ClientInterface $client);
+
+
+    /**
+     * Import a feed from a string
+     *
+     * @param  string $string
+     * @return Feed\FeedInterface
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\RuntimeException
+     */
+    public static function importString($string);
+
+
+    /**
+     * Imports a feed from a file located at $filename.
+     *
+     * @param  string $filename
+     * @throws Exception\RuntimeException
+     * @return Feed\FeedInterface
+     */
+    public static function importFile($filename);
+}