Skip to content

Latest commit

 

History

History
163 lines (98 loc) · 7.56 KB

CHANGELOG.md

File metadata and controls

163 lines (98 loc) · 7.56 KB
Raw

Parable PHP ORM

1.0.0

Version 1.0.0 is here!

Changes

  • Upgraded parable-php/di and parable-php/query to 1.0.0 as well.
  • Database now accepts constructor values for quicker setup. See Database::__construct() or check the README.
  • README updated to show how to actually connect to a database 🤦

0.11.1

  • Upgrade parable-php/query to 0.5.0.

0.11.0

  • Added static analysis through psalm.
  • Renamed Exception to OrmException for clarity.

0.10.0

Changes

  • Dropped support for php7, php8 only from now on.

0.9.2

  • MySQL no longer requires a database name to establish a connection.

0.9.1

  • When using typed properties and trying to set a value of '0', untyping it caused it to become a string value. This would end up being seen as an 'empty' value and removed from the value set.

0.9.0

  • Transaction has been added. Now you can start, commit or roll back a transaction very easily. Simply call Transaction::begin(), Transaction::commit() or Transaction::rollback().
  • And to make it even easier, call Transaction::withTransaction(callable $callable) to have it all done automatically. Exceptions thrown are rethrown, and the return value of the callable is returned by withTransaction().
  • PropertyTypeDeterminer has been reworked, and now uses distinct Typer classes (such as IntegerPropertyTyper), implementing the PropertyTyper interface.
  • BooleanPropertyTyper has been added, which can turn 1 and 0 into true and false respectively.
  • Adding custom typers is easy, see CustomPropertyTyper in the tests. This way, you can transform from/to any object or value type to what the database can store, without having to care.
  • Database::getLastQuery() now returns the last query attempted to be performed, rather than the last successful.
  • Fixed wrong logic in AbstractRepository::countAll() and AbstractRepository::countBy() (that should not have caused issues).

0.8.2

Bugfixes

  • Fix bug in toArrayWithoutEmptyValues() where a value of 0 would be seen as an empty value.

0.8.1

Changes

0.8.0

Changes

  • Massive simplification. Removed MysqlConnection and SqliteConnection, simply returning PDO instances instead.
  • It's now possible to call Database::setConnectionClass(string $connectionClass) and set a custom connection class. This class must extend PDO.
  • Database::setType() now accepts any int value, and will only throw an exception upon trying to connect.
  • Due to custom connection classes, code coverage of tests has risen to 100%. Just a nice little bonus.

Bugfixes

  • One instance where the primary key is set was not being typed. This caused issues when, for example, a getId(): int would attempt to return a string value as set directly from the database.

0.7.0

Changes

  • Time for more type casting! By implementing HasTypedProperties and the function getPropertyType(string $property): ?int, you can optionally allow value type casting from and to the database. Supported types are defined on PropertyTypeDeterminer as TYPE_INT, TYPE_DATE, TYPE_TIME and TYPE_DATETIME. The last three will return a DateTimeImmutable instance. The formats of DATE_SQL, DATE_TIME, DATETIME_SQL are forced for these.
    • These are cast TO these types after retrieving from the database. This allows, for example, type hinting the setter for created at: setCreatedAt(DateTimeImmutable $createdAt) and the getter: getCreatedAt(): DateTimeImmutable.
    • These are transformed back to string values before saving, because toArray() does so.
  • PropertyTypeDeterminer offers two static methods (typeProperty and untypeProperty) which will attempt to type, if required, the passed property and value on the entity.
  • New instances of entities are now built using the DI Container. This allows DI to be used in entities if you so wish.

0.6.1

Changes

  • AbstractEntity::toArrayWithout(string ...$keys) will allow you to get an array representation of an entity without the specified keys.
  • AbstractEntity::hasBeenMarkedAsOriginal() has been added, and can be used to determine whether it was loaded from the database or just saved.
  • AbstractRepository::isStored() is now available, and will tell you if the ORM thinks the entity has been stored.

0.6.0

And we're back to no casting whatsoever. 0.5.0 was intended to be a first step to more complete type casting for values, but it became clear the functionality wasn't going where it needed to go.

So, placing the responsibility back at the implementation where I now believe it lies. The other improvements from 0.5.0 have been kept, however.

0.5.0

Major change

This update contains a handy change. The TypeCaster has been added. This will attempt to cast SQL-standard dates, times and datetimes to DateTimeImmutable objects, leaving everything else as string.

See TypeCasterTest for the test cases. In case there are scenarios in which the parsing does not go correctly, please open an issue or PR to add the scenario to the test cases.

It's possible to disable the TypeCaster by calling TypeCaster::disable() before doing any database retrievals. Enabling it again can be done by calling TypeCaster::enable().

Changes

  • Database::DATE_SQL and Database::TIME_SQL have been added.
  • setCreatedAt() and setUpdatedAt() have been removed from the feature interfaces. This leaves only the mark methods left, and leaves the implementation up to you.

0.4.1

Changes

  • AbstractRepository did not fail gracefully when instanced without a valid Database instance available in the DI Container. An active Database connection is not, however, required to instantiate a repository. It is, however, to use it. Now instantiating is possible, but attempting to use the repository will fail.

    See testCreateRepositorySuccessfulWithoutDatabaseButFailsOnPerformingAnything for specifics. Also, I'm super good at naming tests.

0.4.0

Changes

  • Database has gained multiple getters to make it easier to work with.

  • AbstractRepository now uses hasValueSets() rather than countValueSets() > 0.

  • Obsolete soft quoting setting removed, as it was never implemented here. Quoting is done in the parable-php/query package.

  • Implemented __debugInfo() on Database to prevent the password being leaked while being dumped.

    NOTE: This cannot prevent var_export usage. It is strongly suggested not to use var_export for logging purposes where an instance of Database may be logged.

0.3.0

Changes

  • Updated to parable-php/query 0.2.1, which offers OrderBy::asc(...$keys) and OrderBy::desc(...$keys), rather than using strings.

    Example usage: $repository->findAll(OrderBy::asc('id');.

0.2.1

Changes

  • Entities will no longer attempt to set values on new instances that are already null. This makes it possible to more strictly type setters.
  • Repositories gained a method: findUniqueBy($callable): AbstractEntity. It returns null on 0, the entity on 1 and throws on 1+.

0.2.0

Same as 0.1.2 but now without breaking changes in a major pre-release version.

0.1.3

Changes

Revert previous changes since the directory rename actually required a 0.2.0.

0.1.2

Changes

  • Renamed Traits directory to Features since they haven't been traits for a while.
  • Removed getCreatedAt() and getUpdatedAt() from the SupportsSomethingedAt features, since Parable ORM doesn't require them and you should choose how to expose them.

0.1.1

Changes

  • Remove some debug stuff.

0.1.0

Changes

  • First release.