Documentación GVHIDRA 3.1.5
Referencia de la Clase IgepRegistroSalida

Métodos públicos

 __construct ($vConBD, $vParams=null, $vIndexMatch=null)
 setValuesRegistro ($vParams, $vIndexMatch=null)
 setAnyo ($valor)
 setAsunto ($valor)
 setCodMun ($valor)
 setCodPro ($valor)
 setCP ($valor)
 setNombreDestinatario ($valor)
 setDireccionDestinatario ($valor)
 setUnidadRegistral ($valor)
 registrarSalida ()

Métodos privados

 _validar ()

Atributos privados

 $_conOracle
 $_error
 $_anyo
 $_asunto
 $_nombreDest
 $_codPro
 $_codMun
 $_direccionDest
 $_CPDest
 $_codUnidadOrigen
 $_codConselleriaOrigen
 $_codUnidadRegistral
 $_codOrganismoOrigen

Descripción detallada

IgepRegistroSalida: Clase que encapsula el acceso al registro de salida

La clase accede a la API de Oracle hasta que exista un WS

Autor:
David Pascual <pascual_dav@gva.es>

Definición en la línea 41 del archivo IgepRegistroSalida.php.


Documentación del constructor y destructor

__construct ( vConBD,
vParams = null,
vIndexMatch = null 
)

Registro::Recibe un array de conexiones activas (obligatoria la de oracle)

Parámetros:
array$vConBDconexin de oracle [oracle]

Definición en la línea 142 del archivo IgepRegistroSalida.php.

        {
                if (isset($vConBD))
                        $this->_conOracle = $vConBD;
                else
                        throw new InvalidArgumentException ("Registro::__construct La conexin pasada al constructor no es vlida");
                        
                $this->_anyo = null;
                $this->_asunto = null;
                $this->_codMun = null;
                $this->_codPro = null;
                $this->_CPDest = null;
                $this->_direccionDest = null;
                $this->_nombreDest = null;
                $this->_codUnidadOrigen = null;
                $this->_codConselleriaOrigen = null;
                $this->_codUnidadRegistral = null;
                $this->_codOrganismoOrigen = null;
                                
                
                if (($vParams != null) && (is_array($vParams)))
                {
                        $this->setValuesRegistro($vParams, $vIndexMatch);
                }
                
        }//registrarSalida

Documentación de las funciones miembro

_validar ( ) [private]

Registro::_validar valida que los atributos estn informados

Devuelve:
boolean devuelkve true si el registro es valido o false en caso contrario

Definición en la línea 344 del archivo IgepRegistroSalida.php.

        {
                $this->_error = null;
                $correcto = true;
                
                if (is_null($this->_anyo)) 
                {
                        $this->_error = "Falta informar el atributo 'ao'";
                        $correcto = false;
                }
                
                if (is_null($this->_asunto))
                {
                        $this->_error = "Falta informar el atributo 'asunto'";
                        $correcto = false;
                }
                
                if (is_null($this->_codMun))
                {
                        $this->_error = "Falta informar el atributo 'cdigo municipio'";
                        $correcto = false;
                }
                        
                if (is_null($this->_codPro))
                {
                        $this->_error = "Falta informar el atributo 'cdigo provincia'";
                        $correcto = false;
                }
                
                if (is_null($this->_CPDest))
                {
                        $this->_error = "Falta informar el atributo 'CP'";
                        $correcto = false;
                }
                
                if (is_null($this->_direccionDest))
                {
                        $this->_error = "Falta informar el atributo 'Direccin del destinatario'";
                        $correcto = false;
                }
                
                if (is_null($this->_nombreDest))
                {
                        $this->_error = "Falta informar el atributo 'Nombre completo del destinatario'";
                        $correcto = false;
                }
                
                if (is_null($this->_codUnidadOrigen))
                {
                        $this->_error = "Falta informar el atributo 'Cdigo de la Unidad Origen'";
                        $correcto = false;
                }
                
                if (is_null($this->_codConselleriaOrigen))
                {
                        $this->_error = "Falta informar el atributo 'Cdigo de la Conselleria Origen'";
                        $correcto = false;
                }       
                
                if (is_null($this->_codUnidadRegistral))
                {
                        $this->_error = "Falta informar el atributo 'Cdigo de la unidad Registral'";
                        $correcto = false;
                }
                
                
                if (is_null($this->_codOrganismoOrigen))
                {
                        $this->_error = "Falta informar el atributo 'Cdigo del organismo Origen'";
                        $correcto = false;
                }

                return $correcto;
        }//Fin _validar
