Changes between Initial Version and Version 1 of WF/InformacoesdeCidadeeEstado

Timestamp:

07/24/07 15:01:39 (17 years ago)

Author:

trac

Comment:

--

WF/InformacoesdeCidadeeEstado

@@ +1 @@
+== Classe: wf_location ==
+ Esta classe tem a finalidade de obter informações sobre Estados e cidades a partir de seu ID.
+
+
+
+=== Métodos ===
+
+==== getCityById ====
+
+'''Descrição:''' Obtem informações sobre uma cidade a partir de seu ID.
+
+'''Parâmetros:'''
+
+:$city_id: o id da cidade que se quer obter informações.
+
+'''Retorno''': uma array associativa no formato:
+
+{{{
+
+$saida['id_city'] => #id_da_cidade // (ex: 1)
+
+$saida['city_name'] => 'Nome da cidade' // (ex: Curitiba)
+
+$saida['id_state'] => #id_do_estado_da_cidade // (ex: 1)
+
+$saida['state_name'] => 'Nome do Estado da Cidade' // (ex: PARANA)
+
+$saida['state_symbol'] => 'Sigla do Estado da Cidade' // (ex: PR)
+
+}}}
+
+'''Exemplo de uso:'''
+
+{{{
+
+$location = wf_create_object("wf_location");
+
+$cidade = $location->getCityById(1);
+
+}}}
+
+----
+
+==== getStateById ====
+
+'''Descrição:''' Obtem informações sobre um Estado a partir de seu ID.
+
+'''Parâmetros:'''
+
+:$state_id: o id do Estado que se quer obter informações.
+
+'''Retorno''': uma array associativa no formato:
+
+{{{
+
+$saida['id_state'] => #id_do_estado // (ex: 1)
+
+$saida['state_name'] => 'Nome do Estado' // (ex: PARANA)
+
+$saida['state_symbol'] => 'Sigla do Estado' // (ex: PR)
+
+}}}
+
+'''Exemplo de uso:'''
+
+{{{
+
+$location = wf_create_object("wf_location");
+
+$estado = $location->getStateById(1);
+
+}}}
+
+----
+
+==== getCitiesFromState ====
+
+'''Descrição:''' Obtem todas as cidades de um Estado.
+
+'''Parâmetros:'''
+
+:$state_id: o id do Estado do qual se quer a lista de cidades.
+
+'''Retorno''': uma array de arrays associativas. Cada array associativa tem o formato:
+
+{{{
+
+$uma_array['id_city'] => #id_da_cidade // (ex: 1)
+
+$uma_array['city_name'] => 'Nome da cidade' // (ex: Curitiba)
+
+}}}
+
+'''Exemplo de uso:'''
+
+{{{
+
+$location = wf_create_object("wf_location");
+
+$cidades = $location->getCitiesFromState(1);
+
+}}}