Joomla! Documentation - User contributions [en]

J2.5:Creating PDF views

2012-08-07T20:35:50Z

Mole84: /* Copying document renderer files */

=== Download the domPDF library ===

Download the domPDF library from https://code.google.com/p/dompdf/downloads/list

(As of the time of writing the latest version of domPDF was DOMPDF 0.6.0 beta 3)

Open the downloaded zip folder and copy the 'dompdf' folder to your site 'libraries/' folder.

=== Create the PDF document class ===
Next, we will create the Joomla PDF document class.

* Create a folder /libraries/joomla/document/pdf
* create a file called 'pdf.php' in this folder.
* Open the file and paste in this code:

<source lang="php">
<?php
/**
* @package Joomla.Framework
* @subpackage Document
* @copyright Copyright (C) 2005 - 2012 Rob Clayburn
* @license GNU/GPL, see LICENSE.php
* Joomla! is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/

// Check to ensure this file is within the rest of the framework
defined('JPATH_BASE') or die();

require_once(JPATH_LIBRARIES .'/joomla/document/html/html.php');

/**
* DocumentPDF class, provides an easy interface to parse and display a pdf document
*
* @package Joomla.Framework
* @subpackage Document
* @since 1.5
*/
class JDocumentpdf extends JDocumentHTML
{
private $engine = null;

private $name = 'joomla';

/**
* Class constructore
* @param array $options Associative array of options
*/

function __construct($options = array())
{
parent::__construct($options);

//set mime type
$this->_mime = 'application/pdf';

//set document type
$this->_type = 'pdf';

if (!$this->iniDomPdf())
{
JError::raiseError(500, 'No PDF lib found');
}
}

protected function iniDomPdf()
{
$file = JPATH_LIBRARIES .'/dompdf/dompdf_config.inc.php';
if (!JFile::exists($file))
{
return false;
}
if (!defined('DOMPDF_ENABLE_REMOTE'))
{
define('DOMPDF_ENABLE_REMOTE', true);
}
//set the font cache directory to Joomla's tmp directory
$config = JFactory::getConfig();
if (!defined('DOMPDF_FONT_CACHE'))
{
define('DOMPDF_FONT_CACHE', $config->get('tmp_path'));
}
require_once($file);
// Default settings are a portrait layout with an A4 configuration using millimeters as units
$this->engine =new DOMPDF();
return true;
}

/**
* Sets the document name
* @param string $name Document name
* @return void
*/

public function setName($name = 'joomla')
{
$this->name = $name;
}

/**
* Returns the document name
* @return string
*/

public function getName()
{
return $this->name;
}

/**
* Render the document.
* @access public
* @param boolean $cache If true, cache the output
* @param array $params Associative array of attributes
* @return string
*/

function render($cache = false, $params = array())
{
$pdf = $this->engine;
$data = parent::render();
$this->fullPaths($data);
//echo $data;exit;
$pdf->load_html($data);
$pdf->render();
$pdf->stream($this->getName() . '.pdf');
return '';
}

/**
* (non-PHPdoc)
* @see JDocumentHTML::getBuffer()
*/

public function getBuffer($type = null, $name = null, $attribs = array())
{
if ($type == 'head' || $type == 'component')
{
return parent::getBuffer($type, $name, $attribs);
}
else
{
return '';
}
}

/**
* parse relative images a hrefs and style sheets to full paths
* @param string &$data
*/

private function fullPaths(&$data)
{
$data = str_replace('xmlns=', 'ns=', $data);
libxml_use_internal_errors(true);
try
{
$ok = new SimpleXMLElement($data);
if ($ok)
{
$uri = JUri::getInstance();
$base = $uri->getScheme() . '://' . $uri->getHost();
$imgs = $ok->xpath('//img');
foreach ($imgs as &$img)
{
if (!strstr($img['src'], $base))
{
$img['src'] = $base . $img['src'];
}
}
//links
$as = $ok->xpath('//a');
foreach ($as as &$a)
{
if (!strstr($a['href'], $base))
{
$a['href'] = $base . $a['href'];
}
}

// css files.
$links = $ok->xpath('//link');
foreach ($links as &$link)
{
if ($link['rel'] == 'stylesheet' && !strstr($link['href'], $base))
{
$link['href'] = $base . $link['href'];
}
}
$data = $ok->asXML();
}
} catch (Exception $err)
{
//oho malformed html - if we are debugging the site then show the errors
// otherwise continue, but it may mean that images/css/links are incorrect
$errors = libxml_get_errors();
if (JDEBUG)
{
echo "<pre>";print_r($errors);echo "</pre>";
exit;
}
}

}

}
</source>