registrarSalida ( )

Registro:registrarSalida Realiza el apunte en el registro de salida y devuelve el nmero de registro asignado a la accin registral

La funcin invoca un procedimeinto almacenado de Oracle (RS_API.API_REGISTROSALIDA_PHP) basado en la funcin Oracle RS_API.API_REGISTROSALIDA. De momento slo se fijan algunos de los posibles parmetros a falta de incluirlos todos.

Devuelve:
array Devuelve una array asociativo con la salida [numRegistro|infoRegistro|mensajeApi|resultadoSQL]

Definición en la línea 432 del archivo IgepRegistroSalida.php.

        {
                // ORACLE API_CREAREGISTROSALIDA_PHP
                
                if (!$this->_validar())         
                {                       
                        throw new InvalidArgumentException ("Registro::registrarSalida ".$this->_error);
                }

                //Parmetros de entrada
                $anyox = $this->_anyo;//VRS_ANYO
                $asuntox = $this->_asunto;//VRS_ASUNTO
                $acuseRecibox = null;//VRS_ACUSE_RECIBO
                $idDestTipoDocCod = null;//VRS_AM_TP_CODIGO
                $idDestNumDocCod = null; //VRS_AM_NUMERO_DOC
                $idDestIndDuplNumDoc = null;//VRS_AM_IND_DUP_DNI
                $ape1Dest = null; //VRS_NOMSEP_APELL1
                $ape2Dest = null; //VRS_NOMSEP_APELL2
                $nomSepDest = null; //VRS_NOMSEP_NOMBRE
                $nombreCompletoDest = $this->_nombreDest;//VRS_NOMBRE_DEST
                $codProDest = $this->_codPro; //VRS_CODPRO_DEST
                $codMunDest = $this->_codMun; //VRS_CODMUN_DEST
                $nomMunDest = null; //VRS_NOMMUN_DEST
                $codPobDest = null; //VRS_CODPOB_DEST           
                $direccionDestinatario = $this->_direccionDest;//VRS_DIRECCION_DEST
                $codPostDestinatario = $this->_CPDest; //VRS_CODPOS_DEST
                $paisDestinatario = null; //VRS_PAIS_DEST               
                $numeroDeSalidaUnidad = null; //VRS_NUMERO_SALIDA_UNIDAD                
                $codUnidadOrigen = $this->_codUnidadOrigen; //VRS_UNI_CODIGO_ES_REMITIDO_POR            
                $numeroRegistroEntrada = null;//VRS_RE_NUM_REGISTRO
                $anyoRegistroEntrada = null; //VRS_RE_ANYO_REGISTRO
                $codExpedienteAsociado = null; //VRS_EA_COD_EXPE_USER
                $codUnidadDestino = null; //VRS_UNI_CODIGO_ES_ENVIADO_A
                $codConselleriaOrigen= $this->_codConselleriaOrigen;  //VRS_CONSEJERIA
                $codUnidadRegistral = $this->_codUnidadRegistral; //VRS_UNIDAD_REGISTRAL
                $codAdministracionDestino = null;//VRS_AD_UNI_CODIGO_ES_ENVIADO_A
                $codOrganismoDestino = null;//VRS_OR_UNI_CODIGO_ES_ENVIADO_A            
                $codOrganismoOrigen = $this->_codOrganismoOrigen;//VRS_OR_UNI_CODIGO_ES_REMITIDO organismoOrigen
                $fecDocsRegSal = null;//VRS_FECHA_DOCUMENTOS
                $fecPresentDocsRegSal = null;//VRS_FECHA_PRESENT
                //Parmetros de salida
                $out_numRegistro = null; //VRS_NUMERO
                $out_numRegistroCompleto = null; //VNUMERO_REGISTRO
                $out_mensajeAPI = null; //VMsg
                $out_resultado = null; //X

                //select * from rs_regsal where
                
                //Recogemos el objeto nativo de la conexin oracle
                $connOci8 = $this->_conOracle->getPEARConnection()->getConnection();
                
                $cadenaInvocacion = <<<storeProcedure
begin API_CreaRegistroSalida_PHP
(
   :anyox,
   :asuntox,
   :acuserecibox,
   :iddesttipodoccodx,
   :iddestnumdoccodx,
   :iddestindduplnumdocx,
   :ape1destx,
   :ape2destx,
   :nomsepdestx,
   :nombrecompletodestx,
   :codprodestx,
   :codmundestx,
   :nomundestx,
   :codpobdestx,
   :direcciondestinatariox,
   :codpostdestinatariox,
   :paisdestinatariox,
   :numerodesalidaunidadx,
   :codunidadorigenx,
   :numeroregistroentradax,
   :anyoregistroentradax,
   :codexpedienteasociadox,
   :codunidaddestinox,
   :codconselleriaorigenx,
   :codunidadregistralx,
   :codadministraciondestinox,
   :codorganismodestinox,
   :codorganismoorigenx,
   :fecdocsregsalx,
   :fecpresentdocsregsalx,
   :numregistro,
   :numregistrocompleto,
   :mensajeapi,
   :resultado
);
end;

storeProcedure;

                $stmt = oci_parse($connOci8, $cadenaInvocacion);
                
                // Preparamos los parmetros de la invocacin.
                // Deben tener el tamao exacto para el que estn definidas en el procedimiento o funcin
                // OCIBindByName($sentencia, ':nombreParam', valor, tamao);
                oci_bind_by_name($stmt, ':anyox', $anyox, 4);
                oci_bind_by_name($stmt, ':asuntox', $asuntox, 250);
                oci_bind_by_name($stmt, ':acuserecibox', $acuseRecibox, 1);
                oci_bind_by_name($stmt, ':iddesttipodoccodx', $idDestTipoDocCod, 3);
                oci_bind_by_name($stmt, ':iddestnumdoccodx', $idDestNumDocCod, 30);
                oci_bind_by_name($stmt, ':iddestindduplnumdocx', $idDestIndDuplNumDoc, 1);
                oci_bind_by_name($stmt, ':ape1destx', $ape1Dest, 25);
                oci_bind_by_name($stmt, ':ape2destx', $ape2Dest, 25);
                oci_bind_by_name($stmt, ':nomsepdestx', $nomSepDest, 25);               
                oci_bind_by_name($stmt, ':nombrecompletodestx', $nombreCompletoDest, 50);
                oci_bind_by_name($stmt, ':codprodestx', $codProDest, 2);
                oci_bind_by_name($stmt, ':codmundestx', $codMunDest, 3);
                oci_bind_by_name($stmt, ':nomundestx', $nomMunDest, 50);
                oci_bind_by_name($stmt, ':codpobdestx', $codPobDest, 2);
                oci_bind_by_name($stmt, ':direcciondestinatariox', $direccionDestinatario, 50);
                oci_bind_by_name($stmt, ':codpostdestinatariox', $codPostDestinatario, 5);
                oci_bind_by_name($stmt, ':paisdestinatariox', $paisDestinatario, 40);
                oci_bind_by_name($stmt, ':numerodesalidaunidadx', $numeroDeSalidaUnidad, 6);
                oci_bind_by_name($stmt, ':codunidadorigenx', $codUnidadOrigen, 5);
                oci_bind_by_name($stmt, ':numeroregistroentradax', $numeroRegistroEntrada, 8);
                oci_bind_by_name($stmt, ':anyoregistroentradax', $anyoRegistroEntrada, 4);
                oci_bind_by_name($stmt, ':codexpedienteasociadox', $codExpedienteAsociado, 20);
                oci_bind_by_name($stmt, ':codunidaddestinox', $codUnidadDestino, 5);
                oci_bind_by_name($stmt, ':codconselleriaorigenx', $codConselleriaOrigen, 2);
                oci_bind_by_name($stmt, ':codunidadregistralx', $codUnidadRegistral, 3);
                oci_bind_by_name($stmt, ':codadministraciondestinox', $codAdministracionDestino, 2);
                oci_bind_by_name($stmt, ':codorganismodestinox', $codOrganismoDestino, 2);
                oci_bind_by_name($stmt, ':codorganismoorigenx', $codOrganismoOrigen, 2);
                oci_bind_by_name($stmt, ':fecdocsregsalx', $fecDocsRegSal, 10);
                oci_bind_by_name($stmt, ':fecpresentdocsregsalx', $fecPresentDocsRegSal, 10);
                
                //Parmetros de salida
                oci_bind_by_name($stmt, ':numregistro', $out_numRegistro, 6);
                oci_bind_by_name($stmt, ':numregistrocompleto', $out_numRegistroCompleto, 50);
                oci_bind_by_name($stmt, ':mensajeapi', $out_mensajeAPI, 250);
                oci_bind_by_name($stmt, ':resultado', $out_resultado, 10);
                $resultadoOk = oci_execute($stmt, OCI_DEFAULT);//TODO: A partir de PHP 5.3.2 cambiar OCI_DEFAULT por OCI_NO_AUTO_COMMIT
                
                oci_free_statement($stmt);
                ocilogoff($connOci8);
                
                $resultado = array();
                if ($resultadoOk)
                {
                        $vResultado = array
                        (
                                'numRegistro'=> $out_numRegistro,
                                'infoRegistro'=> $out_numRegistroCompleto,
                                'mensajeApi'=> $out_mensajeAPI,
                                'resultadoSQL'=> $out_resultado
                        );
                }
                else
                {               
                        throw new InvalidArgumentException ('Registro::registrarSalida Error al ejecutar el procedimiento almacenado ');
                }
                
                
                return $vResultado;
        }//registrarSalida
