net_bazzline/php_component_database_file_storage

local file database

0.7.1 2016-08-11 20:05 UTC

Requires

• php: >=5.4.0
• net_bazzline/component_lock: 2.1.*
• net_bazzline/php_component_csv: 1.5.*
• net_bazzline/php_component_toolbox: 1.9.*
• ramsey/uuid: 3.3.*

Requires (Dev)

• mikey179/vfsstream: 1.6.*
• mockery/mockery: >=0.9.4
• phpunit/phpunit: ~4.8||~5.5

LGPL-3.0

• Stev Leibelt

• database
• php
• file
• repository
• uuid
• psr
• bazzline
• local
• PSR-4

README

crud storage interface

/**
 * @param $data
 * @return mixed - unique identifier
 */
public function create($data);

/**
 * @return array
 */
public function readMany();

/**
 * @return null|mixed - nothing or data
 */
public function readOne();

/**
 * @param mixed $data
 * @return boolean
 */
public function update($data);

/**
 * @return boolean
 */
public function delete();

/**
 * @param mixed $key
 * @param mixed $value
 * @return $this
 */
public function filterBy($key, $value);

/**
 * @param mixed $id
 * @return $this
 */
public function filterById($id);

/**
 * @param int $count
 * @param null|int $offset
 * @return $this
 */
public function limitBy($count, $offset = null);

Install

By Hand

mkdir -p vendor/net_bazzline/php_component_database_file_storage
cd vendor/net_bazzline/php_component_database_file_storage
git clone https://github.com/bazzline/php_component_database_file_storage .

With Packagist

composer require net_bazzline/php_component_database_file_storage:dev-master

Benefits

• implemented locking to prevent multiple reads and writes

API

API is available at bazzline.net.

Future Improvements

• extend "filterBy"
  • $key and $value are optional to filter by key or by value
• take a look to bigdump
• take a look to reactphp/filesystem
• take a look to file wrapper
• implement "modifier" to easy up modifiying data before reading or writing
• if write (create/read) action is triggered, create a *.lock file to prevent multiple writings
  • or usd flock
• implement caching via proxy
  • simple two files storages injected
  • if number of changed itemes reaches limit, cache is written into real storage
• use a uuid generator for unique keys
  • use a temporary file
  • beeing even more pro, use php://temp
    • implement some kind of "intelligent" cache that counts the average size of an entry to determine the maximum number of entries before flushing the cache

History

• upcomming
  • @todo
  • added support for php version above 7.0
  • dropped support for php version below 5.6
• 0.7.1 - released at 11.08.2016
  • updated phpunit
• 0.7.0 - released at 29.03.2016
  • added API section
  • bumped php version to 5.4
  • moved to psr-4 autoloading
  • updated dependencies
• 0.6.5 - released at 18.12.2015
  • updated dependencies
• 0.6.4 - released at 11.12.2015
  • updated dependencies
• 0.6.3 - released at 18.11.2015
  • updated dependencies
• 0.6.2 - released at 13.09.2015
  • stabalized dependencies
• 0.6.1 - released at 12.09.2015
  • added protected getIdGenerator, getLockableWriterFactory, getReaderFactory and getStorage methods to easy up creating your own storage by using the default factory
• 0.6.0 - released at 12.09.2015
  • fixed issue in readMany if limit is used
• 0.5.0 - released at 12.09.2015
  • added example has
  • added method has($atLeast = 1, $atMost = null)
  • added optional argument resetRuntimeProperties (filters and limit settings) to create, readMany, readOne, update and delete
• 0.4.1 - released at 11.09.2015
  • adapted to new Experiment from toolbox
• 0.4.0 - released at 11.09.2015
  • moved code into directories (Storage and IdGenerator)
  • renamed Repository to Storage
• 0.3.4 - released at 10.09.2015
  • fixed issue in LockableWriterForPhp5Dot3
• 0.3.3 - released at 10.09.2015
  • fixed issue in LockableWriterForPhp5Dot3
• 0.3.2 - released at 10.09.2015
  • fixed issue when dealing with php 5.3
• 0.3.1 - released at 10.09.2015
  • fixed broken unit test
• 0.3.0 - released at 10.09.2015
  • created and used own LockableWriter to switch from "FileNameLock" to "FileHandlerLock"

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if use it. Make a donation if you love it :-].