Usuario:ManuelRomero/PHP/hibridas/practica

Práctica guiada de aplicaciones híbridas
Se trata de hacer una aplicación híbrida cuya descripción es la siguiente (Se puede ver en el docuemnto pdf que os he pasado).


 * Desarrollo usando el servicio task de google con rest

Realizando la aplicacion de repartos

 * Las especificaciones según el enunciado del tema son las siguientes
 * 1) Se utilizará la API del servicio de tareas de Google (Google Tasks) para almacenar como listas de tareas la información de los repartos. Cada lista de tareas se corresponde en la aplicación con una lista de reparto, y cada una de sus tareas con un envío.
 * 2) Para diferenciar una lista de otra, se le pone como parte del título la fecha del día en que se hará el reparto.
 * 3) Para cada producto que se reparte se creará una tarea en la lista correspondiente. Esa tarea almacenará la dirección de envío y sus coordenadas. Para obtenerlas, y para mostrar su ubicación en un mapa, en el momento en que se introduzca la dirección se utilizará el servicio de geocodificación de Google (Google Geocoding).
 * 4) Para optimizar la ruta que se ha de recorrer, se utilizará Google Directions. La idea es reorganizar de forma automática el orden de los productos que se van a repartir cada día de forma que se minimice la distancia recorrida.
 * 5) Se visualizará en una nueva ventana el mapa correspondiente a las coordenadas de envío (google maps)
 * 6) En total usaremos cuatro servicios
 * 7) Google Task usaremos la versión 1 v1. Decir que es una version beta y puede tener modificaciones que no mantengan compatibilidad
 * 8) Google Geocoding
 * 9) Google Directons
 * 10) Google Maps

800px 500px
 * Cuando se cree una nueva tarea (un nuevo envío), se pedirá la dirección y se mostrará una pantalla como la siguiente para que el usuario complete los datos necesarios.

https://developers.google.com/api-client-library/php/start/get_started
 * Página para realizar usos y accesos a API de google

https://developers.google.com/google-apps https://github.com/google/google-api-php-client/blob/master/src/Google/Service/Tasks.php http://www.xajax-project.org/en/download/ http://sourceforge.net/projects/xajax/files/xajax/ https://github.com/Xajax/Xajax
 * La página de google donde tenemos toda la información de las apis
 * Información con las clases de la API de Tasks
 * Para descargar las librerías de Xajax

http://stackoverflow.com/questions/2126410/xajax-alternative https://developers.google.com/console/help/?hl=es https://developers.google.com/google-apps/tasks/ http://rubenvasallo.es/php/google-y-su-oauth2/ https://developers.google.com/apis-explorer/#p/tasks/v1/ }}
 * Qué es crear un proyecto en google
 * Otras web que he mirado

Creando el proyecto en google
Imagen:appHibridaRepartos1.png https://console.developers.google.com/
 * El primer paso es crear el proyecto en google y crearnos los credenciales necesarios para incorporar en nuestra aplicación
 * Para poder utilizar las API de google, debemos crear un proyecto donde las incluiremos,
 * Un proyecto en google consiste en un conjunto de información relacionada con un desarrollo, donde espeficicas datos de autentificación Api que tu proyecto puede usar, puedes ver cuanto se utiliza tu aplicación, especificar accesos por url o por email y mas conceptos.
 * Google facilita una consola para este cometido donde puedes modificar, crear y/o visulizar esta información.
 * Para crear un proyecto, accedemos a la consola de google (previamente hay que identificarse si no lo has hecho antes).
 * Una vez dentro debemos crear una clave para acceder a nuestra aplicación. Estos conceptos están especificados en los apuntes.
 * Accedemos a google, (debemos crear una cuenta)
 * Cada uno que haga como quiera, podéis crearos un nuevo usuario en google para estas tareas e independizaros de vuestro usuario habitual.

Configurando servicios
git clone https://github.com/google/google-api-php-client Si vamos a descargarlas al url especificado, nos redirigen La página de google donde tenemos toda la información de las apis https://developers.google.com/google-apps
 * Descargamos las librerías para utilizar las API de google usando php
 * Las podemos descargar en línea de comandos con el comando
 * Una vez descargados tendremos en el directorio donde lo hayamos descargado (mejor hacerlo en el directorio del proyecto), el directorio google-api-php y dentro de él, los directorios con los fuentes para usar las diferentes librerías
 * Especificamos en nuestro programa la ruta para esta ubicación
 * Ahora incluimos las librerías necesarias


 * Para el tema de Ajax, descargamos la librería de xAjax que es lo que vamos a usar, y dejo en una carpeta llmada libs, dentro del directorio del proyecto las carpetas con sus contenidos de xajax_core y xajax_js

Creando objeto Xajax

 * Directamente ponemos el código para usar ajax
 * Ahora creamos el objeto xAjax