setAnyo ( valor)

Registro::setAnyo Establece el anyo del registro del que se abrir una instancia

Parámetros:
stringanyo del registro del que se abrir una instancia

Definición en la línea 251 del archivo IgepRegistroSalida.php.

        {
                $this->_anyo= $valor;
        }//Fin setAnyo
setAsunto ( valor)

Registro::setAsunto Establece el asunto de la orden de registro

Parámetros:
stringAsunto de la orden de registro

Definición en la línea 263 del archivo IgepRegistroSalida.php.

        {
                $this->_asunto = $valor;
        }//Fin setAsunto
setCodMun ( valor)

Registro::setCodMun Establece el cdigo de municipio (codmun)

Parámetros:
stringcdigo del municipio en COMUN

Definición en la línea 275 del archivo IgepRegistroSalida.php.

        {
                $this->_codMun = $valor;
        }//Fin setCodMun
setCodPro ( valor)

Registro::setCodPro Establece el cdigo de la provincia (codpro)

Parámetros:
stringcdigo de la provincia (codpro) en COMUN

Definición en la línea 287 del archivo IgepRegistroSalida.php.

        {
                $this->_codPro = $valor;
        }//Fin setCodPro
setCP ( valor)

Registro::setCP Establece el cdigo postal del destinatario

