add Path&Phar Operator

Author: AxiosLeo

src/Path.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace axios\tools;
+
+class Path
+{
+    const DS = \DIRECTORY_SEPARATOR;
+
+    /**
+     * path join.
+     *
+     * @param mixed ...$paths
+     *
+     * @return string
+     */
+    public static function join(...$paths)
+    {
+        if (0 === \count($paths)) {
+            throw new \InvalidArgumentException('At least one parameter needs to be passed in.');
+        }
+        $pathResult = explode(self::DS, $paths[0]);
+        unset($paths[0]);
+        $pathResultLen = \count($pathResult);
+        if ('' === $pathResult[$pathResultLen - 1]) {
+            unset($pathResult[$pathResultLen - 1]);
+        }
+        foreach ($paths as $path) {
+            $tmp = explode(self::DS, $path);
+            foreach ($tmp as $str) {
+                if ('..' === $str) {
+                    array_pop($pathResult);
+                } elseif ('.' === $str || '' === $str) {
+                    continue;
+                } else {
+                    array_push($pathResult, $str);
+                }
+            }
+        }
+
+        return implode(self::DS, $pathResult);
+    }
+
+    /**
+     * search files.
+     *
+     * @param string $dir
+     * @param string $extInclude
+     * @param false  $asc
+     * @param int    $sorting_type
+     *
+     * @return array
+     */
+    public static function search($dir, $extInclude = '*', $asc = false, $sorting_type = SORT_FLAG_CASE)
+    {
+        $list = [];
+        if (is_dir($dir)) {
+            $dirHandle = opendir($dir);
+            while (!\is_bool($dirHandle) && false !== ($file_name = readdir($dirHandle))) {
+                $tmp = str_replace('.', '', $file_name);
+                if ('' != $tmp) {
+                    $subFile = self::join($dir, $file_name);
+                    $ext     = pathinfo($file_name, PATHINFO_EXTENSION);
+                    if (is_dir($subFile)) {
+                        $list = array_merge($list, self::search($subFile, $extInclude, $asc, $sorting_type));
+                    } elseif (\is_string($extInclude)) {
+                        if ('*' == $extInclude || preg_match($extInclude, $file_name)) {
+                            $list[\count($list)] = $subFile;
+                        }
+                    } elseif (\is_array($extInclude) && \in_array($ext, $extInclude)) {
+                        $list[\count($list)] = $subFile;
+                    }
+                }
+            }
+            closedir($dirHandle);
+        }
+        $asc ? ksort($list, $sorting_type) : krsort($list, $sorting_type);
+
+        return $list;
+    }
+}

src/PharOperator.php

@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+namespace axios\tools;
+
+class PharOperator
+{
+    /**
+     * @var \Phar
+     */
+    private $phar;
+
+    /**
+     * @var string
+     */
+    private $zip_dir;
+
+    /**
+     * @var array exclude files or folders
+     */
+    private $exclude;
+
+    /**
+     * @var mixed|string
+     *
+     * @example '/\.(json|php|ini)$/'
+     */
+    private $include;
+
+    /**
+     * @var string
+     */
+    private $index = 'autoload.php';
+
+    public function __construct($zip_dir = null, $include = '/\.*$/', $exclude = [])
+    {
+        if (!file_exists($zip_dir)) {
+            throw new \InvalidArgumentException("{$zip_dir} is not exist.");
+        }
+        $this->zip_dir = Path::join($zip_dir);
+        $this->exclude = $exclude;
+        $this->include = $include;
+    }
+
+    /**
+     * @param $index
+     *
+     * @return $this
+     */
+    public function setIndex($index)
+    {
+        $this->index = $index;
+
+        return $this;
+    }
+
+    /**
+     * @param string $exclude
+     *
+     * @return self
+     */
+    public function addExclude($exclude)
+    {
+        array_push($this->exclude, Path::join($exclude));
+
+        return $this;
+    }
+
+    /**
+     * @param string $output_path
+     */
+    public function zip($output_path)
+    {
+        $save_path = $output_path;
+        if (is_dir($save_path)) {
+            throw new \InvalidArgumentException("{$output_path} must be file path.");
+        }
+        if (!file_exists(\dirname($save_path))) {
+            @mkdir(\dirname($save_path), 0755, true);
+        }
+
+        if (file_exists($save_path)) {
+            @unlink($save_path);
+        }
+
+        $this->phar = new \Phar($save_path);
+        $this->phar->buildFromDirectory($this->zip_dir, $this->include);
+        if (!empty($this->exclude)) {
+            $this->remove($this->exclude);
+        }
+        $this->phar->setStub($this->phar->createDefaultStub($this->index));
+        $this->phar->stopBuffering();
+    }
+
+    /**
+     * @param array $exclude
+     */
+    private function remove($exclude)
+    {
+        foreach ($exclude as $file) {
+            $path = Path::join($this->zip_dir, $file);
+            if (is_dir($path)) {
+                $files = Path::search($path, $this->include);
+                foreach ($files as $filepath) {
+                    $file = str_replace($this->zip_dir . \DIRECTORY_SEPARATOR, '', $filepath);
+                    if ($this->phar->offsetExists($file)) {
+                        $this->phar->delete($file);
+                    }
+                }
+            } elseif ($this->phar->offsetExists($file)) {
+                $this->phar->delete($file);
+            }
+        }
+    }
+}

tests/unit/PathTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace axios\tools\tests\unit;
+
+use axios\tools\Path;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+class PathTest extends TestCase
+{
+    public function testJoin()
+    {
+        $this->assertEquals('/path/to', Path::join('/path/to/file.json', '..'));
+        $this->assertEquals('/path/to/file.json', Path::join('/path/to/file.json', '.'));
+        $this->assertEquals('/path/to/some/foo/bar', Path::join('/path/to/', 'some', './', 'foo', 'invalid', '..', 'bar'));
+    }
+
+    public function testSearch()
+    {
+        $dir   = \dirname(__DIR__);
+        $files = Path::search($dir);
+        $count = \count($files);
+        $this->assertCount($count, Path::search($dir, '/\.(php|ini)$/'));
+        $this->assertCount($count, Path::search($dir, ['php']));
+        $this->assertCount(0, Path::search($dir, '/\.(xml|json)$/'));
+        $this->assertCount(0, Path::search($dir, ['xml', 'json']));
+    }
+}