Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/byjg/php-anydataset
Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP.
https://github.com/byjg/php-anydataset
anydataset csv json mongodb mysql oracle php postgresql relational-databases sparql sqlserver text-file xml
Last synced: 19 days ago
JSON representation
Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP.
- Host: GitHub
- URL: https://github.com/byjg/php-anydataset
- Owner: byjg
- License: mit
- Created: 2015-07-22T21:53:16.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T15:59:45.000Z (24 days ago)
- Last Synced: 2024-10-27T18:27:49.411Z (24 days ago)
- Topics: anydataset, csv, json, mongodb, mysql, oracle, php, postgresql, relational-databases, sparql, sqlserver, text-file, xml
- Language: PHP
- Homepage:
- Size: 591 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# AnyDataset
[](http://opensource.byjg.com)
[](https://github.com/byjg/php-anydataset/actions/workflows/phpunit.yml)
[](http://opensource.byjg.com)
[](https://github.com/byjg/php-anydataset/)
[](https://opensource.byjg.com/opensource/licensing.html)
[](https://github.com/byjg/php-anydataset/releases/)
Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP.
## Features
- Access different data sources using the same interface.
- Iterable results
- Convert results to array
## Current Implementations
| Object | Data Source | Read | Write | Reference |
|------------------------|-----------------------|:----:|:-----:|-----------------------------------------------------|
| DbDriverInterface | Relational DB | yes | yes | [Github](https://github.com/byjg/anydataset-db) |
| AnyDataSet | Anydataset | yes | yes | [Github](https://github.com/byjg/anydataset) |
| ArrayDataSet | Array | yes | no | [Github](https://github.com/byjg/anydataset-array) |
| TextFileDataSet | Delimited Fields | yes | no | [Github](https://github.com/byjg/anydataset-text) |
| FixedTextFileDataSet | Fixed Size fields | yes | no | [Github](https://github.com/byjg/anydataset-text) |
| XmlDataSet | Xml | yes | no | [Github](https://github.com/byjg/anydataset-xml) |
| JSONDataSet | Json | yes | no | [Github](https://github.com/byjg/anydataset-json) |
| SparQLDataSet | SparQl Repositories | yes | no | [Github](https://github.com/byjg/anydataset-sparql) |
| NoSqlDocumentInterface | NoSql Document Based | yes | yes | [Github](https://github.com/byjg/anydataset-nosql) |
| KeyValueInterface | NoSql Key/Value Based | yes | yes | [Github](https://github.com/byjg/anydataset-nosql) |
## Examples
### Iterating with foreach
```php
getIterator();
foreach ($iterator as $row) {
print $row->toArray();
}
```
### Filtering results
```php
addRelation("field1", \ByJG\AnyDataset\Core\Enum\Relation::EQUAL, 10);
$iterator2 = $dataset->getIterator($filter);
```
### Converting to Array
```php
getIterator();
print_r($iterator->toArray());
```
### Iterating with While
```php
getIterator();
while ($iterator->hasNext()) {
$row = $iterator->moveNext();
print_r($row->get("field1"));
}
```
or
```php
foreach ($iterator as $row) {
print_r($row->get("field1"));
}
```
## Additional Classes
### RowOutpout - Format Field Output
This class defines custom format for the field output.
```php
addFormat("field1", "Test {field1}")
->addFormat("field2", "Showing {} and {field3}");
->addCustomFormat("field3", function ($row, $field, $value) {
// return the formatted output.
// $row: The row object with all values
// $field: The field has been processed
// $value: The field value
});
// This will output the field1 formatted:
echo $output->print($row, "field1");
// This will apply the format defintion to all fields at once:
$ouput->apply($row);
```
Notes about the format pattern:
- `{}` represents the current value
- `{.}` represents the field name
- `{field_name}` return the value of $row->get(field_name)
### RowValidator - Validate Field contents
```php
requiredFields(["field1", "field2"])
->numericFields(['field1', 'field3'])
->regexValidation("field4", '/\d{4}-\d{2}-\d{2}/')
->customValidation("field3", function($value) {
// Return any string containing the error message if validation FAILS
// otherwise, just return null and the valition will pass.
});
$validator->validate($row) // Will return an array with the error messages. Empty array if not errors.
```
## Formatters
AnyDataset comes with an extensible set to format the AnyDataset. The interface is:
```php
namespace ByJG\AnyDataset\Core\Formatter;
interface FormatterInterface
{
/**
* Return the object in your original format, normally as object
*
* @return mixed
*/
public function raw();
/**
* Return the object transformed to string.
*
* @return string
*/
public function toText();
/**
* Save the contents to a file
*
* @param string $filename
* @return void
*/
public function saveToFile($filename);
}
```
AnyDataset implements two formatters:
- JsonFormatter
- XmlFormatter
Example:
```php
getIterator());
$formatter->raw(); // Return a DOM object
$formatter->toText(); // Return the XML as a text
$formatter->saveToFile("/path/to/file.xml"); // Save the XML Text to a file.
```
## Install
```bash
composer require "byjg/anydataset"
```
## Running Unit tests
```bash
vendor/bin/phpunit
```
## Dependencies
```mermaid
flowchart TD
byjg/anydataset --> byjg/serializer
byjg/anydataset --> byjg/xmlutil
```
----
[Open source ByJG](http://opensource.byjg.com)