=== Copying document renderer files ===

This class extends the JDocumentHTML class.

As it extends JDocumentHTML, you will need to copy the folder and contents of:
<pre>
libraries/joomla/document/html/renderer
</pre>
to
<pre>libraries/joomla/document/pdf/renderer</pre>

=== Create a PDF view for your component ===

Then for any component you wish to create a pdf view for you should

* copy the view's view.html.php file and rename it to view.pdf.php.

E.g. to make a PDF view of an article, copy:
<pre>components/com_content/views/article/view.html.php</pre>

and rename it to:

<pre>components/com_content/views/article/view.pdf.php</pre>

Then to view a pdf article you need to append '''&format=pdf''' to your articles URL.

E.g.
<pre>http://localhost/index.php?option=com_content&view=article&id=4&format=pdf</pre>

If you only want to output the components content to the PDF then you should add '''tmpl=component''' to the url:

E.g.
<pre>http://localhost/index.php?option=com_content&view=article&id=4&format=pdf&tmpl=component</pre>

=== Setting the file name ===

By default the PDF file will download as joomla.pdf. To change this:

* Open you view.pdf.php file
*inside its display() method add this code

<source lang="php">
$document = JFactory::getDocument();
$document->setName('mypdf');
</source>

the PDF will now download as mypdf.pdf

[[Category:Development]]

J2.5 talk:Creating PDF views

2012-08-07T20:35:25Z

Mole84:

Has anyone tested this method on Joomla! 2.5?
EDIT: tested on Joomla! 2.5 and working fine.

J2.5 talk:Creating PDF views

2012-07-17T19:41:45Z

Mole84: Created page with "Has anyone tested this method on Joomla! 2.5?"

Has anyone tested this method on Joomla! 2.5?

J1.5:How to create a custom button

2008-07-22T19:44:50Z

Mole84: messed it up earlier

{{cookiejar}}
{{incomplete}}
[[Category:Development]]

The code below is used for adding buttons to the back-end toolbar when developing components and modules.
==Explanation of JToolBarHelper button functionality==
* When you add a JToolBarHelper function into an admin view it will display the icon and preform the corresponding function listed in the controller when pressed.
* You can modify the default function that is run by using the $this->registerTask('add', 'edit'); to redirect logic, in this example a call from the default button add is directed to the edit function.

==Default Buttons / Functions Included with Joomla 1.5==
<source lang="php">
JToolBarHelper::title();
JToolBarHelper::spacer();
JToolBarHelper::divider();
JToolBarHelper::custom();
JToolBarHelper::customX();
JToolBarHelper::preview();
JToolBarHelper::help();
JToolBarHelper::back();
JToolBarHelper::media_manager();
JToolBarHelper::addNew();
JToolBarHelper::addNewX();
JToolBarHelper::publish();
JToolBarHelper::publishList();
JToolBarHelper::makeDefault();
JToolBarHelper::assign();
JToolBarHelper::unpublish();
JToolBarHelper::unpublishList();
JToolBarHelper::archiveList();
JToolBarHelper::unarchiveList();
JToolBarHelper::editList();
JToolBarHelper::editListX();
JToolBarHelper::editHtml();
JToolBarHelper::editHtmlX();
JToolBarHelper::editCss();
JToolBarHelper::editCssX();
JToolBarHelper::deleteList();
JToolBarHelper::deleteListX();
JToolBarHelper::trash();
JToolBarHelper::apply();
JToolBarHelper::save();
JToolBarHelper::cancel();
JToolBarHelper::preferences();
JToolBarHelper::addEntry();
</source>

