Download the PHP package rougin/credo without Composer

Credo

Credo is a wrapper package of Doctrine ORM for Codeigniter 3. Its implementation was created based on the official integration for Codeigniter 3 to the Doctrine ORM package.

Installation

Install Credo via Composer:

Basic Usage

Create a sample database table first to be used in this example (e.g., users):

Then configure the composer_autoload option in config.php:

[!NOTE] The value of composer_autoload should be the vendor directory (e.g., ciacme/vendor/autoload.php).

Next is to create an entity that conforms to the documentation of Doctrine ORM (e.g., User):

Once the entity is created, it can now be used to perform operations using the Credo::getRepository:

Using Rougin\Credo\Repository

To enable this package on a Codeigniter 3 project, create a MY_Loader class first in the core directory then extend the newly created class to Rougin\Credo\Loader:

Next is create a custom entity repository with a _repository suffix in the class name (e.g., User_repository):

Once the custom repository is created (e.g., User_repository), add the repositoryClass property inside the @Entity annotation of the specified entity to attach the said custom repository:

Then load the specified repository using $this->load->repository:

[!NOTE] It is encouraged to check the documentation about Doctrine ORM first for more information about its design pattern and its various usage on existing projects.

Using ~3.0 version of Doctrine ORM

Credo should be able to support the latest version of Doctrine ORM (~3.0). To use the latest version, the code must be slightly updated:

Using this approach allows to use the latest improvements provided by Doctrine ORM like using the native attributes introduced in PHP v8.1:

[!TIP] Please see the Getting Started documentation of Doctrine ORM on how to initialize an EntityManager in the latest version.

Using Rougin\Credo\Model

The Model class enables the specified entity to perform CRUD operations without relying on a repository:

The Model class contains methods for performing CRUD operations which are based both on the Query Builder class of Codeigniter 3 and the EntityManager of Doctrine ORM.

[!WARNING] This may be used for getting started to use the models directly without a repository. However, this will be against the principle of Unit of Work pattern by Doctrine ORM (e.g., using the entity class instead of an array in updating its data). With this, using an entity repository is highly encouraged.

Using Traits

Credo provides traits that are based from the libraries of Codeigniter 3 such as Form Validation and Pagination Class. They are used to easily attach the specified functionalities of Codeigniter 3 to a model.

PaginateTrait

The PaginateTrait is used to easily create pagination links within the model:

The $result[0] returns the computed offset while $result[1] returns the generated pagination links:

To configure the pagination library, the $pagee property must be defined in the Model:

[!NOTE] Please see the documentation of Pagination Class to get the list of its available configuration.

ValidateTrait

This trait is used to simplify the specifying of validation rules to a model:

When used, the $rules property of the model must be defined with validation rules that conforms to the Form Validation specification:

[!NOTE] Kindly check its documentation for the available rules that can be used to the $rules property.

To do a form validation, the validate method must be called from the model:

If executed with a view, the validation errors can be automatically be returned to the view using the form_error helper:

Migrating to the v0.5.0 release

The new release for v0.5.0 will be having a backward compatibility break (BC break). With this, some functionalities from the earlier versions might not be working after upgrading. This was done to increase the maintainability of the project while also adhering to the functionalities for both Codeigniter 3 and Doctrine ORM. Please see the UPGRADING page for the said breaking changes.

[!TIP] If still using the v0.4.0 release, kindly click its documentation below: https://github.com/rougin/credo/blob/v0.4.0/README.md

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

Credits

• All contributors

License

The MIT License (MIT). Please see LICENSE for more information.