Basic HTML Reports - Revision history

Newacct at 07:56, 8 August 2010

2010-08-08T07:56:11Z

← Older revision		Revision as of 07:56, 8 August 2010
Line 130:		Line 130:

	$attrs = &$this->getFilterAttrs();		$attrs = &$this->getFilterAttrs();
	foreach ~~(array_keys~~($attrs) as $attribname)		foreach ($attrs as $attribname => $p_attrib)
	{		{
	~~$p_attrib = &$attrs[$attribname];~~
	$s_record[$attribname] = &$p_attrib->fetchValue($s_record);		$s_record[$attribname] = &$p_attrib->fetchValue($s_record);
	}		}
Line 153:		Line 152:

	== getFilterAttrs ==		== getFilterAttrs ==
	Get the attribute info for the fields you're going to use to sort/filter on so they render ~~normaly~~ on the screen.		Get the attribute info for the fields you're going to use to sort/filter on so they render normally on the screen.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function &getFilterAttrs()		function &getFilterAttrs()

Comp615 at 10:37, 2 August 2010

2010-08-02T10:37:46Z

← Older revision		Revision as of 10:37, 2 August 2010
Line 127:		Line 127:
	$s_record["name"] = $sessionManager->pageVar("name");		$s_record["name"] = $sessionManager->pageVar("name");
	$s_record["shift"] = $sessionManager->pageVar("shift");		$s_record["shift"] = $sessionManager->pageVar("shift");
	$s_record["date"] = $~~g_sessionManager~~->pageVar("date");		$s_record["date"] = $sessionManager->pageVar("date");

	$attrs = &$this->getFilterAttrs();		$attrs = &$this->getFilterAttrs();

Hapstance at 07:07, 5 December 2008

2008-12-05T07:07:57Z

← Older revision		Revision as of 07:07, 5 December 2008
Line 5:		Line 5:
	I'm going to focus firstly on the basics to get a report to appear on the screen, and then possibly expand this to include how I used the FPDF library to save PDF files since first you want to know how to do it in ATK.		I'm going to focus firstly on the basics to get a report to appear on the screen, and then possibly expand this to include how I used the FPDF library to save PDF files since first you want to know how to do it in ATK.

	Note: There is now a fully working set of example code submitted as a patch to the bugtracker. http://bugzilla.achievo.org/show_bug.cgi?id=1071 It is setup to be lesson11 of the demo.		'''Note:''' There is now a fully working set of example code submitted as a patch to the bugtracker. http://bugzilla.achievo.org/show_bug.cgi?id=1071 It is setup to be lesson11 of the demo.

	= Start with any empty node =		= Start with any empty node =

Hapstance at 07:07, 5 December 2008

2008-12-05T07:07:34Z

← Older revision		Revision as of 07:07, 5 December 2008
Line 4:		Line 4:

	I'm going to focus firstly on the basics to get a report to appear on the screen, and then possibly expand this to include how I used the FPDF library to save PDF files since first you want to know how to do it in ATK.		I'm going to focus firstly on the basics to get a report to appear on the screen, and then possibly expand this to include how I used the FPDF library to save PDF files since first you want to know how to do it in ATK.

			Note: There is now a fully working set of example code submitted as a patch to the bugtracker. http://bugzilla.achievo.org/show_bug.cgi?id=1071 It is setup to be lesson11 of the demo.

	= Start with any empty node =		= Start with any empty node =

Rwolverine: /* getMyReport function */

2008-07-24T12:32:28Z

getMyReport function

← Older revision		Revision as of 12:32, 24 July 2008
Line 62:		Line 62:
	// Start composing the output by adding the filterbar as topmost item		// Start composing the output by adding the filterbar as topmost item
	$output = $this->getFilterBar();		$output = $this->getFilterBar();
	$output.= '<br/>';		$output.= '<br/>';

			// Render a box around the generated output
			$boxedoutput = $ui->renderBox(array("title"=>$this->actionTitle('ProductionTallySheet'), "content"=>$output));

			// Return the generated boxed output
			return $boxedoutput;
	}		}
	else		else

Rwolverine: /* Adding Menu items in Modules.inc */

2008-07-22T21:59:54Z

