Reporting API - Revision history

Patricia Schmidt: /* Generate HTML Codes */

2013-03-07T19:57:27Z

‎Generate HTML Codes

Patricia Schmidt at 19:56, 7 March 2013

2013-03-07T19:56:28Z

Sinisakrisan: Created page with "Reporting allows 3rd party application / module provider to generate a link that will allow guests / members to report against an item. The item here could refer to any object..."

2013-01-18T12:36:07Z

Created page with "Reporting allows 3rd party application / module provider to generate a link that will allow guests / members to report against an item. The item here could refer to any object..."

New page

Reporting allows 3rd party application / module provider to generate a link that will allow guests / members to report against an item. The item here could refer to any object within the page. There is 3 main steps that needs to be done to achieve this,

===Generate HTML codes ===
Generate the 'HTML' codes and display it within your application / module.
<syntaxhighlight lang="php">
// Load libraries
CFactory::load('libraries', 'reporting');
$report = new CReportingLibrary();
$html = $report->getReportingHTML( JText::_('COM_COMMUNITY_REPORT_BAD_USER') , 'profile,reportProfile' , array( $user->id ) );
</syntaxhighlight>
 
'''JText::_('COM_COMMUNITY_REPORT_BAD_USER'')''' - The first parameter here informs the library to display this text in the html codes. 
'''profile,reportProfile''' - Second parameter informs the library to call the method to register your tasks. To register a call for plugins, you can use plugins,pluginname,method. 
'''array( $user->id )''' - Third parameter is the unique id that you are reporting against.

===Registering the report action ===
<syntaxhighlight lang="php">
/**
* Method is called from the reporting library. Function calls should be
* registered here.
*
* return String Message that will be displayed to user upon submission.
**/
function reportProfile( $link, $message , $id )
{
CFactory::load( 'libraries' , 'reporting' );
$report = new CReportingLibrary();

$report->createReport( JText::_('Bad user') , $link , $message );
$action = new stdClass();
$action->label = 'Block User';
$action->method = 'profile,blockProfile';
$action->parameters = $id;
$action->defaultAction = false;

$report->addActions( array( $action ) );

return JText::_('COM_COMMUNITY_REPORT_SUBMITTED');
}
</syntaxhighlight>
 
For plugins, simply create the function in your plugin and the system will automatically call this method.
$action->method - To register a call for plugins, you can use plugins,pluginname,method

===Creating method that will be executed by the administrator ===
When the report item is added to the system, the administrator will then be able to perform the actions based on what you have parsed to the system. For an example, the 'block profile' method below, will block the user when the administrator clicks on the link.
<syntaxhighlight lang="php">
/**
* Function that is called from the back end
**/
function blockProfile( $userId )
{
$user =& CFactory::getUser( $userId );
$user->set( 'block' , 1 );
$user->save();
return JText::_('COM_COMMUNITY_USER_ACCOUNT_BLOCKED');
}
</syntaxhighlight>
 
The return value will be a normal string output which will be displayed to the administrator.
For plugins, simply create the function in your plugin and the system will automatically call this method.

@@ Line 10: / Line 10: @@
 </syntaxhighlight>
 <br />
-'''JText::_('COM_COMMUNITY_REPORT_BAD_USER'')''' - The first parameter here informs the library to display this text in the html codes.<br />
+'''JText::_('COM_COMMUNITY_REPORT_BAD_USER'')''' - The first parameter here informs the library to display this text in the html codes.<br /><br/>
-'''profile,reportProfile''' - Second parameter informs the library to call the method to register your tasks. To register a call for plugins, you can use plugins,pluginname,method.<br />
+'''profile,reportProfile''' - Second parameter informs the library to call the method to register your tasks. To register a call for plugins, you can use plugins,pluginname,method.<br /><br/>
 '''array( $user->id )''' - Third parameter is the unique id that you are reporting against.

@@ Line 1: / Line 1: @@
-Reporting allows 3rd party application / module provider to generate a link that will allow guests / members to report against an item. The item here could refer to any object within the page. There is 3 main steps that needs to be done to achieve this,
+Reporting allows Third-Party application / module providers to generate a link that will allow guests / members to report against an item. The item here could refer to any object within the page. There are three (3) main steps that need to be done to achieve this,
-===Generate HTML codes ===
+===Generate HTML Codes ===
 Generate the 'HTML' codes and display it within your application / module.
 <syntaxhighlight lang="php">
@@ Line 14: / Line 14: @@
 '''array( $user->id )''' - Third parameter is the unique id that you are reporting against.
-===Registering the report action ===
+===Registering the Report Action ===
 <syntaxhighlight lang="php">
 /**
@@ Line 43: / Line 43: @@
   $action->method - To register a call for plugins, you can use plugins,pluginname,method
-===Creating method that will be executed by the administrator ===
+===Create Method Executed by the Administrator===
 When the report item is added to the system, the administrator will then be able to perform the actions based on what you have parsed to the system. For an example, the 'block profile' method below, will block the user when the administrator clicks on the link.
 <syntaxhighlight lang="php">
@@ Line 58: / Line 58: @@
 </syntaxhighlight>
 <br />
-The return value will be a normal string output which will be displayed to the administrator.
+The return value will be a normal string output which will be displayed to the administrator. For plugins, simply create the function in your plugin and the system will automatically call this method.
- For plugins, simply create the function in your plugin and the system will automatically call this method.