Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleImporterAbstractDriver

LICENSE

INSTALL

Packages:

Classes:

Model
- arbitModuleModelImporterComment
- arbitModuleModelImporterIssue

View
- arbitImporterImportViewModel
- arbitImporterInitViewModel
- arbitImporterRegenPwdViewModel
- arbitModuleImporterMailHandler
- arbitModuleImporterXHtmlHandler

Importer::arbitModuleImporterAbstractDriver

Class arbitModuleImporterAbstractDriver

Base importer driver.

Author(s):

Version:	$Revision$
License:	GPL

Descendants

Child Class	Description
arbitModuleImporterRedmineDriver	Base importer driver.

Member Variables

protected PDO	`$pdo` db handle db handle
protected string	`$project` source project identifier from the old tracker source project identifier from the old tracker

Method Summary

public abstract bool	`checkProject( )` check if the user provided project exists in the database
public abstract void	`fetchAttachments( )` returns a stmt/map with all attachments data
public abstract void	`fetchComments( )` returns a stmt/map with all comments data
public abstract void	`fetchComponents( )` returns a stmt/map with name or a fixed array of components defined as:
public abstract void	`fetchIssues( )` returns a stmt/map with all issue data
public abstract void	`fetchPriority( )` returns a stmt/map with name or a fixed array of priorities defined as:
public abstract void	`fetchResolution( )` returns a stmt/map with name or a fixed array of resolutions defined as:
public array	`fetchRow( &$data , $data )` fetches a row, applies preprocessing call if needed and then replaces
public abstract void	`fetchStates( )` returns a stmt/map with name or a fixed array of states defined as:
public abstract void	`fetchTypes( )` returns a stmt/map with name or a fixed array of types defined as:
public abstract void	`fetchUsers( )` returns a stmt/map with all users data
public abstract void	`fetchVersions( )` returns a stmt/map with name and active or a fixed array of versions defined as:
public void	`init( $pdo , $project )` init function
protected PDOStatement	`query( $sql )` executes a query using the current db handle and returns a statement
protected mixed	`replaceData( $data , $row )` replaces the variables into a string by values from the current row

Methods

checkProject

bool checkProject( )

check if the user provided project exists in the database

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::checkProject()`	check if the user provided project exists in the database

fetchAttachments

void fetchAttachments( )

returns a stmt/map with all attachments data

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchAttachments()`	returns a stmt/map with all attachments data

fetchComments

void fetchComments( )

returns a stmt/map with all comments data

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchComments()`	returns a stmt/map with all comments data

fetchComponents

void fetchComponents( )

returns a stmt/map with name or a fixed array of components defined as:

returns a stmt/map with name or a fixed array of components defined as: 'string(name)' => array()

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchComponents()`	returns a stmt/map with name or a fixed array of components defined as:

fetchIssues

void fetchIssues( )

returns a stmt/map with all issue data

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchIssues()`	returns a stmt/map with all issue data

fetchPriority

void fetchPriority( )

returns a stmt/map with name or a fixed array of priorities defined as:

returns a stmt/map with name or a fixed array of priorities defined as: use arbitModuleImporterController::normalize to generate the normalized version if you provide static values, otherwise it will be done automatically on the result set 'string(normalized name)' => 'string(display name)'

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchPriority()`	returns a stmt/map with name or a fixed array of priorities defined as:

fetchResolution

void fetchResolution( )

returns a stmt/map with name or a fixed array of resolutions defined as:

returns a stmt/map with name or a fixed array of resolutions defined as: use arbitModuleImporterController::normalize to generate the normalized version if you provide static values, otherwise it will be done automatically on the result set 'string(normalized name)' => 'string(display name)'

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchResolution()`	returns a stmt/map with name or a fixed array of resolutions defined as:

fetchRow

array fetchRow( &$data , array $data )

fetches a row, applies preprocessing call if needed and then replaces

fetches a row, applies preprocessing call if needed and then replaces variables according to provided param map

Parameters:

Name	Type	Description
`$data`	array
`&$data`	array

fetchStates

void fetchStates( )

returns a stmt/map with name or a fixed array of states defined as:

returns a stmt/map with name or a fixed array of states defined as: use arbitModuleImporterController::normalize to generate the normalized version if you provide static values, otherwise it will be done automatically on the result set 'string(normalized name)' => 'string(display name)'

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchStates()`	returns a stmt/map with name or a fixed array of states defined as:

fetchTypes

void fetchTypes( )

returns a stmt/map with name or a fixed array of types defined as:

returns a stmt/map with name or a fixed array of types defined as: use arbitModuleImporterController::normalize to generate the normalized version if you provide static values, otherwise it will be done automatically on the result set 'string(normalized name)' => 'string(display name)'

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchTypes()`	returns a stmt/map with name or a fixed array of types defined as:

fetchUsers

void fetchUsers( )

returns a stmt/map with all users data

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchUsers()`	returns a stmt/map with all users data

fetchVersions

void fetchVersions( )

returns a stmt/map with name and active or a fixed array of versions defined as:

returns a stmt/map with name and active or a fixed array of versions defined as: 'string(name)' => 'int(active : 1/0)'

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::fetchVersions()`	returns a stmt/map with name and active or a fixed array of versions defined as:

init

void init( $pdo , string $project )

init function

Parameters:

Name	Type	Description
`$pdo`	PDO	PDO db handle
`$project`	string	project identifier

Redefined in descendants as:

Method	Description
`arbitModuleImporterRedmineDriver::init()`	init function, sets the connection charset to utf8

query

PDOStatement query( string $sql )

executes a query using the current db handle and returns a statement

executes a query using the current db handle and returns a statement use :project in the query to specify the current project id

Parameters:

Name	Type	Description
`$sql`	string	sql query

replaceData

mixed replaceData( mixed $data , array $row )

replaces the variables into a string by values from the current row

replaces the variables into a string by values from the current row if an array is passed, it works recursively on it

Parameters:

Name	Type	Description
`$data`	mixed	string or array containing strings/arrays, other types are ignored
`$row`	array	fetched row from the database

Documentation generated on Mon, 05 Apr 2010 14:01:27 +0200 by phpDocumentor 1.4.3