Storm - Still in development
Domain oriented ORM, crafted with passion for PHP 5.4+., (*1)
Storm is not finished, the foundation and architecture is there, but the codebase has almost no unit tests. Since storm was originally a learning exercise with the goal of creating an orm that does not influence the domain model, this project has maintained a good code quality, but it is quickly becoming apparent that I cannot single handedly develop and maintain this project, especially with school. Serious contributors are needed, please feel free to clone the repository and look around the code base, if you have any questions, inquiries or want to begin contributing please email me at: elliot@aanet.com.au., (*2)
Please be aware that this is my first large open source project, so any tips/recommendations are welcome., (*3)
Summary of the current state of Storm
The goals of Storm
What Storm is not
- The much loved active record pattern (although possible in the future).
- The answer to all your problems.
Storm - Flexible domain models
Storm aims to provide as little restriction to domain models as possible
- Storm natively supports: fields, getters/setters and even indexors or innvocation as entity properties.
- Your entities can remain completely unaware of Storm: no base class, no annotations and no persistence logic.
- Seamless identifying and non-identifying relationships between entities:
- Required child entity - A User has a Profile
- Optional child entity - A User may have a CreditCard
- Array/Traversable of many child entities - A User has multiple Posts, Traversable must be used for lazy loading, (*4)
Storm - PHP integerated query
- Code in terms of the domain, not your database (SQL).
- Abstract yourself from the underlying database.
- Maintain full IDE auto-completion.
- Remove the hassle of magic strings and prevent SQL injection.
Requests (SELECT) - Example:, (*5)
$MiddleAgedUsersRequest = $UserRepository->Request()
->Where(function (User $User) {
return $User->GetAge() > 20 && $User->GetAge() < 50 && $User->IsActive();
})
->OrderByDescending(function (User $User) { return $User->GetLastLoginDate(); })
->Limit(20)
->AsArray();
$SomeActiveMiddleAgedUsers = $UserRepository->Load($MiddleAgedUsersRequest);
Procedures (UPDATE) - Example:, (*6)
$InactiveUserProcedure = $UserRepository->Procedure(
function (User $User) {
$User->SetIsActive(false);
$User->SetInactivationDate(new DateTime());
})
->Where(function (User $User) {
return $User->GetLastLoginDate() < (new DateTime())->sub(new DateInterval('P2Y'));
});
$UserRepository->Execute($InactiveUserProcedure);
NOTE: The supplied functions never actually executed, they are parsed and then mapped to the underlying platform as queries., (*7)
Storm - Sensible querying
One main goal of Storm is to take advantage of the underlying database as much as possible.
- Storm will use batch inserts/upserts and deletes where possible.
- Elimination of the dreaded N+1 query scenario introduced by excessive lazy loading. With storm, there are currenlty multiple relationship loading implementations:
- Eager - Relationships are loaded along with the parent and children are joined where appropriate.
- SemiLazy - Relationships are not loaded with the parent entity but when one is required, globally every unloaded relationship will be loaded .
- Lazy (Recommended) - Relationships are loaded when required for all entities in the request object graph.
- ExtraLazy (N+1 likely) - Relationships are loaded when required from for each parent entity., (*8)
Example:, (*9)
User is the parent entity, a user has many posts and a post has an author and many tags.
Here is the typical N+1 scenario., (*10)
$User = $UserRepository->LoadById(1);
foreach($User->GetPosts() as $Post) {
$Post->GetAuthor()->GetFullName();
foreach($Post->GetTags() as $Tag) {
$Tag->GetName();
}
}
Now here is the number of queries executed for each loading mode (N=Number of Posts);
- Eager - 3 (the user | posts joined with the author | all tags), when the user is loaded.
- SemiLazy - For loading a single request this is equivalent to Lazy mode below.
- Lazy - 4 (the user | posts | all authors | all tags), the posts will be loaded when $User->GetPosts() is iterated and all the tags will be loaded when the first $Post->GetTags() is iterated.
- ExtraLazy - (N * 2) + 2 - (user | posts | each post's author | each post's tags)., (*11)
NOTE: Relationship loading mode is per-relationship, the above example assumes every relationship will have one loading mode for simplicity., (*12)
Wallogit.com