Parámetros:
stringcdigo postal del destinatario

Definición en la línea 299 del archivo IgepRegistroSalida.php.

        {
                $this->_CPDest = $valor;
        }//Fin setCP
setDireccionDestinatario ( valor)

Registro::setDireccionDestinatario Establece la direccin del destinatario

Parámetros:
stringdireccin del destinatario

Definición en la línea 323 del archivo IgepRegistroSalida.php.

        {
                $this->_direccionDest = $valor;
        }//Fin setDireccionDestinatario
setNombreDestinatario ( valor)

Registro::setNombreDestinatario Establece el nombre completo del destinatario

Parámetros:
stringnombre completo del destinatario

Definición en la línea 311 del archivo IgepRegistroSalida.php.

        {
                $this->_nombreDest = $valor;
        }//Fin setNombreDestinatario
setUnidadRegistral ( valor)

Registro::setUnidadRegistral Establece la unidad registral

Parámetros:
stringcdigo de la unidad registral

Definición en la línea 333 del archivo IgepRegistroSalida.php.

        {
                $this->_unidadRegistral = $valor;
        }//Fin setUnidadRegistral
setValuesRegistro ( vParams,
vIndexMatch = null 
)

Registro:setValuesRegistro Recibe un array asociativo de parmteros (opcionalemnte un array asocitivo de ndices) y fija los atributos del registro

Parámetros:
Array$vParamsVector asociativo con los prametros de invocacin [anyo|asunto|nombreDest|codpro|codmun|direccionDest|CPDest]
Array$vIndexMatchOpcional. Vector asociativo con ndices del array de parmetros [anyo|asunto|nombreDest|codpro|codmun|direccionDest|CPDest]
Devuelve:
int Devuelve el nmero de registro obtenido

