README

ASLinkORM is a lightweight Object-Relational Mapping (ORM) library that allows you to interact with your database using object-oriented models. This library is designed to simplify the process of managing database records and relationships in your PHP application.

Installation

Use Composer

Composer Require

composer require alphasoft-fr/aslink-orm

Requirements

PHP version 8.2

Introduction

ASLinkORM - Manage your SQL data with simplicity and flexibility.

ASLinkORM is an Object-Relational Mapping (ORM) solution designed to address a specific need that has emerged in modern projects. In many cases, projects inherit existing databases that were created without the use of an ORM. However, with the rise of frameworks like Symfony, which advocate for the use of the Doctrine ORM, challenges arose when integrating these pre-existing databases into Symfony projects.

Utilizing the Doctrine ORM for such databases posed difficulties. It involved manually creating numerous entities, mapping columns to entity properties, managing database migrations, and other labor-intensive tasks. Furthermore, this approach imposed constraints and limited flexibility in data management.

To tackle these challenges, we conceptualized ASLinkORM, a bespoke ORM that aims to simplify SQL data management while offering significant flexibility. The goal was to craft an ORM that could seamlessly integrate into existing projects based on Symfony or similar frameworks, without the hassle of re-creating entities or complex migrations.

ASLinkORM stands out with its user-friendliness and its ability to work with existing databases without imposing heavy configuration overhead. It provides a more fluid approach to data mapping, enabling developers to manage relationships between entities and tables intuitively. Moreover, it provides a flexible alternative to database migrations, granting developers control over these processes.

Throughout this guide, we will delve into the intricate features of ASLinkORM, demonstrating how to integrate it into your projects, and how it can streamline your SQL data management while offering the necessary adaptability to cater to your specific needs.

ASLinkORM leverages the powerful capabilities of Doctrine DBAL for efficient SQL data management.

Getting Started

To get started with ASLinkORM , you need to follow these steps:

Initialize the DoctrineManager: In your application's entry point, initialize the DoctrineManager with your database configuration. Make sure to adjust the configuration according to your database setup.

use AlphaSoft\AsLinkOrm\EntityManager;

$config = [
     'url' => 'mysql://username:password@localhost/db_name',
     // ... other options
 ];

 $manager = new EntityManager($config);

Create Repositories: Create repository classes for your models by extending the Repository base class. Define the table name, model name, and selectable fields.

use AlphaSoft\AsLinkOrm\Repository\Repository;

class UserRepository extends Repository
{
    public function getTableName(): string
    {
        return 'user'; // Name of the associated table
    }
    
    public function getModelName(): string
    {
        return User::class; // Fully qualified name of the model class
    }
    
    // Additional methods for custom queries
}

Create Models: Create model classes by extending the HasEntity base class. Define relationships and any custom methods you need.

use AlphaSoft\AsLinkOrm\Relation\HasEntity;

class User extends HasEntity 
{
    static protected function columnsMapping(): array
    {
        return [
            new \AlphaSoft\AsLinkOrm\Mapping\PrimaryKeyColumn('id'),
            new \AlphaSoft\AsLinkOrm\Mapping\Column('firstname'),
            new \AlphaSoft\AsLinkOrm\Mapping\Column('lastname'),
            new \AlphaSoft\AsLinkOrm\Mapping\Column('email'),
            new \AlphaSoft\AsLinkOrm\Mapping\Column('password'),
            new \AlphaSoft\AsLinkOrm\Mapping\Column('isActive', false, 'is_active'),
        ];
    }

    static public function getRepositoryName(): string
    {
        return UserRepository::class;
    }

    public function getPosts(): \SplObjectStorage
    {
        return $this->hasMany(Post::class, ['user_id' => $this->getPrimaryKeyValue()]);
    }
}

Accessing Repositories

In ASLinkORM , repositories serve as gateways to access and manipulate data in the underlying database tables. To access a repository, you can use the DoctrineManager instance that you've set up. Here's how you can retrieve a repository using the manager:

use Your\Namespace\DoctrineManager;
use Your\Namespace\Repository\UserRepository;

