Documentación GVHIDRA 3.1.5
Referencia de la Clase IgepWS_Server

Métodos públicos

 __construct ($idWS, $msgs=null)
 encode ($text)
 decode ($text)
 gvhFault ($id, $msg=null)

Métodos públicos estáticos

static hashData ($str)
static getUsername ()

Métodos protegidos

 checkCredential ($credencial, $allowed=array())
 getAuthError ()
 conectar ($dsn)

Atributos protegidos

 $idWS
 $msgs

Métodos privados

 getCredential ($idWS)

Atributos privados estáticos

static $username

Descripción detallada

Definición en la línea 56 del archivo IgepWS_Server.php.


Documentación del constructor y destructor

__construct ( idWS,
msgs = null 
)

Constructor: incluye el cdigo que genera el WSDL.

Definición en la línea 65 del archivo IgepWS_Server.php.

                                           {
        //Creamos la variable de Error
        global $g_error;
        $g_error = new IgepError();
        //Almacenamos la referencia al identificador WS
        if (is_array($idWS))
                $this->idWS = $idWS;
                else
                        $this->idWS = array($idWS,);
        //Exportamos la estructura credencialCIT para que los consumidores puedan crearla
        $this->__typedef['{http://WS_CIT_Credencial.cit.gva.es/xsd}credencialCIT'] = 
            array(
                'login' => 'string',
                'password' => 'string' 
                );
        // guardar mensajes
        $this->msgs = $msgs;
        self::$username = null;
    }

Documentación de las funciones miembro

checkCredential ( credencial,
allowed = array() 
) [protected]

Este mtodo se encarga de realizar la validacion

Parámetros:
mixedcredencial que recibe el metodo del ws
arraycredenciales autorizadas, opcional
Devuelve:
boolean indica si la credencial es valida

Definición en la línea 92 del archivo IgepWS_Server.php.

    {
                if (!is_object($credencial) or !property_exists($credencial,'login'))
                        return FALSE;
                self::$username = $credencial->login;
                if (empty($allowed))
                $allowed = $this->idWS;
        elseif (!is_array($allowed))
                return FALSE;
        foreach ($allowed as $cred) {
                        $valido = $this->getCredential($cred);
                        if($credencial->login==$valido['username'] AND $this->hashData($credencial->password)==$valido['password'])
                                return TRUE;
            }
            return FALSE;
    }
conectar ( dsn) [protected]

Devuelve un objeto IgepConexion o false si hay error

Parámetros:
mixeddsn
Devuelve:
IgepConexion|false

Definición en la línea 145 del archivo IgepWS_Server.php.

                                     {
        $conexion = new IgepConexion($dsn);
        if(PEAR::isError($conexion->getPEARConnection()))
            return FALSE;
        return $conexion;
    }
decode ( text)

Convierte un texto en uft8 al encoding del fw (latin1) Si el fw no usara latin1 habria que convertir con iconv

Definición en la línea 164 del archivo IgepWS_Server.php.

                               {
                return utf8_decode($text);
        }
encode ( text)

Convierte un texto del encoding del fw (latin1) a utf-8 Si el fw no usara latin1 habria que convertir con iconv

Definición en la línea 156 del archivo IgepWS_Server.php.

                               {
                return utf8_encode($text);
        }
getAuthError ( ) [protected]

Devuelve un mensaje SOAP que indica al cliente que tiene un error de validacin

Devuelve:
Soap_Fault error indicando que la validacion es incorrecta

Definición en la línea 132 del archivo IgepWS_Server.php.

                                     {
        return new SOAP_Fault('No esta autorizado para este Web Service',
                              'Cliente',
                              $this->method_namespace,
                              NULL);
    }
getCredential ( idWS) [private]

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

                                         {
                return ConfigFramework::getConfig()->getDSN($idWS);
    }
static getUsername ( ) [static]

Definición en la línea 123 del archivo IgepWS_Server.php.

                                 {
                return self::$username;
    }
gvhFault ( id,
msg = null 
)

Genera un fallo soap

Parámetros:
id,:clave del error en el array asociativo de mensajes
mgs: texto adicional opcional que saldr en el debug

Definición en la línea 173 del archivo IgepWS_Server.php.

                                          {
                $txt = $this->encode($this->msgs[$id]);
                if ($msg)
                        IgepDebug::setDebug(ERROR, $msg);
                return new SOAP_Fault($txt, $id, $this->method_namespace, NULL);                
        }
static hashData ( str) [static]

Metodo usado para ocultar informacion de passwords de WS La implementacin debe coincidir con el formulario en igep/include/igep_utils/protectdata.php

Definición en la línea 113 del archivo IgepWS_Server.php.

                                       {
                if (empty($str))
                        return '';
                return md5('salto-pre'.$str.'salto-post');
        }

Documentación de los campos

$idWS [protected]

Definición en la línea 58 del archivo IgepWS_Server.php.

$msgs [protected]

Definición en la línea 59 del archivo IgepWS_Server.php.

$username [static, private]

Definición en la línea 60 del archivo IgepWS_Server.php.


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