C4::Reports::Guided - Module for generating guided reports
use C4::Reports::Guided;
This will return a list of all the available report areas
This will return a list of all the available report types
This will return a list of all the available report areas with groups
This will return a list of all tables in the database
This will return a list of all columns for a report area
This will build the sql needed to return the results asked for, $columns is expected to be of the format tablename.columnname. This is what get_columns returns.
Returns an arraref to hashrefs suitable for using in a tmpl_loop. With the criteria and available values.
($results, $error) = execute_query($sql, $offset, $limit)
When passed $sql, this function returns an array ref containing a result set suitably formatted for display in html or for output as a flat file when passed in $format and $id. It also returns the $total records available for the supplied query. If passed any query other than a SELECT, or if there is a db error, $errors an array ref is returned containing the error after this manner:
$error-{'sqlerr'}> contains the offending SQL keyword. $error-{'queryerr'}> contains the native db engine error returned for the query.
Valid values for $format are 'text,' 'tab,' 'csv,' or 'url. $sql, $type, $offset, and $limit are required parameters. If a valid $format is passed in, $offset and $limit are ignored for obvious reasons. A LIMIT specified by the user in a user-supplied SQL query WILL apply in any case.
Given some sql and a name this will saved it so that it can reused Returns id of the newly created report
This will take 2 reports and create a compound report using both of them
This takes a column name of the format table.column and will return what type it is (free text, set values, date)
Given a column name, return an arrary ref of hashrefs suitable for use as a tmpl_loop with the distinct values of the column
Returns an arrayref - hashref pair. The hashref consists of various code => name lists depending on the $authorised_value. The arrayref is the hashref keys, in appropriate order
my %reserved_authorised_values = GetReservedAuthorisedValues();
Returns a hash containig all reserved words
my $is_valid_ath_value = IsAuthorisedValueValid($authorised_value)
Returns 1 if $authorised_value is on the reserved authorised values list or in the authorised value categories defined in
my @sql_parameters = GetParametersFromSQL($sql)
Returns an arrayref of hashes containing the keys name and authval
my @problematic_parameters = ValidateSQLParameters($sql)
Returns an arrayref of hashes containing the keys name and authval of those SQL parameters that do not correspond to valid authorised names
Chris Cormack <crc@liblime.com>