Class: WBactivityLog

Source Location: /WBactivityLog.php

Class Overview

WBobject
   |
   --WBactivityLog

This class manages WBactivityLog objects. Details of the key events (built-in the methods of the various classes) that have happened in relation to an application.

Author(s):

Pierre-Dominique Vienne <pvienne@me.com>

Version:

Variables

Methods

Inherited Methods

Class: WBobject

WBobject::__construct(): Construction function
WBobject::addToDB(): Rows insertion to database function
WBobject::deleteFromDB(): Rows deletion function
WBobject::getIDrowname(): ID rowname obtention function
WBobject::getObjects(): Objects list obtention function
WBobject::getUniqueFromDB(): Unique Row obtention function
WBobject::objectToArray(): Object to array transformation function
WBobject::updateDB(): Rows update function

Class Details

[line 33]
This class manages WBactivityLog objects. Details of the key events (built-in the methods of the various classes) that have happened in relation to an application.

Created on 25 jun 09

Changes: 1.1 -> 1.2: 15 jul 09 updated: file is PEAR compatible 1.0 -> 1.1: 03 jul 09 added: $this->sIDrowname, $this->aObjects

Tags:

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

[ Top ]

Class Variables

$aObjects = array(
        "wbActivityLogApplication" => "WBapplication",
        "wbActivityLogUser" => "WBuser",
        "wbActivityLogProfile" => "WBprofile"
    )

[line 106]

Variable that contains objects list

Tags:

access:

protected

Type:

array

[ Top ]

$database = "prysma"

[line 39]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$sIDrowname = "wbActivityLogID"

[line 101]

Variable that contains ID rowname

Tags:

access:

protected

Type:

string

[ Top ]

$table = "WBactivityLog"

[line 44]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$wbActivityLogAction =

[line 85]

Variable that contains action performed

Tags:

access:

public

Type:

string

[ Top ]

$wbActivityLogApplication =

[line 55]

Variable that contains application object

Tags:

access:

public

Type:

object

[ Top ]

$wbActivityLogApplicationID =

[line 60]

Variable that contains application ID

Tags:

access:

public

Type:

int

[ Top ]

$wbActivityLogConclusion =

[line 95]

Variable that contains conclusion (action result)

Tags:

access:

public

Type:

string

[ Top ]

$wbActivityLogID =

[line 50]

Variable that contains object ID

Tags:

access:

public

Type:

int

[ Top ]

$wbActivityLogProfile =

[line 75]

Variable that contains profile object

Tags:

access:

public

Type:

object

[ Top ]

$wbActivityLogProfileID =

[line 80]

Variable that contains profile ID

Tags:

access:

public

Type:

int

[ Top ]

$wbActivityLogTarget =

[line 90]

Variable that contains target (expected result)

Tags:

access:

public

Type:

string

[ Top ]

$wbActivityLogUser =

[line 65]

Variable that contains user object

Tags:

access:

public

Type:

object

[ Top ]

$wbActivityLogUserID =

[line 70]

Variable that contains user ID

Tags:

access:

public

Type:

int

[ Top ]

Class Methods

method createWBactivityLog [line 162]

object created createWBactivityLog(
object
$this->wbActivityLogApplication, object
$this->wbActivityLogUser, object
$this->wbActivityLogProfile, string
$this->wbActivityLogAction, string
$this->wbActivityLogTarget, string
$this->wbActivityLogConclusion)

WBactivityLog object creation function

This function is used to create a WBactivityLog object Result is stored in $this and object is returned

<?php
$aVars = array(
"wbActivityLogApplication" => $oWBapplication,
"wbArtivityLogUser" => $oWBuser,
"wbActivityLogProfile" => $oWBprofile,
"wbActivityLogAction" => "fooAction",
"wbActivityLogTarget" => "barTarget",
"wbActivityLogConclusion" => "fooConclusion"
);
$oWBactivityLog = new WBactivityLog($aVars);
echo $oWBactivityLog->createWBactivityLog()->wbActivityLogID;
// activitylogID
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::addToDB()

Parameters:

object	$this->wbActivityLogApplication	WBapplication that has created the log (required)
object	$this->wbActivityLogUser	WBuser that has made the request (required)
object	$this->wbActivityLogProfile	WBprofile used when the log has been made (required)
string	$this->wbActivityLogAction	description of the action performed
string	$this->wbActivityLogTarget	expected result from the method
string	$this->wbActivityLogConclusion	conclusion of the action as recorded in the method

