administrador.base.orm.inicializacion.init_params - gamboamartin/administrador GitHub Wiki

init_params

La función init_params inicializa un conjunto de parámetros estándar dentro de un objeto stdClass llamado $complemento. Crea una nueva propiedad params dentro de $complemento, que contiene los parámetros comúnmente utilizados en consultas SQL como offset, group_by, order, y limit, todos ellos inicializados como cadenas vacías. Esta función garantiza que el objeto $complemento esté preparado para construir consultas SQL con estos parámetros.

Signatura

private function init_params(stdClass $complemento): stdClass

Parámetros

`stdClass $complemento`

Tipo: stdClass
Descripción: El objeto que será modificado. La función añadirá una propiedad params a este objeto, que contendrá los parámetros SQL básicos inicializados como cadenas vacías.

Retorno

`stdClass`

Tipo: stdClass
Descripción: Devuelve el objeto $complemento modificado, con la propiedad params que incluye los parámetros offset, group_by, order, y limit, todos inicializados como cadenas vacías.

Explicación Detallada

Inicialización de la propiedad params:
- La función crea una nueva propiedad llamada params dentro del objeto $complemento, la cual es un nuevo objeto stdClass.
```
$complemento->params = new stdClass();
```
Inicialización de los parámetros SQL:
- Se inicializan las siguientes propiedades dentro de params:
  - offset: Representa el desplazamiento de los resultados en una consulta SQL. Inicializado como una cadena vacía.
  - group_by: Representa la cláusula GROUP BY de una consulta SQL. Inicializado como una cadena vacía.
  - order: Representa la cláusula ORDER BY de una consulta SQL. Inicializado como una cadena vacía.
  - limit: Representa el límite de filas en una consulta SQL. Inicializado como una cadena vacía.
```
$complemento->params->offset = '';
$complemento->params->group_by = '';
$complemento->params->order = '';
$complemento->params->limit = '';
```
Retorno del objeto modificado:
- Al final, la función devuelve el objeto $complemento con la propiedad params completamente inicializada.

Ejemplos

$complemento = new stdClass();
$complemento = $this->init_params($complemento);

// Resultado esperado:
// $complemento->params->offset = '';
// $complemento->params->group_by = '';
// $complemento->params->order = '';
// $complemento->params->limit = '';

Código de la Función

private function init_params(stdClass $complemento): stdClass
    {
        $complemento->params = new stdClass();
        $complemento->params->offset = '';
        $complemento->params->group_by = '';
        $complemento->params->order = '';
        $complemento->params->limit = '';
        return $complemento;
    }