Download the PHP package andreshg112/datos-abiertos without Composer
On this page you can find all versions of the php package andreshg112/datos-abiertos. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download andreshg112/datos-abiertos
More information about andreshg112/datos-abiertos
Files in andreshg112/datos-abiertos
Package datos-abiertos
Short Description Consulta la API de Datos Abiertos del Gobierno de Colombia en la plataforma https://www.datos.gov.co
License MIT
Homepage https://github.com/andreshg112/datos-abiertos
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package datos-abiertos
Datos Abiertos de Colombia para Laravel
Este paquete encapsula las consultas a la API de Datos Abiertos del Gobierno de Colombia.
Recursos implementados
-
ESTABLECIMIENTOS EDUCATIVOS DE PREESCOLAR, BÁSICA (
\Andreshg112\DatosAbiertos\Facades\Colegios). -
Códigos de la Divisón Político-Administrativa del país (
\Andreshg112\DatosAbiertos\Facades\Divipola). - Organismos de Tránsito (
\Andreshg112\DatosAbiertos\Facades\OrganismosTransito).
Si deseas que desarrolle una consulta a otro recurso de datos.gov.co, puedes realizar la petición en los Issues.
Requisitos
- Laravel >= 5.5
- PHP >= 7.1.x
Si quieres soporte para una versión inferior a las especificadas, por favor deja la petición en los Issues y veré qué puedo hacer.
Instalación
Puedes instalar el paquete a través de composer:
Este paquete usa Laravel Package Discovery por lo que, si usas Laravel 5.5 o superior, no debes preocuparte agregar \Andreshg112\DatosAbiertos\DatosAbiertosServiceProvider al listado de providers en el archivo config/app.php.
Uso
Uso básico
Cada recurso hereda de \Andreshg112\DatosAbiertos\Datasets\BaseDataset, el cual tiene el método getData($filterOrSoqlQuery = '') que permite consultar todos los registros del recurso o filtrar de acuerdo a los parámetros.
Por ejemplo:
Uso de filtros
En la definición de la API de Divipola puedes encontrar los detalles del recurso y el uso de filtros.
Advertencia: La API de datos.gov.co distingue mayúsculas y minúsculas. Por lo tanto si buscas, por ejemplo,
nom_mpio=valleduparno aparecerá porque debe tener laVmayúscula.Este paquete usa allejo/php-soda para realizar las peticiones a los recursos de datos.gov.co usando Socrata Open Data API (SODA), por lo tanto
$filterOrSoqlQuerypuede ser cualquiera de los parámetros aceptados por la función\allejo\Socrata\SodaDataset::getData(filterOrSoqlQuery). Para usar filtros avanzados, dirígete a su documentación (en inglés).
Extender la funcionalidad
Macroable
La clase padre \Andreshg112\DatosAbiertos\Datasets\BaseDataset de los recursos (datasets) usa el trait \Spatie\Macroable\Macroable de spatie/macroable, por lo que puedes extender la funcionalidad de cada recurso de la siguiente manera:
Para más información, dirígete a su documentación.
Crear tu propio recurso
Puedes crear tu propio dataset que herede de \Andreshg112\DatosAbiertos\Datasets\BaseDataset de la siguiente manera:
Este recurso será implementado en el paquete, solo se coloca de ejemplo.
La API no acepta tildes,
ño caracteres especiales en los nombres.
Luego, tendrás que hacer una fachada para la clase y está listo para usarse. Puede ser una fachada en tiempo real colocando el namespace Facades antes del namespace de la clase, así:
Métodos de los recursos (datasets)
Todos los recursos permiten el filtrado avanzado a través del método getData($filterOrSoqlQuery), pero para búsquedas simples, se puede usar el método where(string $column, $value) de la siguiente manera:
Las columnas del recurso o dataset (ya sea incluido o personalizado), que se indican en getColumns(), permiten acceden dinámicamente a métodos de acuerdo con los nombres transformados en camelCase, y el prefijo where con la primera letra mayúscula por ejemplo:
Todos los métodos retornan un vector de registros (array de arrays). Si se desea consultar un solo registro a través de la columna con valor único, entonces se hace uso de la función find($uniqueValue). Esto hace que el método solo retorne un solo registro (array) en vez de un vector de registros. Por ejemplo:
Columnas de valor único:
- Colegios: codigo_establecimiento
- Divipola: cod_mpio
- OrganismosTransito: cod_divipola
Los nombres de las columnas están especificados en la definición de la API de cada recurso en la plataforma de Datos Abiertos.
Pruebas
Registro de cambios
Por favor, mira el listado de Versiones para obtener más información sobre lo que ha cambiado recientemente.
Contribuir
Por favor, mira el archivo CONTRIBUTING (en inglés) para más detalles.
Seguridad
Si descubres una vulnerabilidad o fallo relacionado con seguridad, te agradezco que por favor me escribas a [email protected] en vez de hacerlo en el registro de errores.
Créditos
- Andrés Herrera García
- All Contributors
Licencia
Licencia MIT. Por favor, mira el archivo License File (en inglés) para más información.
Laravel Package Boilerplate
Este paquete fue generado usando Laravel Package Boilerplate.
All versions of datos-abiertos with dependencies
allejo/php-soda Version ^1.0
illuminate/support Version ^5.5
spatie/macroable Version ^1.0