Objetos del api

 * Definimos objetos para usar el api de google.
 * En esta parte hay alguna diferencia con lo facilitado en la plataforma pues usamos una versión diferentes, aunque no son demasiados.
 * El objeto de Google_Cliente, se va a instanciar para autentificarse y autorizar oAuth2
 * Ver el wiki de al lado. Autentificarnos consiste en que obligaremos al usuario de nuestra aplicación a que un tercer, en este caso google, le pida que se identifique con usuario y contraseña
 * Autorizar consiste en que el usuario de nuestra aplicación autoriza a la aplicación a acceder en su nombre a ciertos recursos privados que especificaremos con el método setScope, sin necesidad de que la aplicación conozca ni su usuario ni su contraseña.
 * Además de la aplicación web, tenemos un proyecto en google donde estás las API's configuradas para que nuestra aplicación las pueda utilizar
 * A continuación el proceso para este objetivo


 * Para asegurar de donde tomar los datos, aunque es muy intuitivo, vemos la siguiente imagen que se relaciona con los métodos que requieren sus datos.

Verificando la autentificacion

 * Este código está tomado de uno de los ficheros ejemplo que google facilita junto con las librerías
 * Por otro lado sería bueno que si ya tenemos el tocken almacenado en una variable de sesión, que esta ya no tuvuera que ser solicitada o validarla desde el code'
 * Por lo que el código anterior lo condicionaríamos a ello
 * El tocken normalmente tiene una hora de validez, luego caduca
 * Para verificar si el tocken está caducado se emplea el método
 * Este método retornará true si está validado
 * No voy a controlar esto en el código que os aporto, podéis mirar las páginas facilitadas por Carlos Pérez Marín


 * Referencias en la web
 * 1) https://github.com/google/google-api-php-client/issues/213
 * 2) http://stackoverflow.com/questions/15905104/automatically-refresh-token-using-google-drive-api-with-php-script
 * 3) https://www.igorkromin.net/index.php/2015/05/21/example-of-using-the-google-plus-oauth-refresh-token/
 * 4) http://stackoverflow.com/questions/10827920/google-oauth-refresh-token-is-not-being-received
 * 5) https://www.igorkromin.net/index.php/2015/05/21/example-of-using-the-google-plus-oauth-refresh-token/

Primero aportamos el css

 * A continuación editamos el fichero de estilo css

El código html

 * Ahora hacemos la parte de html
 * Empezamos haciendo la parte de repartos
 * Simplemente una página que contenga un botón para dar de alta una lista de repartos
 * Posteriormente añadiremos para cada lista de repartos los repartos que contienen
 * Vamos a decidir insertar para cada posible acción en un formulario un texto oculto llamado accion (name) y como value la acción que queremos hacer
 * En el siguiente código en el formulario empezamos por la acción nuevalista

Usando los servicios de api

 * Ahora ya viene la parte de utilizar los métodos del api de google
 * Cuando nosotros generemos la accion nueva lista querremos dar de alta una nueva lista en la task del usuario que está usando nuestra aplicación y que ha dado permiso a la aplicación mediante un token para que en su nombre acceda y pueda modificar esos datos

Definimos objetos de cada servicio API que queremos utilizar
 * En función de que hayamos seleccionado haremos una cosa u otra
 * A continuación vamos a implementar el código asociado a cada una de las acciones, y vamos verificando que dicha acción se ha realizado correctamente

Nueva Lista
Y con él recorre su estructura
 * En el cliente se nos facilita una fecha
 * A partir de ella (la validamos), creamos un evento en el calendario que vaya desde las 9 horas de la mañana hasta las 20 horas de la tarde
 * Una vez creado este evento creamos una nueva lista de tareas con el nombre Repartos y fecha aportada
 * Creando un evento en el calendario
 * Para ello debemos usar los objetos de las clases event como se puede ver en el código siguiente
 * Una vez que hemos creado la lista, vamos a hacer que en el código nos aparezcan todas las listas de tareas que tenemos en nuestra agenda de listas de tareas
 * Para ello podemos usar el obejeto de la clase
 * Es un array asociativo donde hay un elemento que contiene el nombre de la lista y un identificador

Nueva Envío
Imagen:hibridaMaps.png
 * Cada lista va a constar de una serie de envíos
 * Para ello vamos a implementar un nuevo envío o la acción de una nueva tarea dentro de la lista de tareas
 * Primero añadimos el botón correspondiente en el cliente
 * Una nueva tarea es un nuevo reparto
 * Un reparto necesita una coordenadas para localizarla.
 * Para ello usaremos una ventana de localización y usaremos google maps
 * Esta ventana queremos que sea una ventana modal que tengamos en nuestra aplicación
 * La podremos al principio de la página html
 * Para abrir esta ventana u ocultarla usaremos javascript
 * Ahora sí que necesitmos meter código de ajax para que esto funcione
 * Este formulario tiene el botón que nos hará crear una nueva tarea, pero antes vamos a ver como visualizar este formulario y veremos también la llamada a Ver en Google Maps

