Download the PHP package gp/dbms without Composer

GP DBMS Library

The GP DBMS Library is a database management system written in PHP. It provides tools for interacting with databases, managing models, querying data, and handling relationships. The library is designed to make database interaction easier and more efficient.

Table of Contents

• Requirements
• Installation
• Getting Started
• Features
• Classes
  • DBQuery
  • Database
  • Model
  • Events
• Usage
  • Frame Queries
  • Select Query
  • Insert Query
  • Update Query
  • Delete Query
  • Running Queries
  • Transaction Management
  • Creating custom DB Driver
  • Creating an ORM Model
  • Performing CRUD Operations with ORM Model
  • Handling Relationships
  • Creating Event
  • Creating and Loading ORM Models with Relations
• Example
• Contributing
• License
• Contact
• Author

Requirements

• PHP 7.4 or higher.
• Composer (optional but recommended for autoloading).

Installation

You can install gp_dbms using Composer. Run the following command in your terminal:

Getting Started

After installation, you can start using the package by including the autoloader:

Features

• Flexible Database Connections: Supports multiple database drivers like PDO and mysqli.

• Query Builder: Easily create and execute SQL queries with chaining methods.

  • Query Building

    • Select: Supports selecting specific columns or all columns.
    • Insert: Allows inserting data with direct values and function-based values.
    • Update: Updates data with field-value pairs and optional conditions.
    • Delete: Deletes rows from a table with optional conditions.
  • Where Conditions
    • AND and OR conditions can be applied using the where() and orWhere() methods.
    • Supports single conditions, array-based conditions, and parameterized conditions.
  • Joins
    • Supports INNER JOIN.
  • Ordering and Limiting
    • Sorting via orderBy() method.
    • Limiting rows with limit() method.
  • Query Resetting
    • Resets the query state using reset() or _resetQuery().
  • Query Execution Helpers
    • Builds the query string using getQuery().
    • Provides bind values for prepared statements with getBindValues().
  • Extensibility
    • The DBQuery class is designed to be extended by database-specific drivers. For instance:
• Object-Relational Mapping (ORM): Map tables to PHP classes for seamless data manipulation.
• Relationships: Handle HasOne and HasMany relationships with lazy and eager loading.
• Eager & Lazy Loading: Supports Eager and lazy loading.
• Lifecycle Events: Trigger hooks like onSave, onDelete, and onUpdate for models.
• Exception Handling: Provides meaningful error messages through DatabaseException.
• Transaction Support: Execute operations within transactions with commit/rollback capabilities.
• Extensibility: Extend models and relationships to customize functionality as needed.

Clasess

DBQuery

The DBQuery class is a versatile and extensible query builder designed for database operations. It provides methods to build SELECT, INSERT, UPDATE, and DELETE queries with various features like joins, where conditions, ordering, grouping, and more. This class is meant to be extended by specific database drivers.

Methods Documentation

Notes

• All queries are parameterized to prevent SQL injection.
• Ensure proper handling of bind values in the database execution layer.
• Extend this class to add database-specific functionality as needed.

Database

The Database class is an abstract superclass designed to serve as the base for all database-related operations. It provides foundational methods for query building, query execution, and transaction management across various database drivers. All driver-specific classes should extend this class and implement the abstract methods to provide database-specific functionality.

Methods Documentation

Abstract Methods (To Be Implemented by Drivers)

Properties

Notes

• Error Handling: The DatabaseException is thrown for invalid method calls or query errors.
• Extensibility: Extend this class to implement database driver-specific functionality.

• Security: All queries should use parameterized statements to prevent SQL injection.

Model

The Model class is an abstract base class for all database models. It provides methods for common ORM operations such as creating, reading, updating, and deleting records. It also includes support for handling relationships through HasMany and HasOne relations.

• HasMany - The HasMany class represents a one-to-many relationship between two models. For example, a User model can have many Post models.
• HasOne - The HasOne class represents a one-to-one relationship between two models. For example, a User model might have one Profile model.

Methods Documentation

Notes

• Extensibility: Override getTableName and getUniqueKey to customize table names and primary keys.
• Events: Use event hooks to add custom logic during save, update, insert, or delete operations.
• Lazy vs Eager Loading: Use lazy loading for on-demand related data and eager loading for preloading related models.

Events

The Events class in the ORM system is an abstract class that defines constants for various lifecycle events and provides a mechanism for handling these events. It is primarily used to trigger specific actions during the lifecycle of a model, such as before or after saving, deleting, loading, inserting, or updating.

Methods Documentation

Usage

FrameQueries

Select Query

Insert Query

Update Query

Delete Query

Running Queries

Transaction Management

Creating custom DB Driver

Creating an ORM Model

Performing CRUD Operations with ORM Model

Handling Relationships

HasMany

HasOne

Creating Event

Creating and Loading ORM Models with Relations

Example

Contributing

Contributions are welcome! If you would like to contribute to gp_validator, please follow these steps:

• Fork the repository.
• Create a new branch (git checkout -b feature/- YourFeature).
• Make your changes and commit them (git commit -m 'Add some feature').
• Push to the branch (git push origin feature/YourFeature).
• Open a pull request.
• Please ensure that your code adheres to the coding standards and includes appropriate tests.

License

This package is licensed under the MIT License. See the LICENSE file for more information.

Contact

For questions or issues, please reach out to the development team or open a ticket.

Author

• Periyandavar Github ([email protected])