// Assuming you have a configured DoctrineManager instance
$manager = new DoctrineManager(/* configuration options */);

// Retrieving a UserRepository instance
$userRepository = $manager->getRepository(UserRepository::class);

In this example, you create a DoctrineManager instance and then use it to retrieve a UserRepository instance. You can replace UserRepository with the name of any repository class you've defined.

Basic Operations

Here are some examples of basic operations you can perform using ASLinkORM:

Inserting Records

use Your\Namespace\User;

$user = new User([
    'firstname' => 'John',
    'lastname' => 'Doe',
    'email' => 'john@example.com',
    'isActive' => true,
]);

$userRepository->insert($user);

Finding Records

$user = $userRepository->findOneBy(['id' => 1]);

Updating Records

$user = $userRepository->findOneBy(['id' => 1]);

$user->set('firstname', 'UpdatedName');
$userRepository->update($user);

Deleting Records

$user = $userRepository->findOneBy(['id' => 1]);

$userRepository->delete($user);

Retrieving Data from Models

In your framework, you can retrieve data from models using various methods. The primary method is the get method, which allows you to access an attribute's value by specifying its name.

$user = new User();
$user->set('firstname', 'John');
$firstname = $user->get('firstname'); // Retrieves 'John'

If the specified attribute doesn't exist in the model, it will throw an InvalidArgumentException.

Using `getOrNull` for Safe Retrieval

To safely retrieve data without triggering an exception, you can use the getOrNull method, which returns the value of the attribute if it exists or null if it doesn't.

$lastname = $user->getOrNull('lastname'); // Retrieves 'null'

Type-Specific Retrieval

You can also retrieve attribute values with specific data types using dedicated methods. These methods provide type-checking and do not allow for default values when the property is not defined or if the value is of the wrong type.

getString retrieves a string value.

$lastname = $user->getString('lastname', 'Doe'); // Retrieves 'Doe' if 'lastname' exists and is a string

getInt retrieves an integer value.

$age = $user->getInt('age', 25); // Retrieves 25 if 'age' exists and is an integer

getFloat retrieves a floating-point value.

$price = $product->getFloat('price', 0.0); // Retrieves 0.0 if 'price' exists and is a float

getBool retrieves a boolean value.

$isActive = $user->getBool('isActive', false); // Retrieves false if 'isActive' exists and is a boolean

getArray retrieves an array.

$tags = $post->getArray('tags', []); // Retrieves an empty array if 'tags' exists and is an array

getInstanceOf retrieves an instance of a specified class, or null if it exists and is an instance of the specified class.

$profile = $user->getInstanceOf('profile', Profile::class); // Retrieves an instance of Profile or null if 'profile' exists and is an instance of Profile

getDateTime retrieves a DateTimeInterface instance, optionally specifying a format for parsing.

$createdAt = $post->getDateTime('created_at', 'Y-m-d H:i:s'); // Retrieves a DateTimeInterface instance or null if 'created_at' exists and is convertible to a valid date

Please note that these methods will throw exceptions if the property is not defined or if the value is of the wrong type. If you want to allow default values, you can use the previous examples with default values, but they will not throw exceptions in those cases.

Relationships

ASLinkORM extends its capabilities by enabling you to define and manage relationships between models. By extending the HasEntity class, you can easily establish relationships that allow you to navigate and interact with associated data.

Defining Relationships

The HasEntity class offers two methods, hasOne and hasMany, which facilitate relationship management. Let's explore these methods using examples:

`hasOne` Method

The hasOne method establishes a one-to-one relationship between the current model and another related model. Here's an example of how you might use it:

use AlphaSoft\AsLinkOrm\Entity\AsEntity;

class User extends AsEntity
{
    // ... (other code)
    
    public function getProfile(): ?Profile
    {
        return $this->hasOne(Profile::class, ['user_id' => $this->getPrimaryKeyValue()]);
    }
}

In this scenario, the getProfile method sets up a one-to-one relationship between the User model and the Profile model. It returns a single Profile instance associated with the user.

`hasMany` Method

