Skip to content

Commit

Permalink
Rename the function names
Browse files Browse the repository at this point in the history
- Move all functions to the main plugin file and remove the file deptos.php
- Update the readme fiel with the proper dataset metadata
  • Loading branch information
vizapata committed Sep 15, 2021
1 parent f1f4329 commit a501ef5
Show file tree
Hide file tree
Showing 3 changed files with 8,284 additions and 8,279 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Departamentos y Municipios de Colombia

Este plugin provee una lista de los departamentos y municipios de Colombia actualizada con base en la información disponible en el portal de datos abiertos: https://www.datos.gov.co/en/Mapas-Nacionales/DEPARTAMENTOS/25e3-npng
Este plugin provee una lista de los departamentos y municipios de Colombia con base en la información disponible en el portal de datos abiertos.

Lista de funciones disponibles:
- `dmcol_all`: Lista de todos los departamentos con sus respectivos municipios
- `dmcol_by_state_name`: Detalles de un departamento específico según el nombre del departamento
- `dmcol_by_state_name_and_city_name`: Detalles de un municipio según el nombre del departamento y del municipio
- `dmcol_city_state_by_state_name_and_city_name`: Detalles combinados de un departamento y municipio con base en el nombre del departamento y del municipio.
- URL Dataset: https://www.datos.gov.co/en/Mapas-Nacionales/DIVIPOLA-C-digos-municipios/gdxc-w37w
- Fecha de actualización dataset: 15 de diciembre de 2020

## Lista de funciones disponibles:
- `dmcol_all_states`: Lista de todos los departamentos con sus respectivos municipios
- `dmcol_get_state_by_name`: Detalles de un departamento específico según el nombre del departamento
- `dmcol_get_city_by_state_and_name`: Detalles de un municipio según el nombre del departamento y del municipio
- `dmcol_get_state_and_city_by_name`: Detalles combinados de un departamento y municipio con base en el nombre del departamento y del municipio.

Ejemplo:
```php
$details = dmcol_city_state_by_state_name_and_city_name('ANTIOQUIA', 'MEDELLÍN');
$details = dmcol_get_state_and_city_by_name('ANTIOQUIA', 'MEDELLÍN');

/*
Array
Expand All @@ -23,3 +26,5 @@ Array
*/
```

## Nota
Es muy importante el uso correcto de mayúsculas y tildes. La búsqueda de la información se hace utilizando el mismo formato y nombres que los indicados en el dataset del portal de datos abiertos descrito al inicio de este documento.
Loading

0 comments on commit a501ef5

Please sign in to comment.