* The icons associated with these functions are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

==Custom button==
* The syntax for a custom button that can be added into a view
<source lang="php">
/**
* Writes a custom option and task button for the button bar
* @param string The task to perform (picked up by the switch($task) blocks
* @param string The image to display
* @param string The image to display when moused over
* @param string The alt text for the icon image
* @param boolean True if required to check that a standard list item is checked
* @param boolean True if required to include callinh hideMainMenu()
*/

JToolBarHelper::custom( 'task', 'icon', 'icon over', 'alt', boolean, boolean );
</source>

* The Default Admin Toolbar Icons are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

* From here you will notice that the icons are linked to display through the CSS file at:
<source lang="bash">
www/administrator/templates/khepri/css/icon.css
</source>

* This icon CSS file is automatically included through the admin template. If we would like to add a custom toolbar icon into an installable component it is useful to follow the same structure. We will have to manually include our new CSS file.

* An example of the icon CSS statement:
<source lang="css">
.icon-32-iconname {
background-image: url(../../images/icon-32-iconfile.png);
}
</source>

* As you can see iconname and iconfile do not necessarily have to be the same.
** JToolBarHelper will look for the iconname at the end of .icon-32- and the filename must be preceded by icon-32-

* The following would create this custom toolbar icon, notice the iconname dose not correspond to the actual file name but the CSS allows the reference.

<source lang="php">
JToolBarHelper :: custom( 'someFunction', 'iconname.png', 'iconname.png', 'alt text', false, false );
</source>

* You can place your icon file and css file at any point in your installable component, which will allow it to be easily transferable.

* To include a new CSS file to your entire admin side it may be useful to include it in the entry point.