The hasMany method establishes a one-to-many relationship between the current model and another related model. Consider this example:

use AlphaSoft\AsLinkOrm\Entity\AsEntity;

class User extends AsEntity
{
    // ... (other code)
    
    public function getPosts(): \SplObjectStorage
    {
        return $this->hasMany(Post::class, ['user_id' => $this->getPrimaryKeyValue()]);
    }
}

In this illustration, the getPosts method sets up a one-to-many relationship between the User model and the Post model. It returns an SplObjectStorage containing all posts associated with the user.

Navigating Relationships

After defining relationships, you can seamlessly navigate through your data graph. Here's an example of how you can utilize the established relationships to retrieve associated data:

$user = $userRepository->findOneBy(['id' => 1]);

// Retrieve the user's profile
$profile = $user->getProfile();

// Retrieve all posts associated with the user
$posts = $user->getPosts();

foreach ($posts as $post) {
    // Access post attributes
    $title = $post->get('title');
    $content = $post->get('content');
    // ... (other operations)
}

By leveraging the hasOne and hasMany methods, you can efficiently retrieve and manipulate associated data, making your data interactions more intuitive and effective.

Defining Column Mappings

ASLinkORM provides the ability to define column mappings for your models, giving you flexibility in managing your data.

`columnsMapping()`

The Column object is used within the columnsMapping() method to define how model attributes correspond to database columns. It allows you to specify a default value and an optional database column name if it differs from the attribute name in the model.

use AlphaSoft\AsLinkOrm\Mapping\Column;

$column1 = new Column('firstname'); // Basic usage, no specific column name specified
$column2 = new Column('lastname', 'Doe'); // Specifying a default value
$column3 = new Column('email', null, 'user_email'); // Specifying a custom database column name

The columnsMapping() method serves a dual purpose: it defines the column name mappings for attributes of the model, allowing you to specify which columns to search for during SELECT operations, as well as enabling you to set default values for these attributes.

The columnsMapping() method should always include the PrimaryKeyColumn object, which is essential for identifying the unique column used to search for an element in the database. There should be only one PrimaryKeyColumn object defined in the columnsMapping() method.

static protected function columnsMapping(): array
{
    return [
        new PrimaryKeyColumn('id'),
        new Column('firstname'),
        new Column('lastname'),
        new Column('email'),
        new Column('password'),
        new Column('isActive', false, 'is_active'),
    ];
}

In this example, the attribute isActive in the User model corresponds to the column name is_active in the database table. When fetching or inserting data, the ORM will automatically map the attribute names to the appropriate column names using the defined mappings.

For instance, when you insert a new User instance:

$user = new User([
    'firstname' => 'John',
    'lastname' => 'Doe',
    'isActive' => true,
]);
$userRepository->insert($user);

The columnsMapping() method is essential as it defines the column name mappings for the model's attributes. This mapping is necessary because it specifies how the model's attributes correspond to the columns in the database table. By default, the ORM will attempt to associate each attribute with a column of the same name in the database. However, in cases where the attribute name in the model differs from the corresponding database column name, the Column object can be used to specify custom mappings, as demonstrated in the example: new Column('isActive', false, 'is_active').

Sure, here's an additional section for persistence, removal, and flushing:

Persistence, Removal, and Flushing

ASLinkORM provides methods for persisting entities, removing entities, and flushing changes to the underlying database. These methods are essential for managing the lifecycle of entities and ensuring that changes are properly synchronized with the database.

Persistence

The persist method allows you to mark an entity for insertion into the database. When you call persist on an entity, ASLinkORM tracks it and includes it in the flush operation later.

use AlphaSoft\AsLinkOrm\Entity\AsEntity;

// Assuming $entityManager is an instance of EntityManager
$user = new User([
    'firstname' => 'John',
    'lastname' => 'Doe',
    'email' => 'john@example.com',
]);

$entityManager->persist($user);

Removal

The remove method allows you to mark an entity for removal from the database. When you call remove on an entity, ASLinkORM tracks it and includes it in the flush operation later.

use AlphaSoft\AsLinkOrm\Entity\AsEntity;