[ Top ]

method deleteWBactivityLog [line 432]

bool deleteWBactivityLog(
int
$this->wbActivityLogID)

WBactivityLog object deletion function

This function is used to delete a WBactivityLog by its ID Result is returned

<?php
$aVars = array("wbActivityLogID" => 12);
$oWBactivityLog = new WBactivityLog($aVars);
echo $oWBactivityLog->deleteWBactivityLog();
// 1
?>

Tags:

return:	true or false weither the object could be deleted or not
since:	Version 1.0
uses:	WBobject::deleteFromDB()

Parameters:

int

$this->wbActivityLogID

ID of the activity log to be deleted (required)

[ Top ]

method getWBactivityLog [line 477]

object WBactivityLog getWBactivityLog(
int
$this->wbActivityLogID)

WBactivityLog object obtention function

This function is used to get a WBactivityLog by its ID Result is returned

<?php
$aVars = array("wbActivityLogID" => 12);
$oWBactivityLog = new WBactivityLog($aVars);
echo $oWBactivityLog->getWBactivityLog()->wbProfileName;
// fooName
?>

Tags:

return:	object
since:	Version 1.0
uses:	WBuser::getWBuser()
uses:	WBprofile::getWBprofile()
uses:	WBobject::getUniqueFromDB()
uses:	WBapplication::getWBapplication()

Parameters:

int

$this->wbActivityLogID

ID of the activity log to get (required)

[ Top ]

method updateWBactivityLog [line 302]

object updated updateWBactivityLog(
int
$this->wbActivityLogID, object
$this->wbActivityLogApplication, object
$this->wbActivityLogUser, object
$this->wbActivityLogProfile, string
$this->wbActivityLogAction, string
$this->wbActivityLogTarget, string
$this->wbActivityLogConclusion)

WBactivityLog object update function

This function is used to update a WBactivityLog Result is stored in $this and object is returned

<?php
$aVars = array(
"wbActivityLogID" => 12,
"wbActivityLogApplication" => $oWBapplication,
"wbActivityLogUser" => $oWBuser,
"wbActivityLogProfile" => $oWBprofile,
"wbActivityLogAction" => "fooAction",
"wbActivityLogTarget" => "barTarget",
"wbActivityLogConclusion" => "fooConclusion"
);
$oWBactivityLog = new WBactivityLog($aVars);
echo $oWBactivityLog->updateWBactivityLog()->wbActivityLogID;
// 12
?>

Tags:

return:	object or false
since:	Version 1.0
uses:	WBobject::updateDB()

Parameters:

int	$this->wbActivityLogID	ID of the activity log to be updated (required)
object	$this->wbActivityLogApplication	application of the activity log (required)
object	$this->wbActivityLogUser	user of the activity log (required)
object	$this->wbActivityLogProfile	profile of the user of the activity log (required)
string	$this->wbActivityLogAction	action of the activity log (required)
string	$this->wbActivityLogTarget	target of the activity log (required)
string	$this->wbActivityLogConclusion	conclusion of the activity log (required)

[ Top ]

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

Class: WBactivityLog

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Methods

Class: WBobject

Class Details

Tags:

Class Variables

$aObjects = array( "wbActivityLogApplication" => "WBapplication", "wbActivityLogUser" => "WBuser", "wbActivityLogProfile" => "WBprofile" )

Tags:

$database = "prysma"

Tags:

$sIDrowname = "wbActivityLogID"

Tags:

$table = "WBactivityLog"

Tags:

$wbActivityLogAction =

Tags:

$wbActivityLogApplication =

Tags:

$wbActivityLogApplicationID =

Tags:

$wbActivityLogConclusion =

Tags:

$wbActivityLogID =

Tags:

$wbActivityLogProfile =

Tags:

$wbActivityLogProfileID =

Tags:

$wbActivityLogTarget =

Tags:

$wbActivityLogUser =

Tags:

$wbActivityLogUserID =

Tags:

Class Methods

method createWBactivityLog [line 162]

Tags:

Parameters:

method deleteWBactivityLog [line 432]

Tags:

Parameters:

method getWBactivityLog [line 477]

Tags:

Parameters:

method updateWBactivityLog [line 302]

Tags:

Parameters:

$aObjects = array(
"wbActivityLogApplication" => "WBapplication",
"wbActivityLogUser" => "WBuser",
"wbActivityLogProfile" => "WBprofile"
)