Estructura/Organización de Clases del Negocio

De CidesaWiki

Dentro de Siga el código fuente de la lógica del negocio esta separado del controlador y la vista, lo que llamamos el modelo. Este modelo se encuentra en la carpeta "lib" de nuestro proyecto, y esta organizado de la siguiente forma:

La carpeta "Lib" es raíz del proyecto y dentro esta toda la información del modelo de datos. Allí podrás encontrar las siguientes carpetas:

• Helper: Aquí están y se colocan los los Helpers (o ayudantes) adicionales (creados para el proyecto) para objetos o funcionalidades de la vista, por ejemplo encontraras un helper para llamar a catálogos o Grids. Si se quiere crear un helper se debe hacer en esta carpeta, y se debe seguir la metodología de los otros helper.

• model: Aqui se encuentran las clases de conexion con cada tabla de la base de datos, junto que sus clases bases. Estas clases son generadas automaticamente en base a un esquema de la base de datos a través de la funcionalidad "propel" que contiene symfony.

• Business: En esta carpeta estan organziadas las clases del manejo del negecio. Aqui se debe colocar todo el código que tenga que ver con procesos del negocio. Esta carpeta tentativamente tiene la siguiente organziación:

------- compras
------- bienes
------- formulacion
------- ingresos
------- nomina
------- obras
------- tesoreria
------- .....

Cada una de estas carpetas contiene las clases de cada uno de las aplicaciones.

Por ejemplo dentro de la carpeta "compras" existen las siguientes clases:

------- compras
-----------Articulos.class.php
-----------Compras.class.php

Estas 2 clases contienen funcionalidades específicas de estos conceptos. por ejemplo la clase Articulos contiene:

class Articulos
{
        // Funcion para el formulario "Almregart"
	public static function validarAlmregart($articulo)
	{
        }

        // Funcion para el formulario "Almregart"
	public static function salvarAlmregart($articulo,$grid)
        {
            self::Grabar_Articulo($articulo,$grid);		
        }

        // Funcion para el formulario "Almregart"
	public static function Grabar_Articulo($articulo,$grid)
	{	
            // Se graba el Artículo		
            $articulo->save();
			
            // Se graban los almacenes del articulo
            self::Grabar_ArticulosAlmacen($articulo,$grid);

	}
	
        // Funcion para el formulario "Almregart"
	public static function Grabar_ArticulosAlmacen($articulo,$grid)
	{ 
            ......
	} 



	    
        // Funcion para validar el formato del código del artículo
	public static function validarCodart($articulo)

	{

	}

}

Estructura de las clases del Negocio

Tomando como ejemplo la estructura de la clase "Artículos" expuesta anteriormente, tenemos lo siguiente:

• Cada formulario (llamese Almregart) debe estar ligado a un concepto de las clases del negocio; por ejemplo código que tienen que ver con el negocio del formulario "Almregart" de registro de artículos, debe estar en esta clase debido a su manejo del concepto de artículo.

• Luego de identificar el concepto base del formulario debemos colocar las funciones básicas necesarias para el trabajo del formulario, las cuales son:

• validarFormName: Donde "FormName" es el nombre del formulario con el que trabajaremos. Este método estático de la clase "Articulos" se encargará de verificar o validar del lado del servidor los datos que introdujo el usuario, antes de guardarlos o pasar al método de "salvar" datos. Los parámetros de esta función van a depender de los datos que se necesiten validar. Esta función es llamada desde el controlador, donde se colocan los datos de la vista.

• salvarFormName: Donde "FormName" es el nombre del formulario con el que trabajaremos. Este método se ejecuta despues del validar (si todo esta bien) y permite ejecutar el código del negocio necesario para guardar los datos introducidos por el usuario en la vista. Se supone que aqui solo debemos guardar los datos como deben ser guardados en la base de datos, ya que en la función validarFormName ya verificamos la integridad de los mismo.