Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /www/gimpster.com/php/phpweather/db/db_mysql.php
PHP Weather - PHP Weather

db_mysql

base_object
   |
  +-- db_common
     |
    +-- db_mysql

This class is the 'mysql' database-type.

 

private class db_mysql extends db_common

This class is the 'mysql' database-type.
It implements all the methods necessary to insert, update and retrive METARs using a MySQL database. You'll need access to a MySQL database to be able to use this object.

AuthorsMartin Geisler <gimpster@gimpster.com>
Versiondb_mysql.html,v 1.6 2001/06/27 11:35:43 gimpster Exp

 

Methods inherited from db_common

db_common

Methods inherited from base_object

base_object, error, debug, print_properties

Public Method Summary

void

db_mysql(array $input)

This constructor does nothing besides calling the parent constructor.
string

get_type()

Gets the type of the database.
boolean

connect()

Establishes a connection to the database.
boolean

disconnect()

Disconnects from the database.
boolean

select_db()

Selects a database.
boolean

query(string $query)

Executes a SQL-query.
array

fetch_row()

Fetches a row as an array from the database.
array

fetch_array()

Fetches a row as an associative array from the database.
integer

num_rows()

Returns the number of rows in the result-set.
void

insert_metar(string $icao, string $metar, integer $timestamp)

Inserts a METAR into the database.
void

update_metar(string $icao, string $metar, integer $timestamp)

Updates an existing METAR in the database.
string

get_metar(string $icao)

Gets a METAR form the database.
string

lookup_icao(string $icao)

Translates an ICAO into a station name
array

get_countries()

Returns a list of available countries.
array

get_icaos(string $cc, string &$country)

Returns an array of stations.

Private Method Summary

bool

create_tables()

Creates the necessary tables in the database.
bool

insert_stations(array $data, array $countries)

Inserts the stations into the database.

Fields inherited from db_common

$is_connected, $link_id, $result_id

Fields inherited from base_object

$properties, $version

Public Method Details

db_mysql

public void db_mysql( array $input )

  This constructor does nothing besides calling the parent constructor.

Parameter
array $input
initial properties of the object
Returns void


get_type

public string get_type( )

  Gets the type of the database.

Returns string

The type of the database, 'mysql' in this case.


connect

public boolean connect( )

  Establishes a connection to the database.
If there has already been made a connection to the database, this function just returns true, and nothing will be changed. This means that it is safe to call this instead of testing $is_connected. If $properties['db_pconnect'] is true, then a persistent connection will be established.

Returns boolean

Returns true, if a connection were established, false otherwise.

See Also disconnect()

disconnect

public boolean disconnect( )

  Disconnects from the database.
If we're already disconnected from the database, this function will just return true.

Returns boolean

If the disconnec was succesfull then it returns true, otherwise it returns false.

See Also connect()

select_db

public boolean select_db( )

  Selects a database.

Returns boolean

Returns true on success, false otherwise.


query

public boolean query( string $query )

  Executes a SQL-query.
$result_id is updated as well

Parameter
string $query
SQL-statement.
Returns boolean

True on success, false otherwise.


fetch_row

public array fetch_row( )

  Fetches a row as an array from the database.

Returns array

The next row from the result-set.


fetch_array

public array fetch_array( )

  Fetches a row as an associative array from the database.

Returns array

The next row from the result-set, as an associative array.


num_rows

public integer num_rows( )

  Returns the number of rows in the result-set.

Returns integer

The number of rows in the current result-set.


insert_metar

public void insert_metar( string $icao, string $metar, integer $timestamp )

  Inserts a METAR into the database.

Parameter
string $icao
ICAO of the station.
string $metar
raw METAR.
integer $timestamp
standard UNIX timestamp.
Returns void

See Also update_metar()

update_metar

public void update_metar( string $icao, string $metar, integer $timestamp )

  Updates an existing METAR in the database.

Parameter
string $icao
ICAO of the station.
string $metar
raw METAR.
integer $timestamp
standard UNIX timestamp.
Returns void

See Also insert_metar()

get_metar

public string get_metar( string $icao )

  Gets a METAR form the database.

Parameter
string $icao
ICAO of the station.
Returns string

The raw METAR as an array from the database.


lookup_icao

public string lookup_icao( string $icao )

  Translates an ICAO into a station name
The boring ICAO (e.g. EKYT) is translated into something like 'Aalborg, Denmark'.

Parameter
string $icao
ICAO one want's to translate.
Returns string

The full name of the station, including country.


get_countries

public array get_countries( )

  Returns a list of available countries.

Returns array

An associative array with the country-codes as the keys and the names of the countries as the values.


get_icaos

public array get_icaos( string $cc, string &$country )

  Returns an array of stations.

Parameter
string $cc
country-code.
string &$country
parameter is passed by reference. The name of the country that corresponds to the country-code is stored here.
Returns array

An associative array with the ICAO as the key and the name of the station as the values. The name of the country is not added to the name of the station.


Private Method Details

create_tables

private bool create_tables( )

  Creates the necessary tables in the database.

Returns bool

Returns true if it could connect to the database, false otherwise.


insert_stations

private bool insert_stations( array $data, array $countries )

  Inserts the stations into the database.
It is assumed that create_tables() has been called previously (and that it returned true), so that the necessary tables are already created.

Parameter
array $data
three-dimensional array starts with a list of contry-codes. For each country-code the ICAOs and corresponding locations in that particular country are listed as key => value pairs.
array $countries
associative array with country-codes as the keys and the names of the countries as the values.
Returns bool



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta