[ all elements ]
Packages:
NsmReports

Index of all elements

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ r ] [ s ] [ t ] [ u ] [ v ] [ y ] [ z ] [ _ ]

a

$access_key
in file nsm_saved_report.php, variable Nsm_saved_report::$access_key
    The security key to be used to access the preset
$active
in file nsm_saved_report.php, variable Nsm_saved_report::$active
    Active status of preset
$author
in file nsm_report_base.php, variable Nsm_report_base::$author
    Name and/or company of the report's creator
$author
in file channels_complex_report.php, variable Channels_complex_report::$author
    Name and/or company of the report's creator
$author
in file members_report.php, variable Members_report::$author
    Name and/or company of the report's creator
$author
in file channels_simple_report.php, variable Channels_simple_report::$author
    Name and/or company of the report's creator
activate_extension
in file ext.nsm_reports.php, method Nsm_reports_ext::activate_extension()
    Called by ExpressionEngine when the user activates the extension.
add
in file nsm_saved_report.php, method Nsm_saved_report::add()
    Inserts the instance into the database.
addCpCss
in file nsm_reports_helper.php, method Nsm_reports_helper::addCpCss()
    Adds CSS to the CP
addCpJs
in file nsm_reports_helper.php, method Nsm_reports_helper::addCpJs()
    Adds JS to the CP
addCpThemeAsset
in file nsm_reports_helper.php, method Nsm_reports_helper::addCpThemeAsset()
    Adds either CSS or JS to the CP
top

c

$cache_path
in file channels_simple_report.php, variable Channels_simple_report::$cache_path
    The file-path where the report output can be stored on the server
$cache_path
in file members_report.php, variable Members_report::$cache_path
    The file-path where the report output can be stored on the server
$cache_path
in file nsm_report_base.php, variable Nsm_report_base::$cache_path
    The file-path where the report output can be stored on the server
$cache_path
in file channels_complex_report.php, variable Channels_complex_report::$cache_path
    The file-path where the report output can be stored on the server
$config
in file nsm_report_base.php, variable Nsm_report_base::$config
    Default report configuration options with '_output' as a minumum entry
$config
in file channels_simple_report.php, variable Channels_simple_report::$config
    Default report configuration options with '_output' as a minumum entry
$config
in file members_report.php, variable Members_report::$config
    Default report configuration options with '_output' as a minumum entry
$config
in file nsm_saved_report.php, variable Nsm_saved_report::$config
    Preset configuration options as json-decoded array
$config
in file channels_complex_report.php, variable Channels_complex_report::$config
    Default report configuration options with '_output' as a minumum entry
$created_at
in file nsm_saved_report.php, variable Nsm_saved_report::$created_at
    Unix-timestamp of the creation date
Channels_complex_report
in file channels_complex_report.php, class Channels_complex_report
    Report object
Channels_simple_report
in file channels_simple_report.php, class Channels_simple_report
    Report object
checkbox
in file nsm_reports_helper.php, method Nsm_reports_helper::checkbox()
    Creates a checkbox w/ optional label
config.php
procedural page config.php
configHTML
in file members_report.php, method Members_report::configHTML()
    Returns Control Panel HTML to configure report if report type is complex or returns 'false' if simple
configHTML
in file nsm_report_base.php, method Nsm_report_base::configHTML()
    Returns Control Panel HTML to configure report if report type is complex or returns 'false' if simple
configHTML
in file channels_complex_report.php, method Channels_complex_report::configHTML()
    Returns Control Panel HTML to configure report if report type is complex or returns 'false' if simple
configure
in file mcp.nsm_reports.php, method Nsm_reports_mcp::configure()
    Generates the report summary and configuration form for the selected report.
configure_submit
in file mcp.nsm_reports.php, method Nsm_reports_mcp::configure_submit()
    Manages program flow for submitted data sent from method Nsm_reports_mcp::configure.
createTable
in file nsm_saved_report.php, method Nsm_saved_report::createTable()
    Create the model's table in the database
channels_complex_report.php
procedural page channels_complex_report.php
configuration.php
procedural page configuration.php
channels_simple_report.php
procedural page channels_simple_report.php
configuration.php
procedural page configuration.php
config.php
procedural page config.php
top

d

$default_channel_settings
in file ext.nsm_reports.php, variable Nsm_reports_ext::$default_channel_settings
$default_member_group_settings
in file ext.nsm_reports.php, variable Nsm_reports_ext::$default_member_group_settings
$default_site_settings
in file ext.nsm_reports.php, variable Nsm_reports_ext::$default_site_settings
$description
in file nsm_saved_report.php, variable Nsm_saved_report::$description
    Description of preset configuration
$description
in file ext.nsm_reports.php, variable Nsm_reports_ext::$description
$docs_url
in file members_report.php, variable Members_report::$docs_url
    A URL to the report's documentation (optional)
$docs_url
in file channels_simple_report.php, variable Channels_simple_report::$docs_url
    A URL to the report's documentation (optional)
$docs_url
in file channels_complex_report.php, variable Channels_complex_report::$docs_url
    A URL to the report's documentation (optional)
$docs_url
in file nsm_report_base.php, variable Nsm_report_base::$docs_url
    A URL to the report's documentation (optional)
$docs_url
in file ext.nsm_reports.php, variable Nsm_reports_ext::$docs_url
delete
in file nsm_saved_report.php, method Nsm_saved_report::delete()
    Deletes the preset from the database
deleteByIds
in file nsm_saved_report.php, method Nsm_saved_report::deleteByIds()
    Deletes preset configurations from database where the IDs match the parameter array
delete_saved
in file mcp.nsm_reports.php, method Nsm_reports_mcp::delete_saved()
    Displays a confirmation form for the delete command and lists items to be deleted.
delete_saved_submit
in file mcp.nsm_reports.php, method Nsm_reports_mcp::delete_saved_submit()
    Deletes all presets where ID is sent in Nsm_report_mcp::delete_saved form.
disable_extension
in file ext.nsm_reports.php, method Nsm_reports_ext::disable_extension()
    Called by ExpressionEngine when the user disables the extension.
download
in file nsm_report_base.php, method Nsm_report_base::download()
    Forces user to download generated report by sending appropriate HTTP Header details
download_generated_report
in file mcp.nsm_reports.php, method Nsm_reports_mcp::download_generated_report()
    Security checkpoint for downloading generated reports.
dummy_hook_function
in file ext.nsm_reports.php, method Nsm_reports_ext::dummy_hook_function()
delete.php
procedural page delete.php
top

e

$email_address
in file nsm_saved_report.php, variable Nsm_saved_report::$email_address
    Email Recipient of generated reports
$error
in file nsm_report_base.php, variable Nsm_report_base::$error
    Stores any report errors that are encountered and saved at report run
$error
in file channels_complex_report.php, variable Channels_complex_report::$error
    Stores any report errors that are encountered and saved at report run
$error
in file members_report.php, variable Members_report::$error
    Stores any report errors that are encountered and saved at report run
$error
in file channels_simple_report.php, variable Channels_simple_report::$error
    Stores any report errors that are encountered and saved at report run
email_report
in file nsm_report_base.php, method Nsm_report_base::email_report()
    Sends an email using incoming 'email_config' parameters and 'attachments' collection of reports
ext.nsm_reports.php
procedural page ext.nsm_reports.php
top

f

find
in file nsm_reports_model.php, method Nsm_reports_model::find()
    Retrieves a report from the reports directory.
findAll
in file nsm_saved_report.php, method Nsm_saved_report::findAll()
    Finds all saved report presets and returns them as an array of object instances
findById
in file nsm_saved_report.php, method Nsm_saved_report::findById()
    Returns a single instance of a configuration preset from the database matching the ID
findByIdKey
in file nsm_saved_report.php, method Nsm_saved_report::findByIdKey()
    Returns report preset objects matching the id and access key
findByIds
in file nsm_saved_report.php, method Nsm_saved_report::findByIds()
    Returns array of report preset objects that appear in the array parameter
find_all
in file nsm_reports_model.php, method Nsm_reports_model::find_all()
    Retrieves all reports that appear in the reports directory as an array
top

g

generate
in file nsm_report_base.php, method Nsm_report_base::generate()
    Process report and output an array defining the generated report for later file-based processing
generate
in file mcp.nsm_reports.php, method Nsm_reports_mcp::generate()
    Generates a report result-set and performs an action depending on conditions
generateResults
in file nsm_report_base.php, method Nsm_report_base::generateResults()
    Generates the SQL query string and returns the results as an array
generateResults
in file members_report.php, method Members_report::generateResults()
    Generates the SQL query string and returns the results as an array
generateResults
in file channels_simple_report.php, method Channels_simple_report::generateResults()
    Generates the SQL query string and returns the results as an array
generateResults
in file channels_complex_report.php, method Channels_complex_report::generateResults()
    Generates the SQL query string and returns the results as an array
getInfo
in file nsm_report_base.php, method Nsm_report_base::getInfo()
    Returns an array of the report's static variables
get_report_path
in file nsm_reports_model.php, method Nsm_reports_model::get_report_path()
    Returns the report path that the object is using
top

h

$hooks
in file ext.nsm_reports.php, variable Nsm_reports_ext::$hooks
top

i

$id
in file nsm_saved_report.php, variable Nsm_saved_report::$id
    Preset configuration Database Identifier
index
in file mcp.nsm_reports.php, method Nsm_reports_mcp::index()
    Processes the module's DashBoard page by finding all reports and listing them.
install
in file upd.nsm_reports.php, method Nsm_reports_upd::install()
    Installs the module
index.php
procedural page index.php
index.php
procedural page index.php
top

l

$lastrun_at
in file nsm_saved_report.php, variable Nsm_saved_report::$lastrun_at
    Unix-timestamp of the last time that the preset was run
lang.nsm_reports.php
procedural page lang.nsm_reports.php
top

m

mcp.nsm_reports.php
procedural page mcp.nsm_reports.php
Members_report
in file members_report.php, class Members_report
    Report object
mod.nsm_reports.php
procedural page mod.nsm_reports.php
members_report.php
procedural page members_report.php
top

n

$name
in file ext.nsm_reports.php, variable Nsm_reports_ext::$name
$notes
in file channels_complex_report.php, variable Channels_complex_report::$notes
    Basic description of the report
$notes
in file nsm_report_base.php, variable Nsm_report_base::$notes
    Basic description of the report
$notes
in file members_report.php, variable Members_report::$notes
    Basic description of the report
$notes
in file channels_simple_report.php, variable Channels_simple_report::$notes
    Basic description of the report
nsm_reports_helper.php
procedural page nsm_reports_helper.php
nsm_reports_model.php
procedural page nsm_reports_model.php
nsm_report_base.php
procedural page nsm_report_base.php
nsm_saved_report.php
procedural page nsm_saved_report.php
Nsm_reports
in file mod.nsm_reports.php, class Nsm_reports
    Module Tags Library
Nsm_reports_ext
in file ext.nsm_reports.php, class Nsm_reports_ext
    Reports extension
Nsm_reports_helper
in file nsm_reports_helper.php, class Nsm_reports_helper
    Extends EE Control Panel functions
Nsm_reports_mcp
in file mcp.nsm_reports.php, class Nsm_reports_mcp
    The Module Control Panel class
Nsm_reports_model
in file nsm_reports_model.php, class Nsm_reports_model
    Reports model class
Nsm_reports_upd
in file upd.nsm_reports.php, class Nsm_reports_upd
    Module Install/Uninstall/Update management object
Nsm_report_base
in file nsm_report_base.php, class Nsm_report_base
    Base model for NSM Reports
Nsm_saved_report
in file nsm_saved_report.php, class Nsm_saved_report
    Model for Saved Report Configurations
top

o

$output
in file nsm_saved_report.php, variable Nsm_saved_report::$output
    Output type of generated reports
$output_types
in file members_report.php, variable Members_report::$output_types
    Valid report output types
$output_types
in file channels_complex_report.php, variable Channels_complex_report::$output_types
    Valid report output types
$output_types
in file channels_simple_report.php, variable Channels_simple_report::$output_types
    Valid report output types
$output_types
in file nsm_report_base.php, variable Nsm_report_base::$output_types
    Valid report output types
outputBrowser
in file members_report.php, method Members_report::outputBrowser()
    Renders a View from the report results to display in the browser
outputBrowser
in file nsm_report_base.php, method Nsm_report_base::outputBrowser()
    Renders a View from the report results to display in the browser
outputBrowser
in file channels_complex_report.php, method Channels_complex_report::outputBrowser()
    Renders a View from the report results to display in the browser
outputCSV
in file channels_complex_report.php, method Channels_complex_report::outputCSV()
    Builds Comma-Seperated-Value string from report results
outputCSV
in file nsm_report_base.php, method Nsm_report_base::outputCSV()
    Builds Comma-Seperated-Value string from report results
outputHTML
in file nsm_report_base.php, method Nsm_report_base::outputHTML()
    Builds HTML string from report results
outputHTML
in file channels_complex_report.php, method Channels_complex_report::outputHTML()
    Builds HTML string from report results
outputTSV
in file nsm_report_base.php, method Nsm_report_base::outputTSV()
    Builds Tab-Seperated-Value string from report results
outputTSV
in file channels_complex_report.php, method Channels_complex_report::outputTSV()
    Builds Tab-Seperated-Value string from report results
outputXML
in file nsm_report_base.php, method Nsm_report_base::outputXML()
    Builds an XML string from report results
outputXML
in file channels_complex_report.php, method Channels_complex_report::outputXML()
    Builds an XML string from report results
output_browser.php
procedural page output_browser.php
output_browser.php
procedural page output_browser.php
output_browser.php
procedural page output_browser.php
top

r

$report
in file nsm_saved_report.php, variable Nsm_saved_report::$report
    The class name of the module that the preset is assigned to
$report_path
in file nsm_report_base.php, variable Nsm_report_base::$report_path
    The file-path where the report is located and is used for including report views
$report_path
in file channels_complex_report.php, variable Channels_complex_report::$report_path
    The file-path where the report is located and is used for including report views
$report_path
in file nsm_reports_model.php, variable Nsm_reports_model::$report_path
    File-path of module reports directory
$report_path
in file members_report.php, variable Members_report::$report_path
    The file-path where the report is located and is used for including report views
$report_path
in file channels_simple_report.php, variable Channels_simple_report::$report_path
    The file-path where the report is located and is used for including report views
$run_count
in file nsm_saved_report.php, variable Nsm_saved_report::$run_count
    Number of times that the report preset has been run
top

s

$settings
in file ext.nsm_reports.php, variable Nsm_reports_ext::$settings
$settings_exist
in file ext.nsm_reports.php, variable Nsm_reports_ext::$settings_exist
$sql
in file channels_complex_report.php, variable Channels_complex_report::$sql
    Stores the generated SQL statement used by the report
$sql
in file channels_simple_report.php, variable Channels_simple_report::$sql
    Stores the generated SQL statement used by the report
$sql
in file nsm_report_base.php, variable Nsm_report_base::$sql
    Stores the generated SQL statement used by the report
$sql
in file members_report.php, variable Members_report::$sql
    Stores the generated SQL statement used by the report
save
in file mcp.nsm_reports.php, method Nsm_reports_mcp::save()
    Saves a report configuration as a preset and stores options in the database.
saved_reports
in file mcp.nsm_reports.php, method Nsm_reports_mcp::saved_reports()
    Displays all saved report presets and displays them as a table.
selectbox
in file nsm_reports_helper.php, method Nsm_reports_helper::selectbox()
    Creates a select box
setConfig
in file nsm_report_base.php, method Nsm_report_base::setConfig()
    Merges incoming configuration options with default options and sets the report config
setData
in file nsm_saved_report.php, method Nsm_saved_report::setData()
    Assigns applicable data from array to the object
settings_form
in file ext.nsm_reports.php, method Nsm_reports_ext::settings_form()
    Render the custom settings form and processes post vars
set_report_path
in file nsm_reports_model.php, method Nsm_reports_model::set_report_path()
    Sets the folder path that the object is using
settings.php
procedural page settings.php
top

t

$title
in file nsm_report_base.php, variable Nsm_report_base::$title
    Displays the report name in the control panel
$title
in file nsm_saved_report.php, variable Nsm_saved_report::$title
    Preset configuration name
$title
in file channels_complex_report.php, variable Channels_complex_report::$title
    Displays the report name in the control panel
$title
in file members_report.php, variable Members_report::$title
    Displays the report name in the control panel
$title
in file channels_simple_report.php, variable Channels_simple_report::$title
    Displays the report name in the control panel
$type
in file channels_complex_report.php, variable Channels_complex_report::$type
    Report type as either 'simple' or 'complex'
$type
in file members_report.php, variable Members_report::$type
    Report type as either 'simple' or 'complex'
$type
in file nsm_report_base.php, variable Nsm_report_base::$type
    Report type as either 'simple' or 'complex'
$type
in file channels_simple_report.php, variable Channels_simple_report::$type
    Report type as either 'simple' or 'complex'
tabs
in file upd.nsm_reports.php, method Nsm_reports_upd::tabs()
    Returns the static tab array
top

u

$updated_at
in file nsm_saved_report.php, variable Nsm_saved_report::$updated_at
    Unix-timestamp of the last update
uninstall
in file upd.nsm_reports.php, method Nsm_reports_upd::uninstall()
    Uninstalls the module
upd.nsm_reports.php
procedural page upd.nsm_reports.php
update
in file upd.nsm_reports.php, method Nsm_reports_upd::update()
    Updates the module
update
in file nsm_saved_report.php, method Nsm_saved_report::update()
    Updates the saved preset details in the database with the new values.
update_extension
in file ext.nsm_reports.php, method Nsm_reports_ext::update_extension()
    Called by ExpressionEngine updates the extension
top

v

$version
in file nsm_report_base.php, variable Nsm_report_base::$version
    Version number of report as a string to preserve decimal points
$version
in file upd.nsm_reports.php, variable Nsm_reports_upd::$version
    Current version of module that is displayed in Modules page in the Control Panel
$version
in file members_report.php, variable Members_report::$version
    Version number of report as a string to preserve decimal points
$version
in file ext.nsm_reports.php, variable Nsm_reports_ext::$version
$version
in file channels_simple_report.php, variable Channels_simple_report::$version
    Version number of report as a string to preserve decimal points
$version
in file channels_complex_report.php, variable Channels_complex_report::$version
    Version number of report as a string to preserve decimal points
top

y

yesNoRadioGroup
in file nsm_reports_helper.php, method Nsm_reports_helper::yesNoRadioGroup()
    Yes / No radio group
top

z

zip_report
in file nsm_report_base.php, method Nsm_report_base::zip_report()
    Takes incoming 'file' array and adds information to new zip archive
top

_

_createSettingsTable
in file ext.nsm_reports.php, method Nsm_reports_ext::_createSettingsTable()
    Creates the settings table table if it doesn't already exist.
_renderLayout
in file mcp.nsm_reports.php, method Nsm_reports_mcp::_renderLayout()
    Manages View display for Expression Engine control panel.
__construct
in file nsm_reports_model.php, method Nsm_reports_model::__construct()
    PHP5 constructor function.
__construct
in file nsm_report_base.php, method Nsm_report_base::__construct()
    PHP5 constructor function.
__construct
in file nsm_reports_helper.php, method Nsm_reports_helper::__construct()
    Constructs the class and sets the addon id
__construct
in file nsm_saved_report.php, method Nsm_saved_report::__construct()
    PHP5 constructor function.
__construct
in file upd.nsm_reports.php, method Nsm_reports_upd::__construct()
    PHP5 constructor function.
__construct
in file mod.nsm_reports.php, method Nsm_reports::__construct()
    PHP5 constructor function.
__construct
in file ext.nsm_reports.php, method Nsm_reports_ext::__construct()
    PHP5 constructor function.
__construct
in file channels_complex_report.php, method Channels_complex_report::__construct()
    PHP5 constructor function.
__construct
in file mcp.nsm_reports.php, method Nsm_reports_mcp::__construct()
    PHP5 constructor function.
__construct
in file members_report.php, method Members_report::__construct()
    PHP5 constructor function.
__construct
in file channels_simple_report.php, method Channels_simple_report::__construct()
    PHP5 constructor function.
__toString
in file nsm_report_base.php, method Nsm_report_base::__toString()
    PHP5 toString function.
__toString
in file nsm_saved_report.php, method Nsm_saved_report::__toString()
    PHP5 toString function.
top
Documentation generated on Fri, 11 Mar 2011 10:05:48 +1100 by phpDocumentor 1.4.3