Referência à classe MJasperReport

Diagrama de heranças da classe MJasperReport

Membros públicos
	__construct ($db='admin', $connectionType='local')
	execute ($module, $name, $parameters=NULL, $filetype='PDF', $save=FALSE, $onlyGenerate=FALSE)
	getReportFilePath ($module, $name, $parameters=NULL, $filetype='PDF', $save=FALSE)
	generatePhpJasper ($fileIn, $fileOut, $filetype, $parameters, $classPath, $download=true)
	fill ($fileIn, $fileOut, $filetype, $parameters, $classPath, $save, $download=true)
	executeJRXML ($module, $name, $parameters=NULL, $filetype='PDF', $save=FALSE, $download=false)
	setQuery ($query)
	getQuery ()
	getAbsoluteFileOut ()
	setAbsoluteFileOut ($absoluteFileOut)
	beforeGenerateReport ()
	afterGenerateReport ()
	getArquivoRecemGerado ()
	setArquivoRecemGerado ($arquivoRecemGerado)

Membros públicos estáticos
static	getParameters ($module=null, $report=null)

Campos de Dados
const	JAVA_BIG_DECIMAL = 'java.math.BigDecimal'
const	JAVA_BOOLEAN = 'java.lang.Boolean'
const	JAVA_DATE = 'java.util.Date'
const	JAVA_DOUBLE = 'java.lang.Double'
const	JAVA_FLOAT = 'java.lang.Float'
const	JAVA_INTEGER = 'java.lang.Integer'
const	JAVA_LONG = 'java.lang.Long'
const	JAVA_NUMBER = 'java.lang.Number'
const	JAVA_SHORT = 'java.lang.Short'
const	JAVA_STRING = 'java.lang.String'
const	JAVA_TIME = 'java.sql.Time'
const	JAVA_TIMESTAMP = 'java.sql.Timestamp'
const	TYPE_BOOLEAN = 'boolean'
const	TYPE_DATE = 'date'
const	TYPE_FLOAT = 'float'
const	TYPE_INTEGER = 'integer'
const	TYPE_STRING = 'string'
const	TYPE_TIME = 'time'
const	TYPE_TIMESTAMP = 'timestamp'
	$filetype
	$fileout
	$fileexp
	$objDb
	$db
	$connectionType

Documentação dos Construtores & Destrutor

__construct()

__construct	(		$db = 'admin',
			$connectionType = 'local' )

MJasperReport constructor.

Parâmetros

string	$db	Database name.
string	$connectionType	Connection type.

Documentação das funções

afterGenerateReport()

afterGenerateReport

(

)

Callback method

beforeGenerateReport()

beforeGenerateReport

(

)

Callback method

execute()

execute	(		$module,
			$name,
			$parameters = NULL,
			$filetype = 'PDF',
			$save = FALSE,
			$onlyGenerate = FALSE )

Generate the report from a jasper file.

Parâmetros

string	$module	Module where the report is located.
string	$name	Name of the report (without extension).
array	$parameters	Parameters to be passed to the report.
string	$filetype	Report file type.
boolean	$save	Whether to save the report or download it.
boolean	$onlyGenerate	true to only generate the report file, without any browser action.

Retorna

integer Returns 1 if succeeded.

executeJRXML()

executeJRXML	(		$module,
			$name,
			$parameters = NULL,
			$filetype = 'PDF',
			$save = FALSE,
			$download = false )

Generate the report from a JRXML file.

Parâmetros

string	$module	Module where the report is located.
string	$name	Name of the report (without extension).
array	$parameters	Parameters to be passed to the report.
string	$filetype	Report file type.
boolean	$save	Whether to save the report or download it.
boolean	$download	Se for true, vai baixar o relatório, senão só gera o conteúdo.

Retorna

integer Returns 1 if succeeded.

fill()

fill	(		$fileIn,
			$fileOut,
			$filetype,
			$parameters,
			$classPath,
			$save,
			$download = true )

generatePhpJasper()

generatePhpJasper	(		$fileIn,
			$fileOut,
			$filetype,
			$parameters,
			$classPath,
			$download = true )

Parâmetros

	$fileIn
	$fileOut
	$filetype
	$parameters
	$classPath
bool	$download

Retorna

bool

Excepções

Exception

getAbsoluteFileOut()

getAbsoluteFileOut

(

)

getArquivoRecemGerado()

getArquivoRecemGerado

(

)

Obtem o arquivo recém gerado.

Retorna

(string)

getParameters()

static getParameters ( $module = null, $report = null )

static

Get the report parameters. Return an array with this format: array( 'parameter1id' => array( 'type' => some of TYPE_ constants, 'ohterProperty' => 'propertyValue', ... ), 'parameter2id' => array( 'type' => some of TYPE_ constants, ... ), ... )

Parâmetros

string	$module	Report module.
string	$report	Report name.

Retorna

array Parameters array.

getQuery()

getQuery

(

)

Retorna

string SQL query.

getReportFilePath()

getReportFilePath	(		$module,
			$name,
			$parameters = NULL,
			$filetype = 'PDF',
			$save = FALSE )

Get the generated report filename.

Parâmetros

string	$module	Module where the report is located.
string	$name	Name of the report (without extension).
array	$parameters	Parameters to be passed to the report.
string	$filetype	Report file type.
boolean	$save	Whether to save the report or download it.

Retorna

string Path to the generated report file.

setAbsoluteFileOut()

setAbsoluteFileOut

(

$absoluteFileOut

)

setArquivoRecemGerado()

setArquivoRecemGerado

(

$arquivoRecemGerado

)

setQuery()

setQuery

(

$query

)

Parâmetros

string

$query

SQL query.

Documentação dos campos e atributos

$connectionType

$connectionType

$db

$db

$fileexp

$fileexp

$fileout

$fileout

$filetype

$filetype

$objDb

$objDb

JAVA_BIG_DECIMAL

const JAVA_BIG_DECIMAL = 'java.math.BigDecimal'

Java type constants.

JAVA_BOOLEAN

const JAVA_BOOLEAN = 'java.lang.Boolean'

JAVA_DATE

const JAVA_DATE = 'java.util.Date'

JAVA_DOUBLE

const JAVA_DOUBLE = 'java.lang.Double'

JAVA_FLOAT

const JAVA_FLOAT = 'java.lang.Float'

JAVA_INTEGER

const JAVA_INTEGER = 'java.lang.Integer'

JAVA_LONG

const JAVA_LONG = 'java.lang.Long'

JAVA_NUMBER

const JAVA_NUMBER = 'java.lang.Number'

JAVA_SHORT

const JAVA_SHORT = 'java.lang.Short'

JAVA_STRING

const JAVA_STRING = 'java.lang.String'

JAVA_TIME

const JAVA_TIME = 'java.sql.Time'

JAVA_TIMESTAMP

const JAVA_TIMESTAMP = 'java.sql.Timestamp'

TYPE_BOOLEAN

const TYPE_BOOLEAN = 'boolean'

Simplified type constants.

TYPE_DATE

const TYPE_DATE = 'date'

TYPE_FLOAT

const TYPE_FLOAT = 'float'

TYPE_INTEGER

const TYPE_INTEGER = 'integer'

TYPE_STRING

const TYPE_STRING = 'string'

TYPE_TIME

const TYPE_TIME = 'time'

TYPE_TIMESTAMP

const TYPE_TIMESTAMP = 'timestamp'

---

A documentação para esta classe foi gerada a partir do seguinte ficheiro:

• classes/ui/reports/mjasperreport.class.php