Abrir la ventana modal Dialogo

 * En cada Lista de tareas vamos a poner un botón para abrir esta ventana de diálogo
 * Agregaremos para cada lista un botón de nuevo reparto
 * Como vamos a hacerlo por, usamos el envento onclick
 * Tenemos un fichero codigo.js donde vamos a ir metiendo el código de javascript
 * La función nuevo envío básicamente va a abrir la ventana de diálogo para aportar los datos del nuevo envío

Función diálogo
printJavascript; ?>
 * A la vez tendremos que tener la función ocultar diálogo
 * Debemos especificar que vamos a usar javascript
 * También, para facilitar las cosas, vamos a usar el framework de java script JQuery
 * Ahora vamos a ver cómo obtener las coordenadas de una posicion usando la api de google Maps
 * Esta es una api que es importante de estudiar por vuestra cuenta
 * En nuestro caso vamos a usar ajax para obtener coordenadas
 * Para ello primero incluimos la librería de xajax para incorporar ajax en nuestro proyecto
 * En el código html escribimos el código javascript en el cliente
 * El código de las funciones en el servidor las escribimos en el fichero que le pasamos a la instacia del objeto $xajax ajaxmaps.php

La parte del cliente

 * Ahora nos queda invocar a esta función desde el cliente
 * Esto lo haremos en el formulario de la ventana de dialogo obtener Coordenadas
 * Este botón llamará al método javascript getCoordenadas implementado en el fichero código.js
 * Y ahora miramos lo que hace el método obtenerCoordenadas en php, el cual recibe los datos de las coordenadas
 * Lo que hace es una solicitud REST a google pasándoles las coordenadas


 * En respuesta pasamos los valores de las coordenadas
 * En caso de querer acceder a Maps para obtener las coordenadas, se ha implementado un botón en la propia ventana de diálogo Ver en Google Maps
 * Este botón ejecuta el método abrirMaps de javaScript que lo único que hace es abrir una nueva ventana de google Maps


 * Ahora tenemos que terminar de implementar la acción de nuevo reparto. Ya tenemos las coordenadas, ahora debemos usar el api de google para crear este nuevo reparto
 * Necesitamos tener el identificador de la lista de tareas para incorporar esa tarea en la lista de tareas
 * Para ello recogemos el dato cuando solicitamos una nueva tarea y se lo pasamos a la función nuevoEnvio de javaScritp
 * Para poder acceder a esta información debemos guardarla cuando hacemos un listado de todas las listas de tareas en un input de tipo hidden, y lo pasaremos como parámetro al nueva envío
 * quedaría de la siguiente manera


 * Y ahora nos quedaría visualizar los repartos que tenemos en cada lista de repartos
 * De esta forma podremos visualizar los repartos de cada lista de repartos

La parte del servidor

 * Ahora que tenemos hecho lo del cliente, vamos a ver como se comporta el servidor
 * El servidor va a reaccionar ante una solicitud GET de nuevaTarea
 * Por lo que actuaremos en el switch-case de $_GET

Borrar una lista de envíos

 * Esta parte es muy sencilla
 * Recordemos que tenemos el objeto de la clase TaskList que gestiona las listas que tengo en mi tareas
 * Ahora si he establecido hacer esta acción, la realizo

Borrar un envío

 * Borar un envío es borrar una tarea dentro de una tarea de listas
 * Es igual de sencillo que borrar una lista de tareas
 * Al igual que en el caso anterior usamos el objeto con el que gestionamos nuestras listas de tareas
 * Debemos tener el identificador de la lista y el identificador de la tarea o envío que queremos eliminar
 * Después con el método delete procedemos a eliminarlo
 * Ahora si he establecido hacer esta acción, la realizo

Ver un envío en el mapa
center|500px
 * Este botón lo añadimos junto con cada envío o tarea que damos de alta
 * En el atributo notes tenemos almacenada la información de las coordenadas del envío
 * El botón lo ponemos junto con la posibilidad de borrar la tarea y el nombre de la misma
 * Ahora vamos a ver la acción que hacemos en la función de javascript abrirMaps

Ordenar la lista de envíos

 * Este es una acción un poco complicada.
 * Usamos una función de javaScript con jquery, una llamada síncrona y luego código php para que quede reflejado el nuevo orden
 * Por un lado cuando hacemos un click en ordenar la lista en una lista de reparto, vamos a ejecutar una función en javascript según se identifica
 * En la parte del código que ponemos cada lista de reparto añadimos el botón ordenar Reparto
 * Pongo código delante y detrás para que vemos la ubicación concreta
 * Ahora vamos a ver el código de la función ordenaReparto(...) con el contenido explicado
 * Y ahora quedaría la parte de php
 * Observamos que la página con los parámetros get para esta parte de php no vienen de un formulario, sino del contenido del código de este método
 * En lugar de explicar aquí lo que se hace, se aportan en el código los comentarios necesarios para entender claramente lo que hace el código