<source lang="php">
JHTML::_('stylesheet', THISCOMPONENTNAME.css', 'components/THISCOMPONENT/assets/css/');
</source>

==Upload button==
* Method 1:
<source lang="php">
// Add an upload button and view a popup screen width 550 and height 400
$alt = "Upload";
$bar=& JToolBar::getInstance( 'toolbar' );
$bar->appendButton( 'Popup', 'upload', $alt, 'index.php', 550, 400 );
</source>
* Method 2:
<source lang="php">
// You view button for popup media manager tools
JToolBarHelper::media_manager( '/' );
</source>

J1.5:How to create a custom button

2008-07-22T17:42:55Z

Mole84: /* Explanation of JToolBarHelper button functionality */

{{cookiejar}}
{{incomplete}}
[[Category:Development]]

The code below is used for adding buttons to the back-end toolbar when developing components and modules.
==Explanation of JToolBarHelper button functionality==
* When you add a JToolBarHelper function into an admin view it will display the icon and preform the corresponding function listed in the controller when pressed.
* You can modify the default function that is run by using the $this->registerTask('add', 'edit'); to redirect logic, in this example a call from the default button add is directed to the edit function.

==Default Buttons Included with Joomla 1.5==
<source lang="php">
JToolBarHelper::send();
JToolBarHelper::delete();
JToolBarHelper::help();
JToolBarHelper::cancel();
JToolBarHelper::config();
JToolBarHelper::apply();
JToolBarHelper::back();
JToolBarHelper::forward();
JToolBarHelper::save();
JToolBarHelper::edit();
JToolBarHelper::copy();
JToolBarHelper::move();
JToolBarHelper::new();
JToolBarHelper::upload();
JToolBarHelper::assign();
JToolBarHelper::html();
JToolBarHelper::css();
JToolBarHelper::menus();
JToolBarHelper::publish();
JToolBarHelper::unpublish ();
JToolBarHelper::restore();
JToolBarHelper::trash();
JToolBarHelper::archive();
JToolBarHelper::unarchive();
JToolBarHelper::preview();
JToolBarHelper::default();
</source>

* The icons associated with these functions are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

==Custom button==
* The syntax for a custom button that can be added into a view
<source lang="php">
JToolBarHelper::custom( 'task', 'icon', 'icon over', 'alt', boolean, boolean );
</source>

* The Default Admin Toolbar Icons are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

* From here you will notice that the icons are linked to display through the CSS file at:
<source lang="bash">
www/administrator/templates/khepri/css/icon.css
</source>

* This icon CSS file is automatically included through the admin template. If we would like to add a custom toolbar icon into an installable component it is useful to follow the same structure. We will have to manually include our new CSS file.

* An example of the icon CSS statement:
<source lang="css">
.icon-32-iconname {
background-image: url(../../images/icon-32-iconfile.png);
}
</source>

* As you can see iconname and iconfile do not necessarily have to be the same.
** JToolBarHelper will look for the iconname at the end of .icon-32- and the filename must be preceded by icon-32-

* The following would create this custom toolbar icon, notice the iconname dose not correspond to the actual file name but the CSS allows the reference.

<source lang="php">
JToolBarHelper :: custom( 'someFunction', 'iconname.png', 'iconname.png', 'alt text', true, true );
</source>

* You can place your icon file and css file at any point in your installable component, which will allow it to be easily transferable.

* To include a new CSS file to your entire admin side it may be useful to include it in the entry point.

<source lang="php">
JHTML::_('stylesheet', THISCOMPONENTNAME.css', 'components/THISCOMPONENT/assets/css/');
</source>

==Upload button==
* Method 1:
<source lang="php">
// Add an upload button and view a popup screen width 550 and height 400
$alt = "Upload";
$bar=& JToolBar::getInstance( 'toolbar' );
$bar->appendButton( 'Popup', 'upload', $alt, 'index.php', 550, 400 );
</source>
* Method 2:
<source lang="php">
// You view button for popup media manager tools
JToolBarHelper::media_manager( '/' );
</source>

J1.5:How to create a custom button

2008-07-22T17:14:44Z

Mole84:

{{cookiejar}}
{{incomplete}}
[[Category:Development]]

The code below is used for adding buttons to the back-end toolbar when developing components and modules.
==Explanation of JToolBarHelper button functionality==
* When you add a JToolBarHelper function into an admin view it will display the icon and preform the corresponding function listed in the controller when pressed.

==Default Buttons Included with Joomla 1.5==
<source lang="php">
JToolBarHelper::send();
JToolBarHelper::delete();
JToolBarHelper::help();
JToolBarHelper::cancel();
JToolBarHelper::config();
JToolBarHelper::apply();
JToolBarHelper::back();
JToolBarHelper::forward();
JToolBarHelper::save();
JToolBarHelper::edit();
JToolBarHelper::copy();
JToolBarHelper::move();
JToolBarHelper::new();
JToolBarHelper::upload();
JToolBarHelper::assign();
JToolBarHelper::html();
JToolBarHelper::css();
JToolBarHelper::menus();
JToolBarHelper::publish();
JToolBarHelper::unpublish ();
JToolBarHelper::restore();
JToolBarHelper::trash();
JToolBarHelper::archive();
JToolBarHelper::unarchive();
JToolBarHelper::preview();
JToolBarHelper::default();
</source>

* The icons associated with these functions are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

==Custom button==
* The syntax for a custom button that can be added into a view
<source lang="php">
JToolBarHelper::custom( 'task', 'icon', 'icon over', 'alt', boolean, boolean );
</source>

* The Default Admin Toolbar Icons are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

* From here you will notice that the icons are linked to display through the CSS file at:
<source lang="bash">
www/administrator/templates/khepri/css/icon.css
</source>

* This icon CSS file is automatically included through the admin template. If we would like to add a custom toolbar icon into an installable component it is useful to follow the same structure. We will have to manually include our new CSS file.

* An example of the icon CSS statement:
<source lang="css">
.icon-32-iconname {
background-image: url(../../images/icon-32-iconfile.png);
}
</source>

* As you can see iconname and iconfile do not necessarily have to be the same.
** JToolBarHelper will look for the iconname at the end of .icon-32- and the filename must be preceded by icon-32-

* The following would create this custom toolbar icon, notice the iconname dose not correspond to the actual file name but the CSS allows the reference.

<source lang="php">
JToolBarHelper :: custom( 'someFunction', 'iconname.png', 'iconname.png', 'alt text', true, true );
</source>

* You can place your icon file and css file at any point in your installable component, which will allow it to be easily transferable.

* To include a new CSS file to your entire admin side it may be useful to include it in the entry point.

<source lang="php">
JHTML::_('stylesheet', THISCOMPONENTNAME.css', 'components/THISCOMPONENT/assets/css/');
</source>

==Upload button==
* Method 1:
<source lang="php">
// Add an upload button and view a popup screen width 550 and height 400
$alt = "Upload";
$bar=& JToolBar::getInstance( 'toolbar' );
$bar->appendButton( 'Popup', 'upload', $alt, 'index.php', 550, 400 );
</source>
* Method 2:
<source lang="php">
// You view button for popup media manager tools
JToolBarHelper::media_manager( '/' );
</source>

J1.5:How to create a custom button

2008-07-22T16:57:25Z

Mole84: added instructions for how to create a system for a coustom admin toolbar icon

{{cookiejar}}
{{incomplete}}
[[Category:Development]]

The code below is used for adding buttons to the back-end toolbar when developing components and modules.

==Apply button==
<source lang="php">
JToolBarHelper::apply();
</source>

==Back button==
<source lang="php">
JToolBarHelper::back();
</source>

==Cancel button==
<source lang="php">
JToolBarHelper::cancel();
</source>

==Custom button==
* The syntax for a custom button that can be added into a view
<source lang="php">
JToolBarHelper::custom( 'task', 'icon', 'icon over', 'alt', boolean, boolean );
</source>

* The Default Admin Toolbar Icons are stored at:
<source lang="bash">
www/administrator/templates/khepri/images
</source>

* From here you will notice that the icons are linked to display through the CSS file at:
<source lang="bash">
www/administrator/templates/khepri/css/icon.css
</source>

* This icon CSS file is automatically included through the admin template. If we would like to add a custom toolbar icon into an installable component it is useful to follow the same structure. We will have to manually include our new CSS file.

* An example of the icon CSS statement:
<source lang="css">
.icon-32-iconname {
background-image: url(../../images/icon-32-iconfile.png);
}
</source>

* As you can see iconname and iconfile do not necessarily have to be the same.
** JToolBarHelper will look for the iconname at the end of .icon-32- and the filename must be preceded by icon-32-

* The following would create this custom toolbar icon, notice the iconname dose not correspond to the actual file name but the CSS allows the reference.

<source lang="php">
JToolBarHelper :: custom( 'someFunction', 'iconname.png', 'iconname.png', 'alt text', true, true );
</source>

* You can place your icon file and css file at any point in your installable component, which will allow it to be easily transferable.

* To include a new CSS file to your entire admin side it may be useful to include it in the entry point.

<source lang="php">
JHTML::_('stylesheet', THISCOMPONENTNAME.css', 'components/THISCOMPONENT/assets/css/');
</source>

==Upload button==
* Method 1:
<source lang="php">
// Add an upload button and view a popup screen width 550 and height 400
$alt = "Upload";
$bar=& JToolBar::getInstance( 'toolbar' );
$bar->appendButton( 'Popup', 'upload', $alt, 'index.php', 550, 400 );
</source>
* Method 2:
<source lang="php">
// You view button for popup media manager tools
JToolBarHelper::media_manager( '/' );
</source>