Adding Menu items in Modules.inc

← Older revision		Revision as of 21:59, 22 July 2008
Line 174:		Line 174:
	$this->menuitem("-"); //adds a space on the main menu but does not affect the module's menu		$this->menuitem("-"); //adds a space on the main menu but does not affect the module's menu

	$this->menuitem("~~Tally~~ Report", dispatch_url("mymodule.myReport", "report"), "mymodule", array("mymodule.myReport", "report"));		$this->menuitem("My Report", dispatch_url("mymodule.myReport", "report"), "mymodule", array("mymodule.myReport", "report"));
	$this->menuitem("-", "", "Production", array("mymodule.myReport", "admin"));		$this->menuitem("-", "", "Production", array("mymodule.myReport", "admin"));
	}		}
Line 180:		Line 180:
	function getNodes()		function getNodes()
	{		{
	registerNode("~~production~~.~~productiontallyentryreport~~", array("report","any_user"));		registerNode("mymodule.myReport", array("report","any_user"));

	}		}

Rwolverine: /* Adding Menu items in Modules.inc */

2008-07-22T21:59:19Z

Adding Menu items in Modules.inc

← Older revision		Revision as of 21:59, 22 July 2008
Line 171:		Line 171:

	//Menu item Title		//Menu item Title
	$this->menuitem("mymodule", "", "main");		$this->menuitem("mymodule", "", "main");
	$this->menuitem("-"); //adds a space on the main menu but does not affect the module's menu		$this->menuitem("-"); //adds a space on the main menu but does not affect the module's menu

	$this->menuitem("Tally Report", dispatch_url("mymodule.myReport", "report"), "mymodule", array("mymodule.myReport", "report"));		$this->menuitem("Tally Report", dispatch_url("mymodule.myReport", "report"), "mymodule", array("mymodule.myReport", "report"));
	$this->menuitem("-", "", "Production", array("mymodule.myReport", "admin"));		$this->menuitem("-", "", "Production", array("mymodule.myReport", "admin"));
	}		}

Rwolverine at 21:58, 22 July 2008

2008-07-22T21:58:01Z

← Older revision		Revision as of 21:58, 22 July 2008
Line 160:		Line 160:
	</syntaxhighlight>		</syntaxhighlight>

	= Modules.inc ~~file~~ =		= Adding Menu items in Modules.inc =

	Note that while adding this report node in the getMenuItems and getNodes sections of the modules.inc file you will want to define them like:		Note that while adding this report node in the getMenuItems and getNodes sections of the modules.inc file you will want to define them like:

Rwolverine at 21:57, 22 July 2008

2008-07-22T21:57:18Z

@@ Line 157: / Line 157: @@
      return $attrs;
+   }
 </syntaxhighlight>

Rwolverine: New page: {{howto|easy|Rwolverine (PM me on the forums with questions)}} = Preface = There are many formats the reports can be sent to, Infact I use the FPDF library to turn mine into PDFs and a...

2008-06-22T23:55:29Z

New page: {{howto|easy|Rwolverine (PM me on the forums with questions)}} = Preface = There are many formats the reports can be sent to, Infact I use the FPDF library to turn mine into PDFs and a...

New page

{{howto|easy|[[Rwolverine]] (PM me on the forums with questions)}}
= Preface =
There are many formats the reports can be sent to, Infact I use the FPDF library to turn mine into PDFs and a recent thread about report writing mentioned using the ATKOpenDocumentWriter class in ATK to create ODF files.

I'm going to focus firstly on the basics to get a report to appear on the screen, and then possibly expand this to include how I used the FPDF library to save PDF files since first you want to know how to do it in ATK.

= Start with any empty node =
First you start off with a normal node, but leave it empty:

== Empty myReport Node ==
<syntaxhighlight lang="php">
class myReport extends atkNode
{
function myReport ()
{
$this->atkNode("myReport");
}
}
</syntaxhighlight>

= action_report Action =
This appears to be where the action happens. It start's the page and calls the [getMyReport] function which both presents the form to filter/sort your data on, and display the resulting report.

