https://github.com/totalcrm/php-dbf

PHP library dBase and FoxPro format read and write by TotalCRM
https://github.com/totalcrm/php-dbf

dbase foxpro foxpro-dbf-files php php-library totalcrm

Last synced: about 1 month ago
JSON representation

PHP library dBase and FoxPro format read and write by TotalCRM

• Host: GitHub
• URL: https://github.com/totalcrm/php-dbf
• Owner: totalcrm
• License: mit
• Created: 2021-12-02T09:00:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-23T09:29:14.000Z (over 2 years ago)
• Last Synced: 2024-09-20T14:16:20.180Z (3 months ago)
• Topics: dbase, foxpro, foxpro-dbf-files, php, php-library, totalcrm
• Language: PHP
• Homepage:
• Size: 53.7 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP DBase

A simple library for dealing with **dbf** databases like dBase and FoxPro. It's a port of PHPXbase class written by [Erwin Kooi](http://www.phpclasses.org/package/2673-PHP-Access-dbf-foxpro-files-without-PHP-ext-.html), updated to a PSR-2 compliant code and tweaked for performance and to solve some issues the original code had.

## Installation

You can install it through [Composer](https://getcomposer.org):

```shell script

$ composer require totalcrm/php-dbf

```

## Sample usage

More samples in `examle` folder.

### Reading data

```php

use TotalCRM\DBase\TableReader;

$table = new TableReader('test.dbf');

while ($record = $table->nextRecord()) {

    echo $record->get('my_column');

    //or

    echo $record->my_column;

}

```

If the data in DB is not in UTF-8 you can specify a charset to convert the data from:

```php

use TotalCRM\DBase\TableReader;

$table = new TableReader(

    'test.dbf',

    [

        'encoding' => 'cp1251'

    ]

);

```

It is also possible to read Memos from dedicated files. Just make sure that *.fpt* file with the same name as main database exists.

#### Performance

You can pass an array of the columns that you need to the constructor, then if your table has columns that you don't use they will not be loaded. 

This way the parser can run a lot faster.

```php

use TotalCRM\DBase\TableReader;

$table = new TableReader(

    'test.dbf', 

    [

        'columns' => ['my_column', 'another_column']

    ]

);

while ($record = $table->nextRecord()) {

    echo $record->my_column;

    echo $record->another_column;

}

```

If you know the column type already, you can also call the type-specific function for that field, which increases the speed too.

```php

while ($record = $table->nextRecord()) {

    echo $record->get('my_column');

    echo $record->get('another_column');

}

```

### Editing Data

To open a table for editing, you have to use a `TableEditor` object, as on this example:

```php

use TotalCRM\DBase\TableEditor;

$table = new TableEditor('test.dbf');

for ($i = 0; $i < 10; $i++) {

    $record = $table->nextRecord();

    

    $record->set('field', 'string');

    //or

    $record->field = 'string';

    $table->writeRecord();

}

$table

    ->save()

    ->close();

```

#### Add new record

```php

use TotalCRM\DBase\TableEditor;

$table = new TableEditor(

    'file.dbf',

    [

        'editMode' => TableEditor::EDIT_MODE_CLONE, //default

    ]

);

$record = $table->appendRecord();

$record->set('name', 'test name');

$record->set('age', 20);

$table

    ->writeRecord()

    ->save()

    ->close();

```

#### Delete record

```php

use TotalCRM\DBase\TableEditor;

$table = new TableEditor('file.dbf');

while ($record = $table->nextRecord()) {

    if ($record->get('delete_this_row')) {

        $table->deleteRecord(); //mark record deleted

    }    

}

$table

    ->pack() //remove deleted rows

    ->save() //save changes

    ->close();

```

### Creating table

To create a table file you need to use the `TableCreator` object.

```php

use TotalCRM\DBase\Enum\FieldType;

use TotalCRM\DBase\Enum\TableType;

use TotalCRM\DBase\Header\Column;

use TotalCRM\DBase\Header\HeaderFactory;

use TotalCRM\DBase\TableCreator;

use TotalCRM\DBase\TableEditor;

// you can specify any other database version from TableType

$header = HeaderFactory::create(TableType::DBASE_III_PLUS_MEMO);

$filepath = '/path/to/new/file.dbf';

$tableCreator = new TableCreator($filepath, $header);

$tableCreator

    ->addColumn(new Column([

        'name'   => 'name',

        'type'   => FieldType::CHAR,

        'length' => 20,

    ]))

    ->addColumn(new Column([

        'name'   => 'birthday',

        'type'   => FieldType::DATE,

    ]))

    ->addColumn(new Column([

        'name'   => 'is_man',

        'type'   => FieldType::LOGICAL,

    ]))

    ->addColumn(new Column([

        'name'   => 'bio',

        'type'   => FieldType::MEMO,

    ]))

    ->addColumn(new Column([

        'name'         => 'money',

        'type'         => FieldType::NUMERIC,

        'length'       => 20,

        'decimalCount' => 4,

    ]))

    ->addColumn(new Column([

        'name'   => 'image',

        'type'   => FieldType::MEMO,

    ]))

    ->save(); //creates file

$table = new TableEditor($filepath);

//... add records 

```

## Troubleshooting

I'm not an expert on dBase and I don't know all the specifics of the field types and versions, so the lib may not be able to handle some situations. 

If you find an error, please open an issue and send me a sample table that I can reproduce your problem, and I'll try to help.

## Useful links

[Xbase File Format Description](http://www.manmrk.net/tutorials/database/xbase/)

[File Structure for dBASE 7](http://www.dbase.com/KnowledgeBase/int/db7_file_fmt.htm)

[DBF AND DBT/FPT FILE STRUCTURE](http://www.independent-software.com/dbase-dbf-dbt-file-format.html)