Docs For Class org_routamc_positioning_importer

Description

Importer for fetching position data for Plazes users

Located in /org.routamc.positioning/importer/plazes.php (line 23)

PEAR
   |
   --midcom_baseclasses_core_object
      |
      --midcom_baseclasses_components_purecode
         |
         --org_routamc_positioning_importer
            |
            --org_routamc_positioning_importer_plazes

Method Summary

org_routamc_positioning_importer_plazes org_routamc_positioning_importer_plazes ()

Array get_plazes_location (midcom_db_person $user, [boolean $cache = true])

bool import (mixed $position, integer $person_id, Array $log)

Array seek_plazes_users ()

void _fetch_plazes_position (mixed $plazes_username, mixed $plazes_password)

Variables

Inherited Variables

Inherited from org_routamc_positioning_importer

org_routamc_positioning_importer::$error
org_routamc_positioning_importer::$log

Inherited from midcom_baseclasses_components_purecode

midcom_baseclasses_components_purecode::$_component
midcom_baseclasses_components_purecode::$_component_data
midcom_baseclasses_components_purecode::$_config
midcom_baseclasses_components_purecode::$_i18n
midcom_baseclasses_components_purecode::$_l10n
midcom_baseclasses_components_purecode::$_l10n_midcom

Methods

Constructor org_routamc_positioning_importer_plazes (line 28)

Initializes the class. The real startup is done by the initialize() call.

org_routamc_positioning_importer_plazes org_routamc_positioning_importer_plazes ()

get_plazes_location (line 130)

Get plazes location for an user

Array get_plazes_location (midcom_db_person $user, [boolean $cache = true])

midcom_db_person $user: Person to fetch Plazes data for
boolean $cache: Whether to cache the position to a log object

import (line 171)

Import plazes log entry. The entries are associative arrays containing all of the following keys:

latitude
longitude

return: Indicating success.

bool import (mixed $position, integer $person_id, Array $log)

Array $log: Log entry in Array format specific to importer
integer $person_id: ID of the person to import logs for

Redefinition of:

org_routamc_positioning_importer::import(): Empty default implementation, this calls won't do much.

seek_plazes_users (line 38)

Seek users with Plazes account settings set

Array seek_plazes_users ()

_fetch_plazes_position (line 56)

void _fetch_plazes_position (mixed $plazes_username, mixed $plazes_password)

Inherited Methods

Inherited From org_routamc_positioning_importer

org_routamc_positioning_importer::org_routamc_positioning_importer()
org_routamc_positioning_importer::create()
org_routamc_positioning_importer::import()
org_routamc_positioning_importer::map_to_city()
org_routamc_positioning_importer::normalize_coordinates()

Inherited From midcom_baseclasses_components_purecode

midcom_baseclasses_components_purecode::midcom_baseclasses_components_purecode()
midcom_baseclasses_components_purecode::_bind_to_request_data()
midcom_baseclasses_components_purecode::_load_topic_configuration()

Inherited From midcom_baseclasses_core_object

midcom_baseclasses_core_object::midcom_baseclasses_core_object()