Definición en la línea 178 del archivo IgepRegistroSalida.php.

        {
                $indAnyo = 'anyo';              
                $indAsunto = 'asunto';
                $indNombreDest = 'nombreDest';
                $indCodpro = 'codpro';
                $indCodMun = 'codmun';
                $indDireccionDest = 'direccionDest';
                $indCPDest = 'CPDest';
                $indCodUnidadOrigen = 'codUnidadOrigen';
                $indCodConselleriaOrigen = 'codConselleriaOrigen';
                $indCodUnidadRegistral = 'codUnidadRegistral';
                $indCodOrganismoOrigen = 'codOrganismoOrigen';
                
                if (is_array($vIndexMatch))
                {
                        if (isset($vIndexMatch['anyo'])) $indAnyo = $vIndexMatch['anyo'];
                        if (isset($vIndexMatch['asunto'])) $indAsunto = $vIndexMatch['asunto'];
                        if (isset($vIndexMatch['nombreDest'])) $indNombreDest = $vIndexMatch['nombreDest'];
                        if (isset($vIndexMatch['codpro'])) $indCodpro = $vIndexMatch['codpro'];
                        if (isset($vIndexMatch['codmun'])) $indCodMun = $vIndexMatch['codmun'];
                        if (isset($vIndexMatch['direccionDest'])) $indDireccionDest = $vIndexMatch['direccionDest'];
                        if (isset($vIndexMatch['CPDest'])) $indCPDest = $vIndexMatch['CPDest'];                 
                        if (isset($vIndexMatch['codUnidadOrigen'])) $indCodUnidadOrigen = $vIndexMatch['codUnidadOrigen'];
                        if (isset($vIndexMatch['codConselleriaOrigen'])) $indCodConselleriaOrigen = $vIndexMatch['codConselleriaOrigen'];
                        if (isset($vIndexMatch['codUnidadRegistral'])) $indCodUnidadRegistral = $vIndexMatch['codUnidadRegistral'];
                        if (isset($vIndexMatch['codOrganismoOrigen'])) $indCodOrganismoOrigen = $vIndexMatch['codOrganismoOrigen'];
                        
                }
                
                if (isset($vParams[$indAnyo]))  
                        $this->_anyo = $vParams[$indAnyo];
                        
                if (isset($vParams[$indAsunto]))        
                        $this->_asunto = $vParams[$indAsunto];
                        
                if (isset($vParams[$indNombreDest]))    
                        $this->_nombreDest = $vParams[$indNombreDest];
                        
                if (isset($vParams[$indCodpro]))        
                        $this->_codPro = $vParams[$indCodpro];
                        
                if (isset($vParams[$indCodMun]))        
                        $this->_codMun = $vParams[$indCodMun];
                
                if (isset($vParams[$indDireccionDest])) 
                        $this->_direccionDest = $vParams[$indDireccionDest];
                
                if (isset($vParams[$indCPDest]))        
                        $this->_CPDest = $vParams[$indCPDest];
                        
                if (isset($vParams[$indCodUnidadOrigen]))       
                        $this->_codUnidadOrigen = $vParams[$indCodUnidadOrigen];
                        
                if (isset($vParams[$indCodConselleriaOrigen]))  
                        $this->_codConselleriaOrigen = $vParams[$indCodConselleriaOrigen];
                        
                if (isset($vParams[$indCodUnidadRegistral]))    
                        $this->_codUnidadRegistral = $vParams[$indCodUnidadRegistral];
                        
                if (isset($vParams[$indCodOrganismoOrigen]))    
                        $this->_codOrganismoOrigen = $vParams[$indCodOrganismoOrigen];
                        
                
        }//Fin setValuesRegistro

Documentación de los campos

$_anyo [private]

Definición en la línea 62 del archivo IgepRegistroSalida.php.

$_asunto [private]

Definición en la línea 69 del archivo IgepRegistroSalida.php.

$_codConselleriaOrigen [private]

Definición en la línea 119 del archivo IgepRegistroSalida.php.

$_codMun [private]

Definición en la línea 90 del archivo IgepRegistroSalida.php.

$_codOrganismoOrigen [private]

Definición en la línea 133 del archivo IgepRegistroSalida.php.

$_codPro [private]

Definición en la línea 83 del archivo IgepRegistroSalida.php.

$_codUnidadOrigen [private]

Definición en la línea 112 del archivo IgepRegistroSalida.php.

$_codUnidadRegistral [private]

Definición en la línea 126 del archivo IgepRegistroSalida.php.

$_conOracle [private]

Definición en la línea 48 del archivo IgepRegistroSalida.php.

$_CPDest [private]

Definición en la línea 104 del archivo IgepRegistroSalida.php.

$_direccionDest [private]

Definición en la línea 97 del archivo IgepRegistroSalida.php.

$_error [private]

Definición en la línea 55 del archivo IgepRegistroSalida.php.

$_nombreDest [private]

Definición en la línea 76 del archivo IgepRegistroSalida.php.


La documentación para esta clase fue generada a partir del siguiente fichero: