Table and Memo second argument is options array now

luads · Dec 8, 2020 · 02dafd1 · 02dafd1
1 parent 7dbce69
commit 02dafd1
Show file tree

Hide file tree

Showing 14 changed files with 196 additions and 72 deletions.
diff --git a/example/test-memo.php b/example/test-memo.php
@@ -20,7 +20,7 @@
     die('Bad path to file realpath '.$argv[1]);
 }
 
-$table = new Table($filepath, null, 'cp1252');
+$table = new Table($filepath, ['encoding' => 'cp1252']);
 echo 'Record count: '.$table->getRecordCount() . PHP_EOL;
 
 $columns = $table->getColumns();

diff --git a/src/XBase/BlocksMerger.php b/src/XBase/BlocksMerger.php
@@ -30,6 +30,9 @@ public function get(): array
         return $this->squeeze();
     }
 
+    /**
+     * Combines several adjacent blocks into one.
+     */
     private function squeeze(): array
     {
         $pointers = array_column($this->blocksToDelete, 0);

diff --git a/src/XBase/Memo/AbstractMemo.php b/src/XBase/Memo/AbstractMemo.php
@@ -16,23 +16,38 @@ abstract class AbstractMemo implements MemoInterface
     /** @var string */
     protected $filepath;
 
-    /** @var string */
-    protected $convertFrom;
+    /** @var array */
+    protected $options = [];
 
     /**
-     * Memo constructor.
-     *
-     * @param string $convertFrom
+     * @param string $filepath Path to memo file
+     * @param array  $options  Array of options:<br>
+     *                         encoding - convert text data from<br>
+     *                         writable - edit mode<br>
      */
-    public function __construct(Table $table, string $filepath, ?string $convertFrom = null)
+    public function __construct(Table $table, string $filepath, $options = [])
     {
         $this->table = $table;
         $this->filepath = $filepath;
-        $this->convertFrom = $convertFrom; //todo autodetect from languageCode
+        $this->options = $this->resolveOptions($options);
         $this->open();
         $this->readHeader();
     }
 
+    protected function resolveOptions($options = []): array
+    {
+        if (is_string($options)) {
+            @trigger_error('You should pass convertFrom as `encoding` option');
+            $options = ['encoding' => $options];
+        }
+
+        $options = array_merge([
+            'encoding' => null,
+        ], $options);
+
+        return $options;
+    }
+
     public function __destruct()
     {
         $this->close();

diff --git a/src/XBase/Memo/AbstractWritableMemo.php b/src/XBase/Memo/AbstractWritableMemo.php
@@ -4,16 +4,12 @@
 
 use XBase\BlocksMerger;
 use XBase\Stream\Stream;
-use XBase\Table;
 use XBase\Traits\CloneTrait;
 
 abstract class AbstractWritableMemo extends AbstractMemo implements WritableMemoInterface
 {
     use CloneTrait;
 
-    /** @var bool */
-    protected $writable = false;
-
     /**
      * @var BlocksMerger Garbage blocks. Delete blocks while saving.
      */
@@ -26,15 +22,16 @@ abstract protected function getBlockLengthInBytes(): int;
 
     abstract protected function calculateBlockCount(string $data): int;
 
-    public function __construct(Table $table, string $filepath, ?string $convertFrom = null, bool $writable = false)
+    protected function resolveOptions($options = []): array
     {
-        $this->writable = $writable;
-        parent::__construct($table, $filepath, $convertFrom);
+        return array_merge([
+            'writable' => false,
+        ], parent::resolveOptions($options));
     }
 
     public function open(): void
     {
-        if (!$this->writable) {
+        if (!$this->options['writable']) {
             parent::open();
 
             return;
@@ -54,7 +51,7 @@ protected function readHeader(): void
     public function close(): void
     {
         parent::close();
-        if ($this->writable && $this->cloneFilepath) {
+        if ($this->options['writable'] && $this->cloneFilepath) {
             unlink($this->cloneFilepath);
             $this->cloneFilepath = null;
         }

diff --git a/src/XBase/Memo/DBase3Memo.php b/src/XBase/Memo/DBase3Memo.php
@@ -47,8 +47,8 @@ public function get(int $pointer): ?MemoObject
             if (chr(0x00) === substr($result, -1)) {
                 $result = substr($result, 0, -1); // remove endline symbol (0x00)
             }
-            if ($this->convertFrom) {
-                $result = iconv($this->convertFrom, 'utf-8', $result);
+            if ($this->options['encoding']) {
+                $result = iconv($this->options['encoding'], 'utf-8', $result);
             }
         }
 

diff --git a/src/XBase/Memo/DBase4Memo.php b/src/XBase/Memo/DBase4Memo.php
@@ -46,8 +46,8 @@ public function get(int $pointer): ?MemoObject
 //        $result = $this->fp->read($memoLength[1] - self::BLOCK_SIGN_LENGTH - self::BLOCK_LENGTH_LENGTH);
 
         $type = $this->guessDataType($result);
-        if (MemoObject::TYPE_TEXT === $type && $this->convertFrom) {
-            $result = iconv($this->convertFrom, 'utf-8', $result);
+        if (MemoObject::TYPE_TEXT === $type && $this->options['encoding']) {
+            $result = iconv($this->options['encoding'], 'utf-8', $result);
         }
 
         return new MemoObject($result, $type, $pointer, $memoLength[1]);

diff --git a/src/XBase/Memo/FoxproMemo.php b/src/XBase/Memo/FoxproMemo.php
@@ -54,8 +54,8 @@ public function get(int $pointer): ?MemoObject
         $result = $this->fp->read($memoLength[1]);
 
         $type = $this->guessDataType($result);
-        if ($this->convertFrom) {
-            $result = iconv($this->convertFrom, 'utf-8', $result);
+        if ($this->options['encoding']) {
+            $result = iconv($this->options['encoding'], 'utf-8', $result);
         }
 
         return new MemoObject($result, $type, $pointer, $memoLength[1]);

diff --git a/src/XBase/Memo/MemoFactory.php b/src/XBase/Memo/MemoFactory.php
@@ -7,7 +7,7 @@
 
 class MemoFactory
 {
-    public static function create(Table $table, bool $writable = false): ?MemoInterface
+    public static function create(Table $table, array $options = []): ?MemoInterface
     {
         $class = self::getClass($table->getVersion());
         $refClass = new \ReflectionClass($class);
@@ -26,7 +26,7 @@ public static function create(Table $table, bool $writable = false): ?MemoInterf
             return null; //todo create file?
         }
 
-        return $refClass->newInstance($table, $memoFilepath, $table->getConvertFrom(), $writable);
+        return $refClass->newInstance($table, $memoFilepath, $options);
     }
 
     private static function getClass(int $version): string

diff --git a/src/XBase/Table.php b/src/XBase/Table.php
@@ -30,9 +30,6 @@ class Table
     /** @var string Table filepath. */
     protected $filepath;
 
-    /** @var array|null */
-    protected $availableColumns;
-
     /** @var Stream */
     protected $fp;
 
@@ -48,9 +45,6 @@ class Table
     /** @var RecordInterface|null */
     protected $record;
 
-    /** @var string|null */
-    protected $convertFrom;
-
     /**
      * @var int
      *
@@ -137,25 +131,51 @@ class Table
     /** @var string|null DBase7 only */
     protected $languageName;
 
+    /** @var array */
+    protected $options = [];
+
     /**
      * Table constructor.
      *
-     * @param array|null  $availableColumns
-     * @param string|null $convertFrom      Encoding of file
+     * @param array $options Array of options:<br>
+     *                       encoding - convert text data from<br>
+     *                       columns - available columns<br>
      *
      * @throws \Exception
      */
-    public function __construct(string $filepath, $availableColumns = null, $convertFrom = null)
+    public function __construct(string $filepath, $options = [], $convertFrom = null)
     {
         $this->filepath = $filepath;
-        $this->availableColumns = $availableColumns;
-        $this->convertFrom = $convertFrom; //todo autodetect from languageCode
+        $this->options = $this->resolveOptions($options, $convertFrom);
 
         $this->open();
         $this->readHeader();
         $this->openMemo();
     }
 
+    protected function resolveOptions($options, $convertFrom = null): array
+    {
+        // right options
+        if (!empty($options) && array_intersect(['encoding', 'columns'], array_keys($options))) {
+            return array_merge([
+                'columns'  => [],
+                'encoding' => null,
+            ], $options);
+        }
+
+        if (!empty($options)) {
+            @trigger_error('You should pass availableColumns as `columns` option');
+        }
+        if (!empty($convertFrom)) {
+            @trigger_error('You should pass convertFrom as `encoding` option');
+        }
+
+        return [
+            'columns'  => $options ?? [],
+            'encoding' => $convertFrom,
+        ];
+    }
+
     protected function open(): void
     {
         if (!file_exists($this->filepath)) {
@@ -206,7 +226,7 @@ protected function readHeader(): void
     protected function openMemo(): void
     {
         if (TableType::hasMemo($this->getVersion())) {
-            $this->memo = MemoFactory::create($this);
+            $this->memo = MemoFactory::create($this, $this->options);
         }
     }
 
@@ -517,7 +537,7 @@ public function getDeleteCount()
 
     public function getConvertFrom(): ?string
     {
-        return $this->convertFrom;
+        return $this->options['encoding'];
     }
 
     /**

diff --git a/src/XBase/Traits/CloneTrait.php b/src/XBase/Traits/CloneTrait.php
@@ -7,7 +7,7 @@
  */
 trait CloneTrait
 {
-    /** @var string */
+    /** @var string|null */
     private $cloneFilepath;
 
     /**