lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2017-04-29 01:01:12 +02:00
parent 9c2ce0202d
commit 05fe0d7fcd
2 changed files with 42 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
htdocs/includes/odtphp/Segment.php
View File

@ -1,14 +1,16 @@
<?php <?php
require 'SegmentIterator.php'; require 'SegmentIterator.php';
class SegmentException extends Exception class SegmentException extends Exception
{} {
}
/** /**
* Class for handling templating segments with odt files * Class for handling templating segments with odt files
* You need PHP 5.2 at least * You need PHP 5.2 at least
* You need Zip Extension or PclZip library * You need Zip Extension or PclZip library
* *
* @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com) * @copyright 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
* @copyright GPL License 2012 - Stephen Larroque - lrq3000@gmail.com * @copyright 2012 - Stephen Larroque - lrq3000@gmail.com
* @license http://www.gnu.org/copyleft/gpl.html GPL License * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.4.5 (last update 2013-04-07) * @version 1.4.5 (last update 2013-04-07)
*/ */
@ -22,11 +24,13 @@ class Segment implements IteratorAggregate, Countable
protected $images = array(); protected $images = array();
protected $odf; protected $odf;
protected $file; protected $file;
/** /**
* Constructor * Constructor
* *
* @param string $name name of the segment to construct * @param string $name name of the segment to construct
* @param string $xml XML tree of the segment * @param string $xml XML tree of the segment
* @param string $odf odf
*/ */
public function __construct($name, $xml, $odf) public function __construct($name, $xml, $odf)
{ {
@ -152,10 +156,11 @@ class Segment implements IteratorAggregate, Countable
return $this->xmlParsed; return $this->xmlParsed;
} }
/** /**
* Analyse the XML code in order to find children * Analyse the XML code in order to find children
* *
* @param string $xml * @param string $xml Xml
* @return Segment * @return Segment
*/ */
protected function _analyseChildren($xml) protected function _analyseChildren($xml)
@ -172,11 +177,14 @@ class Segment implements IteratorAggregate, Countable
} }
return $this; return $this;
} }
/** /**
* Assign a template variable to replace * Assign a template variable to replace
* *
* @param string $key * @param string $key Key
* @param string $value * @param string $value Value
* @param string $encode Encode
* @param string $charset Charset
* @throws SegmentException * @throws SegmentException
* @return Segment * @return Segment
*/ */
@ -230,7 +238,7 @@ IMG;
/** /**
* Shortcut to retrieve a child * Shortcut to retrieve a child
* *
* @param string $prop * @param string $prop Prop
* @return Segment * @return Segment
* @throws SegmentException * @throws SegmentException
*/ */
@ -245,8 +253,8 @@ IMG;
/** /**
* Proxy for setVars * Proxy for setVars
* *
* @param string $meth * @param string $meth Meth
* @param array $args * @param array $args Args
* @return Segment * @return Segment
*/ */
public function __call($meth, $args) public function __call($meth, $args)

33
htdocs/includes/odtphp/odf.php
View File

@ -1,16 +1,20 @@
<?php <?php
require 'Segment.php'; require 'Segment.php';
class OdfException extends Exception class OdfException extends Exception
{} {
}
/** /**
* Templating class for odt file * Templating class for odt file
* You need PHP 5.2 at least * You need PHP 5.2 at least
* You need Zip Extension or PclZip library * You need Zip Extension or PclZip library
* *
* @copyright GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com) * @copyright 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
* @copyright GPL License 2010-2015 - Laurent Destailleur - eldy@users.sourceforge.net * @copyright 2010-2015 - Laurent Destailleur - eldy@users.sourceforge.net
* @copyright GPL License 2010 - Vikas Mahajan - http://vikasmahajan.wordpress.com * @copyright 2010 - Vikas Mahajan - http://vikasmahajan.wordpress.com
* @copyright GPL License 2012 - Stephen Larroque - lrq3000@gmail.com * @copyright 2012 - Stephen Larroque - lrq3000@gmail.com
* @license http://www.gnu.org/copyleft/gpl.html GPL License * @license http://www.gnu.org/copyleft/gpl.html GPL License
* @version 1.5.0 * @version 1.5.0
*/ */
@ -43,7 +47,8 @@ class Odf
/** /**
* Class constructor * Class constructor
* *
* @param string $filename the name of the odt file * @param string $filename The name of the odt file
* @param string $config Array of config data
* @throws OdfException * @throws OdfException
*/ */
public function __construct($filename, $config = array()) public function __construct($filename, $config = array())
@ -116,9 +121,10 @@ class Odf
/** /**
* Assing a template variable * Assing a template variable
* *
* @param string $key name of the variable within the template * @param string $key Name of the variable within the template
* @param string $value replacement value * @param string $value Replacement value
* @param bool $encode if true, special XML characters are encoded * @param bool $encode If true, special XML characters are encoded
* @param string $charset Charset
* @throws OdfException * @throws OdfException
* @return odf * @return odf
*/ */
@ -577,6 +583,7 @@ IMG;
} }
else else
{ {
dol_syslog(get_class($this).'::exportAsAttachedPDF is used but the constant MAIN_DOL_SCRIPTS_ROOT with path to script directory was not defined.', LOG_WARNING);
$command = '../../scripts/odt2pdf/odt2pdf.sh '.escapeshellcmd($name).' '.(is_numeric($conf->global->MAIN_ODT_AS_PDF)?'jodconverter':$conf->global->MAIN_ODT_AS_PDF); $command = '../../scripts/odt2pdf/odt2pdf.sh '.escapeshellcmd($name).' '.(is_numeric($conf->global->MAIN_ODT_AS_PDF)?'jodconverter':$conf->global->MAIN_ODT_AS_PDF);
} }
@ -642,6 +649,7 @@ IMG;
/** /**
* Returns a variable of configuration * Returns a variable of configuration
* *
* @param string $configKey Config key
* @return string The requested variable of configuration * @return string The requested variable of configuration
*/ */
public function getConfig($configKey) public function getConfig($configKey)
@ -678,7 +686,8 @@ IMG;
/** /**
* Empty the temporary working directory recursively * Empty the temporary working directory recursively
* @param $dir the temporary working directory *
* @param string $dir The temporary working directory
* @return void * @return void
*/ */
private function _rrmdir($dir) private function _rrmdir($dir)
@ -701,8 +710,8 @@ IMG;
/** /**
* return the value present on odt in [valuename][/valuename] * return the value present on odt in [valuename][/valuename]
* *
* @param string $value name balise in the template * @param string $valuename Balise in the template
* @return string the value inside the balise * @return string The value inside the balise
*/ */
public function getvalue($valuename) public function getvalue($valuename)
{ {