Table of Contents

Supported formats

Supported memo formats

Installation

Composer

composer require org.majkel/dbase

require_once'vendor/autoload.php'

Old-fashion style

require_once'DBASE/LIB/DIR/autoloader.php';

Documentation

Reading tables

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$totalSum =0;$dbf = Table::fromFile('some/table.dbf');foreach ($dbfas$record) {// returns all records includeing deleted onesif (!$record->isDeleted()) {$totalSum +=$record->int_val;    }}echo"Total sum is$totalSum, 5th description:{$record[4]['description']}\n";

Inserting rows

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;useorg\majkel\dbase\Record;$dbf = Table::fromFile('some/table.dbf');$record =newRecord();$record->fieldBool =true;$record->fieldInt  =123;$record->fieldChar ='some text 1';$record->fieldMemo ='some long text';$dbf->insert($record);$dbf->insert(['fieldBool' =>false,'fieldInt'  =>321,'fieldChar' =>'some text 2',]);

Automatic type conversion

Record object

Reading data from record

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$dbf = Table::fromFile('some/table.dbf');// fetch first record$record =$dbf[0];echo"int  field:{$record->number}\n";// returns integerecho"bool field:{$record->boolean}\n";// returns booleanecho"date field:{$record->date->format('Y-m-d')}\n";// return DateTime objectecho"text field:{$record->text}\n";// returns stringecho"memo field:{$record->memo}\n";// returns string (not entity id)echo"memo field id:{$record->getMemoEntryId('memo')}\n";// returns entity id for memo field `memo`echo"is record deleted:{$record->isDeleted('memo')}\n";// returns whether record is deleted// ... or ...echo"int  field:{$record['number']}\n";// returns integerecho"bool field:{$record['boolean']}\n";// returns booleanecho"date field:{$record['date']->format('Y-m-d')}\n";// return DateTime objectecho"text field:{$record['text']}\n";// returns stringecho"memo field:{$record['memo']}\n";// returns string (not entity id)echo"memo field id:{$record->getMemoEntryId('memo')}\n";// returns entity id for memo field `memo`echo"is record deleted:{$record->isDeleted('memo')}\n";// returns whether record is deleted// you can loop over fields in the recordforeach ($recordas$fieldName =>$fieldValue) {echo"$fieldName =$fieldValue\n";}

Writing data to record

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$dbf = Table::fromFile('some/table.dbf');// fetch first record$record =$dbf[0];$record->number  =123;$record->boolean =true;$record->date    =newDateTime();$record->text    ='some text';$record->memo    ='some longer text';// ... or ...$record['number']  =123;$record['boolean'] =true;$record['date']    =newDateTime();$record['text']    ='some text';$record['memo']    ='some longer text';

Updating tables

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$dbf = Table::fromFile('some/table.dbf');foreach ($dbfas$record) {$record->int_val +=10;$dbf->update($record);// header is updated everytime}

Deleting records

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$dbf = Table::fromFile('some/table.dbf');// delete 7th record$dbf->delete(6);// undelete 6th record$dbf->markDelete(5,false);

Transactions

require_once'vendor/autoload.php'useorg\majkel\dbase\Table;$dbf = Table::fromFile('some/table.dbf');// header is updated. Transaction flag is set$dbf->beginTransaction();foreach ($dbfas$record) {$record->int_val +=10;$dbf->update($record);// header is not written}// duplicate last row$dbf->insert($record);// header is not written// header is written, transaction flag is cleared, recond count is updated$dbf->endTransaction();

Defining tables

require_once'vendor/autoload.php'useorg\majkel\dbase\Builder;useorg\majkel\dbase\Format;useorg\majkel\dbase\Field;$table = Builder::create()    ->setFormatType(Format::DBASE3)    ->addField(Field::create(Field::TYPE_CHARACTER)->setName('str')->setLength(15))    ->addField(Field::create(Field::TYPE_LOGICAL)->setName('bool'))    ->addField(Field::create(Field::TYPE_NUMERIC)->setName('num'))    ->build('destination.dbf');for ($i =1;$i <=3; ++$i) {$table->insert(['str' =>"Str$i",'bool' =>false,'num' =>$i,    ]);}

Creating table from another table

require_once'vendor/autoload.php'useorg\majkel\dbase\Builder;useorg\majkel\dbase\Format;useorg\majkel\dbase\Field;$table = Builder::fromFile('source.dbf')    ->setFormatType(Format::DBASE3)    ->addField(Field::create(Field::TYPE_NUMERIC)->setName('newField1'))    ->build('destination.dbf');for ($i =1;$i <=3; ++$i) {$table->insert(['oldField1' =>"Str$i",'oldField2' =>false,'newField1' =>$i,    ]);}

Filters

Using filters

require_once'vendor/autoload.php'useorg\majkel\dbase\Builder;useorg\majkel\dbase\filter\TrimFilter;useyour\CurrencyFilter;$dbf = Table::fromFile('some/table.dbf');$dbf->getHeader()->getField('price')    ->addFilter(newTrimFilter())    ->addFilter(newCurrencyFilter(',','.'));foreach ($dbfas$record) {// ...}

Writing custom filter

require_once'vendor/autoload.php'useorg\majkel\dbase\FilterInterface;useorg\majkel\dbase\Field;class CurrencyFilterextends FilterInterface{/** @var string */private$inputDot;/** @var string */private$outputDot;/**     * @param string $inputDot     * @param string $outputDot     */publicfunction__construct($inputDot,$outputDot)    {$this->inputDot =$inputDot;$this->outputDot =$outputDot;    }/**     * From table value to PHP value     *     * @param mixed $value     * @return mixed     */publicfunctiontoValue($value)    {returnstr_replace($this->inputDot,$this->outputDot,$value);    }/**     * From PHP value to table value     *     * @param mixed $value     * @return mixed     */publicfunctionfromValue($value)    {returnstr_replace($this->outputDot,$this->inputDot,$value);    }/**     * Filter can be applied on string like columns     *     * @param integer $type     * @return boolean     */publicfunctionsupportsType($type)    {returnin_aray($type, [Field::TYPE_CHARACTER, Field::TYPE_MEMO]);    }}