Class: EW_People

Source Location: /EW_People.php

Class Overview

Created on 01 mars 09

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Class Details

[line 16]
Created on 01 mars 09

This class manages EVS People objects.

Changes: 1.0 to 2.0: phpdoc compatible in the way to generate documentation

Tags:

author:	Pierre-Dominique Vienne <pvienne@me.com>
version:	2.0
license:	GNU Public License

[ Top ]

Class Variables

$database = "prysma"

[line 22]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 66]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$peo_firstname =

[line 44]

Variable that contains people firstname

Tags:

access:

public

Type:

string

[ Top ]

$peo_id =

[line 34]

Variable that contains people ID

Tags:

access:

public

Type:

int

[ Top ]

$peo_lastname =

[line 39]

Variable that contains people lastname

Tags:

access:

public

Type:

string

[ Top ]

$peo_pass =

[line 54]

Variable that contains NOT CRYPTED password

Tags:

access:

public

Type:

string

[ Top ]

$peo_user =

[line 49]

Variable that contains people email (username)

Tags:

access:

public

Type:

string

[ Top ]

$result =

[line 60]

Variable that contains Select results

Tags:

access:

public

Type:

array

[ Top ]

$table = "ew_people"

[line 27]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor __construct [line 91]

EW_People __construct(
[array
$aParams = null], [string
$sAction = null])

Construction function

This function is used when object is generated. It places variables in "$this" var and can launch function

<?php
$aParams = array("peo_lastname"=>"Vienne");
$oEW_People = new EW_People($aParams);
echo $oEW_People->peo_lastname;
// Vienne
?>

Tags:

since:	Version 1.0
uses:	Strings

Parameters:

array	$aParams	array containing variable names and their value ($variablename => $value)
string	$sAction	string containing action to perform on object creation

[ Top ]

method Connect [line 140]

int Connect(
string
$this->peo_user, string
$this->peo_pass, string
$this->database, string
$this->table)

Connection function

This function is used to check a user login / pass. Result is returned

<?php
$aParams = array("peo_user"=>"pvienne@me.com","peo_pass"=>$password);
$oEW_People = new EW_People($aParams);
echo $oEW_People->Connect();
// 4
?>

Tags:

return:	people ID
since:	Version 1.0
uses:	MySQL::SelectRow

Parameters:

string	$this->peo_user	username (required)
string	$this->peo_pass	password (required)
string	$this->database	database name
string	$this->table	table name

[ Top ]

method getByID [line 200]

int getByID(
string
$this->peo_id, string
$this->database, string
$this->table)

People by ID obtention function

This function is used to get a user by its ID. Result is stored in $this->lastname, $this->firstname, $this->peo_user, $this->pass and username is returned

<?php
$aParams = array("peo_id"=>12);
$oEW_People = new EW_People($aParams,"getByID");
echo $oEW_People->peo_lastname;
// Vienne
?>

Tags:

return:	people ID
since:	Version 1.0
uses:	MySQL::SelectRow

Parameters:

string	$this->peo_id	people ID (required)
string	$this->database	database name
string	$this->table	table name

[ Top ]

Documentation generated on Wed, 26 Aug 2009 12:30:10 +0200 by phpDocumentor 1.4.1