// Assuming $entityManager is an instance of EntityManager
$user = $userRepository->findOneBy(['id' => 1]);

$entityManager->remove($user);

Flushing

The flush method synchronizes changes made to tracked entities with the underlying database. It executes pending insertions, updates, and deletions, ensuring that the database reflects the current state of the entities.

use AlphaSoft\AsLinkOrm\EntityManager;

// Assuming $entityManager is an instance of EntityManager
$entityManager->flush();

By using these methods, you can manage the persistence and removal of entities in your application, ensuring that changes are properly synchronized with the database.

Now, developers can leverage these methods to effectively manage entity lifecycle and ensure data integrity within their applications.

Feel free to incorporate this section into your README to provide comprehensive guidance on working with ASLinkORM.

Debugging SQL Queries

SqlDebugger is a handy utility class included within the EntityManager of AsLinkORM. It allows developers to debug SQL queries executed by their application easily. While interacting with the EntityManager, developers can access the SqlDebugger to gain insights into query execution times and parameters, aiding in the identification and resolution of database-related issues.

Accessing SqlDebugger

Developers can access the SqlDebugger for debugging purposes through the EntityManager class. Once the EntityManager is instantiated, the SqlDebugger instance associated with it can be retrieved using the getConnection() method.

use AlphaSoft\AsLinkOrm\EntityManager;

// Instantiate the EntityManager with database parameters
$entityManager = new EntityManager($params);

// Retrieve the SqlDebugger instance
$sqlDebugger = $entityManager->getConnection()->getSqlDebugger();

Once the SqlDebugger instance is obtained, developers can utilize its methods to retrieve information about executed SQL queries and their execution times.

Example Usage

use AlphaSoft\AsLinkOrm\EntityManager;

// Instantiate the EntityManager with database parameters
$entityManager = new EntityManager($params);

// Retrieve the SqlDebugger instance
$sqlDebugger = $entityManager->getConnection()->getSqlDebugger();

// Execute SQL queries using EntityManager
// ...

// Retrieve and display debug information
$queries = $sqlDebugger->getQueries();

foreach ($queries as $queryInfo) {
    echo "Query: " . $queryInfo['query'] . "\n";
    echo "Parameters: " . implode(', ', $queryInfo['params']) . "\n";
    echo "Execution Time: " . $queryInfo['executionTime'] . " seconds\n";
    echo "\n";
}

By following these steps, developers can effectively debug SQL queries within their applications using the integrated SqlDebugger class provided by AsLinkORM.

Contributing

If you'd like to contribute to ASLinkORM , feel free to open pull requests and issues on the GitHub repository.

License

ASLinkORM is open-source software licensed under the MIT License.

alphasoft-fr / aslinkorm

Maintainers

Details

README

Installation

Composer Require

Requirements

Introduction

Getting Started

Accessing Repositories

Basic Operations

Inserting Records

Finding Records

Updating Records

Deleting Records

Retrieving Data from Models

Using `getOrNull` for Safe Retrieval

Type-Specific Retrieval

Relationships

Defining Relationships

`hasOne` Method

`hasMany` Method

Navigating Relationships

Defining Column Mappings

`columnsMapping()`

Persistence, Removal, and Flushing

Persistence

Removal

Flushing

Debugging SQL Queries

Accessing SqlDebugger

Example Usage

Contributing

License

alphasoft-fr / aslinkorm

Maintainers

Details

README

Installation

Composer Require

Requirements

Introduction

Getting Started

Accessing Repositories

Basic Operations

Inserting Records

Finding Records

Updating Records

Deleting Records

Retrieving Data from Models

Using getOrNull for Safe Retrieval

Type-Specific Retrieval

Relationships

Defining Relationships

hasOne Method

hasMany Method

Navigating Relationships

Defining Column Mappings

columnsMapping()

Persistence, Removal, and Flushing

Persistence

Removal

Flushing

Debugging SQL Queries

Accessing SqlDebugger

Example Usage

Contributing

License

Using `getOrNull` for Safe Retrieval

`hasOne` Method

`hasMany` Method

`columnsMapping()`