Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maximo-perez-villalba/framework-dao-db

El proyecto implementa una extensión de framework-dao para base de datos a través de PDO con fines pedagógicos.
https://github.com/maximo-perez-villalba/framework-dao-db

crud dao dao-crud dao-design-pattern database oop pdo pdo-php php uml uml-class-diagram

Last synced: 25 days ago
JSON representation

El proyecto implementa una extensión de framework-dao para base de datos a través de PDO con fines pedagógicos.

Awesome Lists containing this project

README

        

# framework-dao-db
El proyecto implementa una extensión del framework `maximo-perez-villalba/framework-dao` para base de datos a través de PDO. Para ver el proyecto padre ir a [framework-dao](https://github.com/maximo-perez-villalba/framework-dao). Y aunque su fin principal es de apoyo pedagógico, la extensión es completamente funcional.

## Instalación
Se puede instalar `framework-dao-db` a través de Composer.

1 Desde una consola de comandos ir al directorio del proyecto y ejecutar:
```
composer require maximo-perez-villalba/framework-dao-db
```

2 También agregando en el archivo `composer.json`, dentro de la sección `"require"`.
```
"require": {
"maximo-perez-villalba/framework-dao-db": ">=1.0.0"
},
```
2.1 Luego desde una consola de comandos ejecutar:
```
composer update
```

## Documentación
### Extensión DAO para bases de datos (DAODB)
Esta extensión implementa a través de la [clase DAODB](/src/framework/dao/db/DAODB.php) el CRUD definido en la [clase DAO](https://github.com/maximo-perez-villalba/framework-dao/blob/main/src/framework/dao/DAO.php), para comunicarse con bases de datos a través de [PDO](https://www.php.net/manual/es/class.pdo) (PHP Data Object). A su vez la clase DAODB incorpora métodos específicos para la recuperación de datos desde la bases de datos.

![image:uml-class-daodb.png](/docs/uml-class-daodb.png)

El diagrama de clases muestra el diseño de implementación de la extensión DAODB, donde **los objetos de modelo** deben extender de la [clase PersistentDB](/src/framework/dao/db/PersistentDB.php). Esto implica que en la base de datos, las tablas que representan **los objetos de modelo** deben contener la columna `PRIMARY KEY` bajo el nombre `uid` y ser de tipo entero.

#### Implementación
Como DAODB es una clase abstracta es requerido crear una clase que la extienda para su implementación específica.

Con este fin creamos una clase que se llame Something que extienda de PersistentDB y su respectiva SomethingDAODB que extiende de DAODB.

![image:uml-class-something-daodb.png](/docs/uml-class-something-daodb.png)

El diagrama de clases muestra el diseño de implementación de la clase SomethingDAODB, donde expone los tres métodos requeridos para particularizar la persistencia en una base de datos de los objetos Something.

Estos 3 métodos son:
* **update():bool** definido en la clase DAO.
* **insert():bool** definido en la clase DAODB.
* **dataToObject(array):Something** definido en la clase DAODB.


#### Como se usa
```
dao();

// Para guardar una nueva instancia de la clase Something en la base de datos.
$daodb->create();

// También para guardar una nueva instancia de la clase Something en la base de datos, podemos usar el método insert (alias de create).
$daodb->insert();

// Para sincronizar los cambios de un objeto de modelo.
$daodb->update();

// Para borrar un objeto de modelo.
$daodb->delete();

// Para recuperar un objeto de modelo almacenado en formato objeto de la clase PersistentDB.
$something = SomethingDAODB::getObject( 'email = :email', [ ':email' => '[email protected]' ] );
$something = SomethingDAODB::getObjectByUid( 1234 );

// Para recuperar datos almacenados en formato mapa de arreglos.
$list = SomethingDAODB::read( 'codigo = :codigo', [':codigo'=>'anValue'] );

// Para recuperar objetos almacenados en formato mapa de objetos.
$list = SomethingDAODB::list( 'email LIKE :pattern', [ ':pattern' => '%@prueba.com' ] );
```