Merge pull request #1 from nlegoff/interfaces

Describe zippy interfaces

Author: romainneutron

src/Alchemy/Zippy/AdapterInterface.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of Zippy.
+ *
+ * (c) Alchemy <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Zippy;
+
+use Alchemy\Zippy\ArchiveInterface;
+use Alchemy\Zippy\Exception\InvalidArgumentException;
+use Alchemy\Zippy\Exception\RuntimeException;
+use Alchemy\Zippy\Options;
+
+Interface AdapterInterface
+{
+    /**
+     * Returns the adapter name
+     *
+     * @return String
+     */
+    public function getName();
+
+    /**
+     * Returns the adapter options
+     *
+     * @return Options
+     */
+    public function getOptions();
+
+    /**
+     * Sets adapter options
+     *
+     * @param Options $option
+     *
+     * @return AdapterInterface
+     */
+    public function setOptions(Options $option);
+
+    /**
+     * Opens an archive
+     *
+     * @param String $path The path to the archive
+     *
+     * @return ArchiveInterface
+     *
+     * @throws InvalidArgumentException In case the provided path is not valid
+     * @throws RuntimeException         In case of failure
+     */
+    public function open($path);
+
+    /**
+     * Creates a new archive
+     *
+     * @param String $path The path to the archive
+     *
+     * @return ArchiveInterface
+     *
+     * @throws RuntimeException In case of failure
+     */
+    public function create($path);
+
+    /**
+     * Tests adapter support for current environment
+     *
+     * @return Boolean
+     */
+    public static function isSupported();
+}

src/Alchemy/Zippy/ArchiveInterface.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of Zippy.
+ *
+ * (c) Alchemy <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Zippy;
+
+use Alchemy\Zippy\Exception\InvalidArgumentException;
+use Alchemy\Zippy\Exception\RuntimeException;
+use Alchemy\Zippy\FileInterface;
+
+interface ArchiveInterface
+{
+    /**
+     * Adds a file into the archive
+     *
+     * @param String|\SplFileInfo $source The path to the file
+     * @param String|null         $target The archive file path, null to use the same as source
+     *
+     * @return ArchiveInterface
+     *
+     * @throws InvalidArgumentException In case the provided source path is not valid
+     * @throws RuntimeException         In case of failure
+     */
+    public function add($source, $target = null);
+
+    /**
+     * Adds a directory into the archive
+
+     * @param String|\SplFileInfo $source    The path to the directory
+     * @param String|null         $target    The directory file path, null to use the same as source
+     * @param Boolean             $recursive Recurse into directories
+     *
+     * @return ArchiveInterface
+     *
+     * @throws InvalidArgumentException In case the provided source path is not valid
+     * @throws RuntimeException         In case of failure
+     */
+    public function addDirectory($source, $target = null, $recursive = true);
+
+    /**
+     * Removes a file from the archive
+     *
+     * @param FileInterface $file The file to remove
+     *
+     * @return ArchiveInterface
+     *
+     * @throws RuntimeException In case of failure
+     */
+    public function remove(FileInterface $file);
+}

src/Zippy/Exception/ExceptionInterface.php renamed to src/Alchemy/Zippy/Exception/ExceptionInterface.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Zippy\Exception;
+namespace Alchemy\Zippy\Exception;
 
 interface ExceptionInterface
 {

src/Alchemy/Zippy/Exception/InvalidArgumentException.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of Zippy.
+ *
+ * (c) Alchemy <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Zippy\Exception;
+
+class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
+{
+}

src/Zippy/Exception/RuntimeException.php renamed to src/Alchemy/Zippy/Exception/RuntimeException.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Zippy\Exception;
+namespace Alchemy\Zippy\Exception;
 
 class RuntimeException extends \RuntimeException implements ExceptionInterface
 {

src/Alchemy/Zippy/FileInterface.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of Zippy.
+ *
+ * (c) Alchemy <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Zippy;
+
+use Alchemy\Zippy\Exception\RuntimeException;
+
+class FileInterface
+{
+    /**
+     * Gets the location of a file
+     *
+     * @return String
+     */
+    public function getLocation();
+
+    /**
+     * Extracts a file from the archive to the given path
+     *
+     * @throws RuntimeException In case the extraction failed
+     */
+    public function extract($target);
+
+    /**
+     * Tells whether the current file is a directory or not
+     *
+     * @return Boolean
+     */
+    public function isDir();
+
+    /**
+     * Relocates a file with the given path
+     *
+     * @return FileInterface
+     *
+     * @throws RuntimeException In case of failure
+     */
+    public function rename($location);
+
+    /**
+     * @inheritdoc
+     */
+    public function __toString();
+}

src/Alchemy/Zippy/Options.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of Zippy.
+ *
+ * (c) Alchemy <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Alchemy\Zippy;
+
+class Options
+{
+}