== action_report code ==
Add the following to your report class below the constructor:
<syntaxhighlight lang="php">
function action_report()
{
// Here is the meat of the report and where everything happens
$content = $this->getMyReport();

// Add the given content to the page
$page = &$this->getPage();
$page->addContent($this->renderActionPage("report", $content));
}
</syntaxhighlight>
Here we use a function to manage everything called getMyReport();

= Main Report code =
As stated above this is where the the report is generated and presented, also the sorting/filtering choices are presented/configured here as well.

== getMyReport function ==
<syntaxhighlight lang="php">
function getMyReport()
{
// Get a reference to the sessionmanager
global $sessionManager = &atkGetSessionManager();

$this->addStyle("style.css");

// Try to get a reference to the User Interface object and raise an error if it fails
$ui = &$this->getUi();

// Add a newline (vertical spacing)
$output.= '<br/>';
$go = $sessionManager->pageVar("go");

//use this to show the filter screen first, and the report second.
// $go gets set as a hidden field in the getFilterBar function.
if ($go != 1)
{
// Start composing the output by adding the filterbar as topmost item
$output = $this->getFilterBar();
$output.= '<br/>';
}
else
{
// Reporting code goes here, use techniques learned in the db
// access section to get your data out and then just format
// standard html to output with

// Render a box around the generated output
$boxedoutput = $ui->renderBox(array("title"=>$this->actionTitle('ProductionTallySheet'), "content"=>$output));

// Return the generated boxed output
return $boxedoutput;
}
}
</syntaxhighlight>

== getFilterBar function ==
In this function you can build the filter form.
<syntaxhighlight lang="php">
function getfilterbar()
{
// get data to filter based on constraints for the report.
$record = $this->getFilterRecord();

//get the filter attributes
$attrs = &$this->getFilterAttrs();

$output = '<form action="dispatch.php" method="get">';
$output.= atkSessionManager::formState();
$output.= '<input type="hidden" name="go" value="1">'; //trigger to prevent loading the first time
$output.= atktext("Date","production").' '.$attrs["date"]->edit($record);
$output.= '<br>';
$output.= atktext("name").": ".$attrs["name"]->edit($record)." ";
$output.= '<br>';
$output.= atktext("shift").": ".$attrs["shift"]->edit($record)." ";

$output.= ' <input type="submit" value="'.atktext("refresh").'">';
$output.= '</form>';
return $output;
}
</syntaxhighlight>

== getFilterRecord ==
Grab the data to be filtered/sorted on
<syntaxhighlight lang="php">
function getFilterRecord()
{
static $s_record = NULL;

$sessionManager = atkGetSessionManager();

if ($s_record==NULL)
{
$s_record = array();
$s_record["name"] = $sessionManager->pageVar("name");
$s_record["shift"] = $sessionManager->pageVar("shift");
$s_record["date"] = $g_sessionManager->pageVar("date");

$attrs = &$this->getFilterAttrs();
foreach (array_keys($attrs) as $attribname)
{
$p_attrib = &$attrs[$attribname];
$s_record[$attribname] = &$p_attrib->fetchValue($s_record);
}

$go = $sessionManager->pageVar("go");
if ($go != 1)
{
// initial loading.
//set name to current logged in person
$user = getUser();
$s_record["name"] = array("id"=>$user["id"]);

// We'll put the to to todays date
$s_record["date"] = date("Ymd");
}
}
return $s_record;
}
</syntaxhighlight>

== getFilterAttrs ==
Get the attribute info for the fields you're going to use to sort/filter on so they render normaly on the screen.
<syntaxhighlight lang="php">
function &getFilterAttrs()
{
userelation("atkmanytoonerelation");
useattrib("atkradioattribute");
$attrs["name"] = &new atkManyToOneRelation("name", "access.users");
//$attrs["name"]->setNoneLabel("Do not filter");
$attrs["shift"] = &new atkRadioAttribute("shift", array("1 ST","2 ND","3 RD"), array("1 ST","2 ND","3 RD"));
$attrs["date"] = &new atkDateAttribute("date");

return $attrs;
}
</syntaxhighlight>

= Conclusion =
There are many things that can be expanded upon here but this is the basic skeleton method borrowed from Achievo examples.

You may also want to have a look at [[atkBaseReport]]. It's a predefined class containing some of the constructs mentioned above.