/trunk/applications/jrest/lib/.directory |
---|
New file |
0,0 → 1,5 |
[Dolphin] |
Timestamp=2010,10,19,15,1,12 |
[Settings] |
ShowDotFiles=true |
/trunk/applications/jrest/lib/DB/common.php |
---|
New file |
0,0 → 1,2040 |
<?php |
/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */ |
// +----------------------------------------------------------------------+ |
// | PHP Version 4 | |
// +----------------------------------------------------------------------+ |
// | Copyright (c) 1997-2004 The PHP Group | |
// +----------------------------------------------------------------------+ |
// | This source file is subject to version 2.02 of the PHP license, | |
// | that is bundled with this package in the file LICENSE, and is | |
// | available at through the world-wide-web at | |
// | http://www.php.net/license/2_02.txt. | |
// | If you did not receive a copy of the PHP license and are unable to | |
// | obtain it through the world-wide-web, please send a note to | |
// | license@php.net so we can mail you a copy immediately. | |
// +----------------------------------------------------------------------+ |
// | Author: Stig Bakken <ssb@php.net> | |
// | Tomas V.V.Cox <cox@idecnet.com> | |
// | Maintainer: Daniel Convissor <danielc@php.net> | |
// +----------------------------------------------------------------------+ |
// |
// $Id$ |
require_once 'PEAR.php'; |
/** |
* DB_common is a base class for DB implementations, and must be |
* inherited by all such |
* |
* @package DB |
* @version $Id$ |
* @category Database |
* @author Stig Bakken <ssb@php.net> |
* @author Tomas V.V.Cox <cox@idecnet.com> |
*/ |
class DB_common extends PEAR |
{ |
// {{{ properties |
/** |
* assoc of capabilities for this DB implementation |
* $features['limit'] => 'emulate' => emulate with fetch row by number |
* 'alter' => alter the query |
* false => skip rows |
* @var array |
*/ |
var $features = array(); |
/** |
* assoc mapping native error codes to DB ones |
* @var array |
*/ |
var $errorcode_map = array(); |
/** |
* DB type (mysql, oci8, odbc etc.) |
* @var string |
*/ |
var $phptype; |
/** |
* @var string |
*/ |
var $prepare_tokens; |
/** |
* @var string |
*/ |
var $prepare_types; |
/** |
* @var string |
*/ |
var $prepared_queries; |
/** |
* @var integer |
*/ |
var $prepare_maxstmt = 0; |
/** |
* @var string |
*/ |
var $last_query = ''; |
/** |
* @var integer |
*/ |
var $fetchmode = DB_FETCHMODE_ORDERED; |
/** |
* @var string |
*/ |
var $fetchmode_object_class = 'stdClass'; |
/** |
* Run-time configuration options. |
* |
* The 'optimize' option has been deprecated. Use the 'portability' |
* option instead. |
* |
* @see DB_common::setOption() |
* @var array |
*/ |
var $options = array( |
'persistent' => false, |
'ssl' => false, |
'debug' => 0, |
'seqname_format' => '%s_seq', |
'autofree' => false, |
'portability' => DB_PORTABILITY_NONE, |
'optimize' => 'performance', // Deprecated. Use 'portability'. |
); |
/** |
* DB handle |
* @var resource |
*/ |
var $dbh; |
// }}} |
// {{{ toString() |
/** |
* String conversation |
* |
* @return string |
* @access private |
*/ |
function toString() |
{ |
$info = strtolower(get_class($this)); |
$info .= ': (phptype=' . $this->phptype . |
', dbsyntax=' . $this->dbsyntax . |
')'; |
if ($this->connection) { |
$info .= ' [connected]'; |
} |
return $info; |
} |
// }}} |
// {{{ constructor |
/** |
* Constructor |
*/ |
function DB_common() |
{ |
$this->PEAR('DB_Error'); |
} |
// }}} |
// {{{ quoteString() |
/** |
* DEPRECATED: Quotes a string so it can be safely used within string |
* delimiters in a query |
* |
* @return string quoted string |
* |
* @see DB_common::quoteSmart(), DB_common::escapeSimple() |
* @deprecated Deprecated in release 1.2 or lower |
* @internal |
*/ |
function quoteString($string) |
{ |
$string = $this->quote($string); |
if ($string{0} == "'") { |
return substr($string, 1, -1); |
} |
return $string; |
} |
// }}} |
// {{{ quote() |
/** |
* DEPRECATED: Quotes a string so it can be safely used in a query |
* |
* @param string $string the input string to quote |
* |
* @return string The NULL string or the string quotes |
* in magic_quote_sybase style |
* |
* @see DB_common::quoteSmart(), DB_common::escapeSimple() |
* @deprecated Deprecated in release 1.6.0 |
* @internal |
*/ |
function quote($string = null) |
{ |
return ($string === null) ? 'NULL' : "'".str_replace("'", "''", $string)."'"; |
} |
// }}} |
// {{{ quoteIdentifier() |
/** |
* Quote a string so it can be safely used as a table or column name |
* |
* Delimiting style depends on which database driver is being used. |
* |
* NOTE: just because you CAN use delimited identifiers doesn't mean |
* you SHOULD use them. In general, they end up causing way more |
* problems than they solve. |
* |
* Portability is broken by using the following characters inside |
* delimited identifiers: |
* + backtick (<kbd>`</kbd>) -- due to MySQL |
* + double quote (<kbd>"</kbd>) -- due to Oracle |
* + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access |
* |
* Delimited identifiers are known to generally work correctly under |
* the following drivers: |
* + mssql |
* + mysql |
* + mysqli |
* + oci8 |
* + odbc(access) |
* + odbc(db2) |
* + pgsql |
* + sqlite |
* + sybase |
* |
* InterBase doesn't seem to be able to use delimited identifiers |
* via PHP 4. They work fine under PHP 5. |
* |
* @param string $str identifier name to be quoted |
* |
* @return string quoted identifier string |
* |
* @since 1.6.0 |
* @access public |
*/ |
function quoteIdentifier($str) |
{ |
return '"' . str_replace('"', '""', $str) . '"'; |
} |
// }}} |
// {{{ quoteSmart() |
/** |
* Format input so it can be safely used in a query |
* |
* The output depends on the PHP data type of input and the database |
* type being used. |
* |
* @param mixed $in data to be quoted |
* |
* @return mixed the format of the results depends on the input's |
* PHP type: |
* |
* <ul> |
* <li> |
* <kbd>input</kbd> -> <samp>returns</samp> |
* </li> |
* <li> |
* <kbd>null</kbd> -> the string <samp>NULL</samp> |
* </li> |
* <li> |
* <kbd>integer</kbd> or <kbd>double</kbd> -> the unquoted number |
* </li> |
* <li> |
* &type.bool; -> output depends on the driver in use |
* Most drivers return integers: <samp>1</samp> if |
* <kbd>true</kbd> or <samp>0</samp> if |
* <kbd>false</kbd>. |
* Some return strings: <samp>TRUE</samp> if |
* <kbd>true</kbd> or <samp>FALSE</samp> if |
* <kbd>false</kbd>. |
* Finally one returns strings: <samp>T</samp> if |
* <kbd>true</kbd> or <samp>F</samp> if |
* <kbd>false</kbd>. Here is a list of each DBMS, |
* the values returned and the suggested column type: |
* <ul> |
* <li> |
* <kbd>dbase</kbd> -> <samp>T/F</samp> |
* (<kbd>Logical</kbd>) |
* </li> |
* <li> |
* <kbd>fbase</kbd> -> <samp>TRUE/FALSE</samp> |
* (<kbd>BOOLEAN</kbd>) |
* </li> |
* <li> |
* <kbd>ibase</kbd> -> <samp>1/0</samp> |
* (<kbd>SMALLINT</kbd>) [1] |
* </li> |
* <li> |
* <kbd>ifx</kbd> -> <samp>1/0</samp> |
* (<kbd>SMALLINT</kbd>) [1] |
* </li> |
* <li> |
* <kbd>msql</kbd> -> <samp>1/0</samp> |
* (<kbd>INTEGER</kbd>) |
* </li> |
* <li> |
* <kbd>mssql</kbd> -> <samp>1/0</samp> |
* (<kbd>BIT</kbd>) |
* </li> |
* <li> |
* <kbd>mysql</kbd> -> <samp>1/0</samp> |
* (<kbd>TINYINT(1)</kbd>) |
* </li> |
* <li> |
* <kbd>mysqli</kbd> -> <samp>1/0</samp> |
* (<kbd>TINYINT(1)</kbd>) |
* </li> |
* <li> |
* <kbd>oci8</kbd> -> <samp>1/0</samp> |
* (<kbd>NUMBER(1)</kbd>) |
* </li> |
* <li> |
* <kbd>odbc</kbd> -> <samp>1/0</samp> |
* (<kbd>SMALLINT</kbd>) [1] |
* </li> |
* <li> |
* <kbd>pgsql</kbd> -> <samp>TRUE/FALSE</samp> |
* (<kbd>BOOLEAN</kbd>) |
* </li> |
* <li> |
* <kbd>sqlite</kbd> -> <samp>1/0</samp> |
* (<kbd>INTEGER</kbd>) |
* </li> |
* <li> |
* <kbd>sybase</kbd> -> <samp>1/0</samp> |
* (<kbd>TINYINT(1)</kbd>) |
* </li> |
* </ul> |
* [1] Accommodate the lowest common denominator because not all |
* versions of have <kbd>BOOLEAN</kbd>. |
* </li> |
* <li> |
* other (including strings and numeric strings) -> |
* the data with single quotes escaped by preceeding |
* single quotes, backslashes are escaped by preceeding |
* backslashes, then the whole string is encapsulated |
* between single quotes |
* </li> |
* </ul> |
* |
* @since 1.6.0 |
* @see DB_common::escapeSimple() |
* @access public |
*/ |
function quoteSmart($in) |
{ |
if (is_int($in) || is_double($in)) { |
return $in; |
} elseif (is_bool($in)) { |
return $in ? 1 : 0; |
} elseif (is_null($in)) { |
return 'NULL'; |
} else { |
return "'" . $this->escapeSimple($in) . "'"; |
} |
} |
// }}} |
// {{{ escapeSimple() |
/** |
* Escape a string according to the current DBMS's standards |
* |
* In SQLite, this makes things safe for inserts/updates, but may |
* cause problems when performing text comparisons against columns |
* containing binary data. See the |
* {@link http://php.net/sqlite_escape_string PHP manual} for more info. |
* |
* @param string $str the string to be escaped |
* |
* @return string the escaped string |
* |
* @since 1.6.0 |
* @see DB_common::quoteSmart() |
* @access public |
*/ |
function escapeSimple($str) { |
return str_replace("'", "''", $str); |
} |
// }}} |
// {{{ provides() |
/** |
* Tell whether a DB implementation or its backend extension |
* supports a given feature |
* |
* @param array $feature name of the feature (see the DB class doc) |
* @return bool whether this DB implementation supports $feature |
* @access public |
*/ |
function provides($feature) |
{ |
return $this->features[$feature]; |
} |
// }}} |
// {{{ errorCode() |
/** |
* Map native error codes to DB's portable ones |
* |
* Requires that the DB implementation's constructor fills |
* in the <var>$errorcode_map</var> property. |
* |
* @param mixed $nativecode the native error code, as returned by the |
* backend database extension (string or integer) |
* |
* @return int a portable DB error code, or DB_ERROR if this DB |
* implementation has no mapping for the given error code. |
* |
* @access public |
*/ |
function errorCode($nativecode) |
{ |
if (isset($this->errorcode_map[$nativecode])) { |
return $this->errorcode_map[$nativecode]; |
} |
// Fall back to DB_ERROR if there was no mapping. |
return DB_ERROR; |
} |
// }}} |
// {{{ errorMessage() |
/** |
* Map a DB error code to a textual message. This is actually |
* just a wrapper for DB::errorMessage() |
* |
* @param integer $dbcode the DB error code |
* |
* @return string the corresponding error message, of false |
* if the error code was unknown |
* |
* @access public |
*/ |
function errorMessage($dbcode) |
{ |
return DB::errorMessage($this->errorcode_map[$dbcode]); |
} |
// }}} |
// {{{ raiseError() |
/** |
* Communicate an error and invoke error callbacks, etc |
* |
* Basically a wrapper for PEAR::raiseError without the message string. |
* |
* @param mixed integer error code, or a PEAR error object (all |
* other parameters are ignored if this parameter is |
* an object |
* |
* @param int error mode, see PEAR_Error docs |
* |
* @param mixed If error mode is PEAR_ERROR_TRIGGER, this is the |
* error level (E_USER_NOTICE etc). If error mode is |
* PEAR_ERROR_CALLBACK, this is the callback function, |
* either as a function name, or as an array of an |
* object and method name. For other error modes this |
* parameter is ignored. |
* |
* @param string Extra debug information. Defaults to the last |
* query and native error code. |
* |
* @param mixed Native error code, integer or string depending the |
* backend. |
* |
* @return object a PEAR error object |
* |
* @access public |
* @see PEAR_Error |
*/ |
function &raiseError($code = DB_ERROR, $mode = null, $options = null, |
$userinfo = null, $nativecode = null) |
{ |
// The error is yet a DB error object |
if (is_object($code)) { |
// because we the static PEAR::raiseError, our global |
// handler should be used if it is set |
if ($mode === null && !empty($this->_default_error_mode)) { |
$mode = $this->_default_error_mode; |
$options = $this->_default_error_options; |
} |
$tmp = PEAR::raiseError($code, null, $mode, $options, null, null, true); |
return $tmp; |
} |
if ($userinfo === null) { |
$userinfo = $this->last_query; |
} |
if ($nativecode) { |
$userinfo .= ' [nativecode=' . trim($nativecode) . ']'; |
} |
$tmp = PEAR::raiseError(null, $code, $mode, $options, $userinfo, |
'DB_Error', true); |
return $tmp; |
} |
// }}} |
// {{{ setFetchMode() |
/** |
* Sets which fetch mode should be used by default on queries |
* on this connection |
* |
* @param integer $fetchmode DB_FETCHMODE_ORDERED or |
* DB_FETCHMODE_ASSOC, possibly bit-wise OR'ed with |
* DB_FETCHMODE_FLIPPED. |
* |
* @param string $object_class The class of the object |
* to be returned by the fetch methods when |
* the DB_FETCHMODE_OBJECT mode is selected. |
* If no class is specified by default a cast |
* to object from the assoc array row will be done. |
* There is also the posibility to use and extend the |
* 'DB_row' class. |
* |
* @see DB_FETCHMODE_ORDERED |
* @see DB_FETCHMODE_ASSOC |
* @see DB_FETCHMODE_FLIPPED |
* @see DB_FETCHMODE_OBJECT |
* @see DB_row::DB_row() |
* @access public |
*/ |
function setFetchMode($fetchmode, $object_class = 'stdClass') |
{ |
switch ($fetchmode) { |
case DB_FETCHMODE_OBJECT: |
$this->fetchmode_object_class = $object_class; |
case DB_FETCHMODE_ORDERED: |
case DB_FETCHMODE_ASSOC: |
$this->fetchmode = $fetchmode; |
break; |
default: |
return $this->raiseError('invalid fetchmode mode'); |
} |
} |
// }}} |
// {{{ setOption() |
/** |
* Set run-time configuration options for PEAR DB |
* |
* Options, their data types, default values and description: |
* <ul> |
* <li> |
* <var>autofree</var> <kbd>boolean</kbd> = <samp>false</samp> |
* <br />should results be freed automatically when there are no |
* more rows? |
* </li><li> |
* <var>debug</var> <kbd>integer</kbd> = <samp>0</samp> |
* <br />debug level |
* </li><li> |
* <var>persistent</var> <kbd>boolean</kbd> = <samp>false</samp> |
* <br />should the connection be persistent? |
* </li><li> |
* <var>portability</var> <kbd>integer</kbd> = <samp>DB_PORTABILITY_NONE</samp> |
* <br />portability mode constant (see below) |
* </li><li> |
* <var>seqname_format</var> <kbd>string</kbd> = <samp>%s_seq</samp> |
* <br />the sprintf() format string used on sequence names. This |
* format is applied to sequence names passed to |
* createSequence(), nextID() and dropSequence(). |
* </li><li> |
* <var>ssl</var> <kbd>boolean</kbd> = <samp>false</samp> |
* <br />use ssl to connect? |
* </li> |
* </ul> |
* |
* ----------------------------------------- |
* |
* PORTABILITY MODES |
* |
* These modes are bitwised, so they can be combined using <kbd>|</kbd> |
* and removed using <kbd>^</kbd>. See the examples section below on how |
* to do this. |
* |
* <samp>DB_PORTABILITY_NONE</samp> |
* turn off all portability features |
* |
* This mode gets automatically turned on if the deprecated |
* <var>optimize</var> option gets set to <samp>performance</samp>. |
* |
* |
* <samp>DB_PORTABILITY_LOWERCASE</samp> |
* convert names of tables and fields to lower case when using |
* <kbd>get*()</kbd>, <kbd>fetch*()</kbd> and <kbd>tableInfo()</kbd> |
* |
* This mode gets automatically turned on in the following databases |
* if the deprecated option <var>optimize</var> gets set to |
* <samp>portability</samp>: |
* + oci8 |
* |
* |
* <samp>DB_PORTABILITY_RTRIM</samp> |
* right trim the data output by <kbd>get*()</kbd> <kbd>fetch*()</kbd> |
* |
* |
* <samp>DB_PORTABILITY_DELETE_COUNT</samp> |
* force reporting the number of rows deleted |
* |
* Some DBMS's don't count the number of rows deleted when performing |
* simple <kbd>DELETE FROM tablename</kbd> queries. This portability |
* mode tricks such DBMS's into telling the count by adding |
* <samp>WHERE 1=1</samp> to the end of <kbd>DELETE</kbd> queries. |
* |
* This mode gets automatically turned on in the following databases |
* if the deprecated option <var>optimize</var> gets set to |
* <samp>portability</samp>: |
* + fbsql |
* + mysql |
* + mysqli |
* + sqlite |
* |
* |
* <samp>DB_PORTABILITY_NUMROWS</samp> |
* enable hack that makes <kbd>numRows()</kbd> work in Oracle |
* |
* This mode gets automatically turned on in the following databases |
* if the deprecated option <var>optimize</var> gets set to |
* <samp>portability</samp>: |
* + oci8 |
* |
* |
* <samp>DB_PORTABILITY_ERRORS</samp> |
* makes certain error messages in certain drivers compatible |
* with those from other DBMS's |
* |
* + mysql, mysqli: change unique/primary key constraints |
* DB_ERROR_ALREADY_EXISTS -> DB_ERROR_CONSTRAINT |
* |
* + odbc(access): MS's ODBC driver reports 'no such field' as code |
* 07001, which means 'too few parameters.' When this option is on |
* that code gets mapped to DB_ERROR_NOSUCHFIELD. |
* DB_ERROR_MISMATCH -> DB_ERROR_NOSUCHFIELD |
* |
* |
* <samp>DB_PORTABILITY_NULL_TO_EMPTY</samp> |
* convert null values to empty strings in data output by get*() and |
* fetch*(). Needed because Oracle considers empty strings to be null, |
* while most other DBMS's know the difference between empty and null. |
* |
* |
* <samp>DB_PORTABILITY_ALL</samp> |
* turn on all portability features |
* |
* ----------------------------------------- |
* |
* Example 1. Simple setOption() example |
* <code> <?php |
* $dbh->setOption('autofree', true); |
* ?></code> |
* |
* Example 2. Portability for lowercasing and trimming |
* <code> <?php |
* $dbh->setOption('portability', |
* DB_PORTABILITY_LOWERCASE | DB_PORTABILITY_RTRIM); |
* ?></code> |
* |
* Example 3. All portability options except trimming |
* <code> <?php |
* $dbh->setOption('portability', |
* DB_PORTABILITY_ALL ^ DB_PORTABILITY_RTRIM); |
* ?></code> |
* |
* @param string $option option name |
* @param mixed $value value for the option |
* |
* @return int DB_OK on success. DB_Error object on failure. |
* |
* @see DB_common::$options |
*/ |
function setOption($option, $value) |
{ |
if (isset($this->options[$option])) { |
$this->options[$option] = $value; |
/* |
* Backwards compatibility check for the deprecated 'optimize' |
* option. Done here in case settings change after connecting. |
*/ |
if ($option == 'optimize') { |
if ($value == 'portability') { |
switch ($this->phptype) { |
case 'oci8': |
$this->options['portability'] = |
DB_PORTABILITY_LOWERCASE | |
DB_PORTABILITY_NUMROWS; |
break; |
case 'fbsql': |
case 'mysql': |
case 'mysqli': |
case 'sqlite': |
$this->options['portability'] = |
DB_PORTABILITY_DELETE_COUNT; |
break; |
} |
} else { |
$this->options['portability'] = DB_PORTABILITY_NONE; |
} |
} |
return DB_OK; |
} |
return $this->raiseError("unknown option $option"); |
} |
// }}} |
// {{{ getOption() |
/** |
* Returns the value of an option |
* |
* @param string $option option name |
* |
* @return mixed the option value |
*/ |
function getOption($option) |
{ |
if (isset($this->options[$option])) { |
return $this->options[$option]; |
} |
return $this->raiseError("unknown option $option"); |
} |
// }}} |
// {{{ prepare() |
/** |
* Prepares a query for multiple execution with execute() |
* |
* Creates a query that can be run multiple times. Each time it is run, |
* the placeholders, if any, will be replaced by the contents of |
* execute()'s $data argument. |
* |
* Three types of placeholders can be used: |
* + <kbd>?</kbd> scalar value (i.e. strings, integers). The system |
* will automatically quote and escape the data. |
* + <kbd>!</kbd> value is inserted 'as is' |
* + <kbd>&</kbd> requires a file name. The file's contents get |
* inserted into the query (i.e. saving binary |
* data in a db) |
* |
* Example 1. |
* <code> <?php |
* $sth = $dbh->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)'); |
* $data = array( |
* "John's text", |
* "'it''s good'", |
* 'filename.txt' |
* ); |
* $res = $dbh->execute($sth, $data); |
* ?></code> |
* |
* Use backslashes to escape placeholder characters if you don't want |
* them to be interpreted as placeholders: |
* <pre> |
* "UPDATE foo SET col=? WHERE col='over \& under'" |
* </pre> |
* |
* With some database backends, this is emulated. |
* |
* {@internal ibase and oci8 have their own prepare() methods.}} |
* |
* @param string $query query to be prepared |
* |
* @return mixed DB statement resource on success. DB_Error on failure. |
* |
* @see DB_common::execute() |
* @access public |
*/ |
function prepare($query) |
{ |
$tokens = preg_split('/((?<!\\\)[&?!])/', $query, -1, |
PREG_SPLIT_DELIM_CAPTURE); |
$token = 0; |
$types = array(); |
$newtokens = array(); |
foreach ($tokens as $val) { |
switch ($val) { |
case '?': |
$types[$token++] = DB_PARAM_SCALAR; |
break; |
case '&': |
$types[$token++] = DB_PARAM_OPAQUE; |
break; |
case '!': |
$types[$token++] = DB_PARAM_MISC; |
break; |
default: |
$newtokens[] = preg_replace('/\\\([&?!])/', "\\1", $val); |
} |
} |
$this->prepare_tokens[] = &$newtokens; |
end($this->prepare_tokens); |
$k = key($this->prepare_tokens); |
$this->prepare_types[$k] = $types; |
$this->prepared_queries[$k] = implode(' ', $newtokens); |
return $k; |
} |
// }}} |
// {{{ autoPrepare() |
/** |
* Automaticaly generate an insert or update query and pass it to prepare() |
* |
* @param string $table name of the table |
* @param array $table_fields ordered array containing the fields names |
* @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) |
* @param string $where in case of update queries, this string will be put after the sql WHERE statement |
* @return resource handle for the query |
* @see DB_common::prepare(), DB_common::buildManipSQL() |
* @access public |
*/ |
function autoPrepare($table, $table_fields, $mode = DB_AUTOQUERY_INSERT, $where = false) |
{ |
$query = $this->buildManipSQL($table, $table_fields, $mode, $where); |
return $this->prepare($query); |
} |
// }}} |
// {{{ autoExecute() |
/** |
* Automaticaly generate an insert or update query and call prepare() |
* and execute() with it |
* |
* @param string $table name of the table |
* @param array $fields_values assoc ($key=>$value) where $key is a field name and $value its value |
* @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) |
* @param string $where in case of update queries, this string will be put after the sql WHERE statement |
* @return mixed a new DB_Result or a DB_Error when fail |
* @see DB_common::autoPrepare(), DB_common::buildManipSQL() |
* @access public |
*/ |
function autoExecute($table, $fields_values, $mode = DB_AUTOQUERY_INSERT, $where = false) |
{ |
$sth = $this->autoPrepare($table, array_keys($fields_values), $mode, $where); |
$ret =& $this->execute($sth, array_values($fields_values)); |
$this->freePrepared($sth); |
return $ret; |
} |
// }}} |
// {{{ buildManipSQL() |
/** |
* Make automaticaly an sql query for prepare() |
* |
* Example : buildManipSQL('table_sql', array('field1', 'field2', 'field3'), DB_AUTOQUERY_INSERT) |
* will return the string : INSERT INTO table_sql (field1,field2,field3) VALUES (?,?,?) |
* NB : - This belongs more to a SQL Builder class, but this is a simple facility |
* - Be carefull ! If you don't give a $where param with an UPDATE query, all |
* the records of the table will be updated ! |
* |
* @param string $table name of the table |
* @param array $table_fields ordered array containing the fields names |
* @param int $mode type of query to make (DB_AUTOQUERY_INSERT or DB_AUTOQUERY_UPDATE) |
* @param string $where in case of update queries, this string will be put after the sql WHERE statement |
* @return string sql query for prepare() |
* @access public |
*/ |
function buildManipSQL($table, $table_fields, $mode, $where = false) |
{ |
if (count($table_fields) == 0) { |
$this->raiseError(DB_ERROR_NEED_MORE_DATA); |
} |
$first = true; |
switch ($mode) { |
case DB_AUTOQUERY_INSERT: |
$values = ''; |
$names = ''; |
foreach ($table_fields as $value) { |
if ($first) { |
$first = false; |
} else { |
$names .= ','; |
$values .= ','; |
} |
$names .= $value; |
$values .= '?'; |
} |
return "INSERT INTO $table ($names) VALUES ($values)"; |
case DB_AUTOQUERY_UPDATE: |
$set = ''; |
foreach ($table_fields as $value) { |
if ($first) { |
$first = false; |
} else { |
$set .= ','; |
} |
$set .= "$value = ?"; |
} |
$sql = "UPDATE $table SET $set"; |
if ($where) { |
$sql .= " WHERE $where"; |
} |
return $sql; |
default: |
$this->raiseError(DB_ERROR_SYNTAX); |
} |
} |
// }}} |
// {{{ execute() |
/** |
* Executes a DB statement prepared with prepare() |
* |
* Example 1. |
* <code> <?php |
* $sth = $dbh->prepare('INSERT INTO tbl (a, b, c) VALUES (?, !, &)'); |
* $data = array( |
* "John's text", |
* "'it''s good'", |
* 'filename.txt' |
* ); |
* $res =& $dbh->execute($sth, $data); |
* ?></code> |
* |
* @param resource $stmt a DB statement resource returned from prepare() |
* @param mixed $data array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return object a new DB_Result or a DB_Error when fail |
* |
* {@internal ibase and oci8 have their own execute() methods.}} |
* |
* @see DB_common::prepare() |
* @access public |
*/ |
function &execute($stmt, $data = array()) |
{ |
$realquery = $this->executeEmulateQuery($stmt, $data); |
if (DB::isError($realquery)) { |
return $realquery; |
} |
$result = $this->simpleQuery($realquery); |
if (DB::isError($result) || $result === DB_OK) { |
return $result; |
} else { |
$tmp =& new DB_result($this, $result); |
return $tmp; |
} |
} |
// }}} |
// {{{ executeEmulateQuery() |
/** |
* Emulates the execute statement, when not supported |
* |
* @param resource $stmt a DB statement resource returned from execute() |
* @param mixed $data array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return mixed a string containing the real query run when emulating |
* prepare/execute. A DB error code is returned on failure. |
* |
* @see DB_common::execute() |
* @access private |
*/ |
function executeEmulateQuery($stmt, $data = array()) |
{ |
if (!is_array($data)) { |
$data = array($data); |
} |
if (count($this->prepare_types[$stmt]) != count($data)) { |
$this->last_query = $this->prepared_queries[$stmt]; |
return $this->raiseError(DB_ERROR_MISMATCH); |
} |
$realquery = $this->prepare_tokens[$stmt][0]; |
$i = 0; |
foreach ($data as $value) { |
if ($this->prepare_types[$stmt][$i] == DB_PARAM_SCALAR) { |
$realquery .= $this->quoteSmart($value); |
} elseif ($this->prepare_types[$stmt][$i] == DB_PARAM_OPAQUE) { |
$fp = @fopen($value, 'rb'); |
if (!$fp) { |
return $this->raiseError(DB_ERROR_ACCESS_VIOLATION); |
} |
$realquery .= $this->quoteSmart(fread($fp, filesize($value))); |
fclose($fp); |
} else { |
$realquery .= $value; |
} |
$realquery .= $this->prepare_tokens[$stmt][++$i]; |
} |
return $realquery; |
} |
// }}} |
// {{{ executeMultiple() |
/** |
* This function does several execute() calls on the same |
* statement handle |
* |
* $data must be an array indexed numerically |
* from 0, one execute call is done for every "row" in the array. |
* |
* If an error occurs during execute(), executeMultiple() does not |
* execute the unfinished rows, but rather returns that error. |
* |
* @param resource $stmt query handle from prepare() |
* @param array $data numeric array containing the |
* data to insert into the query |
* |
* @return mixed DB_OK or DB_Error |
* |
* @see DB_common::prepare(), DB_common::execute() |
* @access public |
*/ |
function executeMultiple($stmt, $data) |
{ |
foreach ($data as $value) { |
$res =& $this->execute($stmt, $value); |
if (DB::isError($res)) { |
return $res; |
} |
} |
return DB_OK; |
} |
// }}} |
// {{{ freePrepared() |
/** |
* Free the resource used in a prepared query |
* |
* @param $stmt The resurce returned by the prepare() function |
* @see DB_common::prepare() |
*/ |
function freePrepared($stmt) |
{ |
// Free the internal prepared vars |
if (isset($this->prepare_tokens[$stmt])) { |
unset($this->prepare_tokens[$stmt]); |
unset($this->prepare_types[$stmt]); |
unset($this->prepared_queries[$stmt]); |
return true; |
} |
return false; |
} |
// }}} |
// {{{ modifyQuery() |
/** |
* This method is used by backends to alter queries for various |
* reasons |
* |
* It is defined here to assure that all implementations |
* have this method defined. |
* |
* @param string $query query to modify |
* |
* @return the new (modified) query |
* |
* @access private |
*/ |
function modifyQuery($query) { |
return $query; |
} |
// }}} |
// {{{ modifyLimitQuery() |
/** |
* This method is used by backends to alter limited queries |
* |
* @param string $query query to modify |
* @param integer $from the row to start to fetching |
* @param integer $count the numbers of rows to fetch |
* |
* @return the new (modified) query |
* |
* @access private |
*/ |
function modifyLimitQuery($query, $from, $count, $params = array()) |
{ |
return $query; |
} |
// }}} |
// {{{ query() |
/** |
* Send a query to the database and return any results with a |
* DB_result object |
* |
* The query string can be either a normal statement to be sent directly |
* to the server OR if <var>$params</var> are passed the query can have |
* placeholders and it will be passed through prepare() and execute(). |
* |
* @param string $query the SQL query or the statement to prepare |
* @param mixed $params array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return mixed a DB_result object or DB_OK on success, a DB |
* error on failure |
* |
* @see DB_result, DB_common::prepare(), DB_common::execute() |
* @access public |
*/ |
function &query($query, $params = array()) |
{ |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$ret =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
return $ret; |
} else { |
$result = $this->simpleQuery($query); |
if (DB::isError($result) || $result === DB_OK) { |
return $result; |
} else { |
$tmp =& new DB_result($this, $result); |
return $tmp; |
} |
} |
} |
// }}} |
// {{{ limitQuery() |
/** |
* Generates a limited query |
* |
* @param string $query query |
* @param integer $from the row to start to fetching |
* @param integer $count the numbers of rows to fetch |
* @param mixed $params array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return mixed a DB_Result object, DB_OK or a DB_Error |
* |
* @access public |
*/ |
function &limitQuery($query, $from, $count, $params = array()) |
{ |
$query = $this->modifyLimitQuery($query, $from, $count, $params); |
if (DB::isError($query)){ |
return $query; |
} |
$result =& $this->query($query, $params); |
if (is_a($result, 'DB_result')) { |
$result->setOption('limit_from', $from); |
$result->setOption('limit_count', $count); |
} |
return $result; |
} |
// }}} |
// {{{ getOne() |
/** |
* Fetch the first column of the first row of data returned from |
* a query |
* |
* Takes care of doing the query and freeing the results when finished. |
* |
* @param string $query the SQL query |
* @param mixed $params array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return mixed the returned value of the query. DB_Error on failure. |
* |
* @access public |
*/ |
function &getOne($query, $params = array()) |
{ |
settype($params, 'array'); |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$res =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
} else { |
$res =& $this->query($query); |
} |
if (DB::isError($res)) { |
return $res; |
} |
$err = $res->fetchInto($row, DB_FETCHMODE_ORDERED); |
$res->free(); |
if ($err !== DB_OK) { |
return $err; |
} |
return $row[0]; |
} |
// }}} |
// {{{ getRow() |
/** |
* Fetch the first row of data returned from a query |
* |
* Takes care of doing the query and freeing the results when finished. |
* |
* @param string $query the SQL query |
* @param array $params array to be used in execution of the statement. |
* Quantity of array elements must match quantity |
* of placeholders in query. This function does |
* NOT support scalars. |
* @param int $fetchmode the fetch mode to use |
* |
* @return array the first row of results as an array indexed from |
* 0, or a DB error code. |
* |
* @access public |
*/ |
function &getRow($query, |
$params = array(), |
$fetchmode = DB_FETCHMODE_DEFAULT) |
{ |
// compat check, the params and fetchmode parameters used to |
// have the opposite order |
if (!is_array($params)) { |
if (is_array($fetchmode)) { |
if ($params === null) { |
$tmp = DB_FETCHMODE_DEFAULT; |
} else { |
$tmp = $params; |
} |
$params = $fetchmode; |
$fetchmode = $tmp; |
} elseif ($params !== null) { |
$fetchmode = $params; |
$params = array(); |
} |
} |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$res =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
} else { |
$res =& $this->query($query); |
} |
if (DB::isError($res)) { |
return $res; |
} |
$err = $res->fetchInto($row, $fetchmode); |
$res->free(); |
if ($err !== DB_OK) { |
return $err; |
} |
return $row; |
} |
// }}} |
// {{{ getCol() |
/** |
* Fetch a single column from a result set and return it as an |
* indexed array |
* |
* @param string $query the SQL query |
* @param mixed $col which column to return (integer [column number, |
* starting at 0] or string [column name]) |
* @param mixed $params array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* |
* @return array an indexed array with the data from the first |
* row at index 0, or a DB error code |
* |
* @see DB_common::query() |
* @access public |
*/ |
function &getCol($query, $col = 0, $params = array()) |
{ |
settype($params, 'array'); |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$res =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
} else { |
$res =& $this->query($query); |
} |
if (DB::isError($res)) { |
return $res; |
} |
$fetchmode = is_int($col) ? DB_FETCHMODE_ORDERED : DB_FETCHMODE_ASSOC; |
if (!is_array($row = $res->fetchRow($fetchmode))) { |
$ret = array(); |
} else { |
if (!array_key_exists($col, $row)) { |
$ret =& $this->raiseError(DB_ERROR_NOSUCHFIELD); |
} else { |
$ret = array($row[$col]); |
while (is_array($row = $res->fetchRow($fetchmode))) { |
$ret[] = $row[$col]; |
} |
} |
} |
$res->free(); |
if (DB::isError($row)) { |
$ret = $row; |
} |
return $ret; |
} |
// }}} |
// {{{ getAssoc() |
/** |
* Fetch the entire result set of a query and return it as an |
* associative array using the first column as the key |
* |
* If the result set contains more than two columns, the value |
* will be an array of the values from column 2-n. If the result |
* set contains only two columns, the returned value will be a |
* scalar with the value of the second column (unless forced to an |
* array with the $force_array parameter). A DB error code is |
* returned on errors. If the result set contains fewer than two |
* columns, a DB_ERROR_TRUNCATED error is returned. |
* |
* For example, if the table "mytable" contains: |
* |
* <pre> |
* ID TEXT DATE |
* -------------------------------- |
* 1 'one' 944679408 |
* 2 'two' 944679408 |
* 3 'three' 944679408 |
* </pre> |
* |
* Then the call getAssoc('SELECT id,text FROM mytable') returns: |
* <pre> |
* array( |
* '1' => 'one', |
* '2' => 'two', |
* '3' => 'three', |
* ) |
* </pre> |
* |
* ...while the call getAssoc('SELECT id,text,date FROM mytable') returns: |
* <pre> |
* array( |
* '1' => array('one', '944679408'), |
* '2' => array('two', '944679408'), |
* '3' => array('three', '944679408') |
* ) |
* </pre> |
* |
* If the more than one row occurs with the same value in the |
* first column, the last row overwrites all previous ones by |
* default. Use the $group parameter if you don't want to |
* overwrite like this. Example: |
* |
* <pre> |
* getAssoc('SELECT category,id,name FROM mytable', false, null, |
* DB_FETCHMODE_ASSOC, true) returns: |
* |
* array( |
* '1' => array(array('id' => '4', 'name' => 'number four'), |
* array('id' => '6', 'name' => 'number six') |
* ), |
* '9' => array(array('id' => '4', 'name' => 'number four'), |
* array('id' => '6', 'name' => 'number six') |
* ) |
* ) |
* </pre> |
* |
* Keep in mind that database functions in PHP usually return string |
* values for results regardless of the database's internal type. |
* |
* @param string $query the SQL query |
* @param boolean $force_array used only when the query returns |
* exactly two columns. If true, the values |
* of the returned array will be one-element |
* arrays instead of scalars. |
* @param mixed $params array, string or numeric data to be used in |
* execution of the statement. Quantity of items |
* passed must match quantity of placeholders in |
* query: meaning 1 placeholder for non-array |
* parameters or 1 placeholder per array element. |
* @param int $fetchmode the fetch mode to use |
* @param boolean $group if true, the values of the returned array |
* is wrapped in another array. If the same |
* key value (in the first column) repeats |
* itself, the values will be appended to |
* this array instead of overwriting the |
* existing values. |
* |
* @return array associative array with results from the query. |
* DB Error on failure. |
* |
* @access public |
*/ |
function &getAssoc($query, $force_array = false, $params = array(), |
$fetchmode = DB_FETCHMODE_DEFAULT, $group = false) |
{ |
settype($params, 'array'); |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$res =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
} else { |
$res =& $this->query($query); |
} |
if (DB::isError($res)) { |
return $res; |
} |
if ($fetchmode == DB_FETCHMODE_DEFAULT) { |
$fetchmode = $this->fetchmode; |
} |
$cols = $res->numCols(); |
if ($cols < 2) { |
$tmp =& $this->raiseError(DB_ERROR_TRUNCATED); |
return $tmp; |
} |
$results = array(); |
if ($cols > 2 || $force_array) { |
// return array values |
// XXX this part can be optimized |
if ($fetchmode == DB_FETCHMODE_ASSOC) { |
while (is_array($row = $res->fetchRow(DB_FETCHMODE_ASSOC))) { |
reset($row); |
$key = current($row); |
unset($row[key($row)]); |
if ($group) { |
$results[$key][] = $row; |
} else { |
$results[$key] = $row; |
} |
} |
} elseif ($fetchmode == DB_FETCHMODE_OBJECT) { |
while ($row = $res->fetchRow(DB_FETCHMODE_OBJECT)) { |
$arr = get_object_vars($row); |
$key = current($arr); |
if ($group) { |
$results[$key][] = $row; |
} else { |
$results[$key] = $row; |
} |
} |
} else { |
while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) { |
// we shift away the first element to get |
// indices running from 0 again |
$key = array_shift($row); |
if ($group) { |
$results[$key][] = $row; |
} else { |
$results[$key] = $row; |
} |
} |
} |
if (DB::isError($row)) { |
$results = $row; |
} |
} else { |
// return scalar values |
while (is_array($row = $res->fetchRow(DB_FETCHMODE_ORDERED))) { |
if ($group) { |
$results[$row[0]][] = $row[1]; |
} else { |
$results[$row[0]] = $row[1]; |
} |
} |
if (DB::isError($row)) { |
$results = $row; |
} |
} |
$res->free(); |
return $results; |
} |
// }}} |
// {{{ getAll() |
/** |
* Fetch all the rows returned from a query |
* |
* @param string $query the SQL query |
* @param array $params array to be used in execution of the statement. |
* Quantity of array elements must match quantity |
* of placeholders in query. This function does |
* NOT support scalars. |
* @param int $fetchmode the fetch mode to use |
* |
* @return array an nested array. DB error on failure. |
* |
* @access public |
*/ |
function &getAll($query, |
$params = array(), |
$fetchmode = DB_FETCHMODE_DEFAULT) |
{ |
// compat check, the params and fetchmode parameters used to |
// have the opposite order |
if (!is_array($params)) { |
if (is_array($fetchmode)) { |
if ($params === null) { |
$tmp = DB_FETCHMODE_DEFAULT; |
} else { |
$tmp = $params; |
} |
$params = $fetchmode; |
$fetchmode = $tmp; |
} elseif ($params !== null) { |
$fetchmode = $params; |
$params = array(); |
} |
} |
if (sizeof($params) > 0) { |
$sth = $this->prepare($query); |
if (DB::isError($sth)) { |
return $sth; |
} |
$res =& $this->execute($sth, $params); |
$this->freePrepared($sth); |
} else { |
$res =& $this->query($query); |
} |
if (DB::isError($res) || $res === DB_OK) { |
return $res; |
} |
$results = array(); |
while (DB_OK === $res->fetchInto($row, $fetchmode)) { |
if ($fetchmode & DB_FETCHMODE_FLIPPED) { |
foreach ($row as $key => $val) { |
$results[$key][] = $val; |
} |
} else { |
$results[] = $row; |
} |
} |
$res->free(); |
if (DB::isError($row)) { |
$tmp =& $this->raiseError($row); |
return $tmp; |
} |
return $results; |
} |
// }}} |
// {{{ autoCommit() |
/** |
* enable automatic Commit |
* |
* @param boolean $onoff |
* @return mixed DB_Error |
* |
* @access public |
*/ |
function autoCommit($onoff=false) |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ commit() |
/** |
* starts a Commit |
* |
* @return mixed DB_Error |
* |
* @access public |
*/ |
function commit() |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ rollback() |
/** |
* starts a rollback |
* |
* @return mixed DB_Error |
* |
* @access public |
*/ |
function rollback() |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ numRows() |
/** |
* Returns the number of rows in a result object |
* |
* @param object DB_Result the result object to check |
* |
* @return mixed DB_Error or the number of rows |
* |
* @access public |
*/ |
function numRows($result) |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ affectedRows() |
/** |
* Returns the affected rows of a query |
* |
* @return mixed DB_Error or number of rows |
* |
* @access public |
*/ |
function affectedRows() |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ errorNative() |
/** |
* Returns an errormessage, provides by the database |
* |
* @return mixed DB_Error or message |
* |
* @access public |
*/ |
function errorNative() |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ getSequenceName() |
/** |
* Generate the name used inside the database for a sequence |
* |
* The createSequence() docblock contains notes about storing sequence |
* names. |
* |
* @param string $sqn the sequence's public name |
* |
* @return string the sequence's name in the backend |
* |
* @see DB_common::createSequence(), DB_common::dropSequence(), |
* DB_common::nextID(), DB_common::setOption() |
* @access private |
*/ |
function getSequenceName($sqn) |
{ |
return sprintf($this->getOption('seqname_format'), |
preg_replace('/[^a-z0-9_.]/i', '_', $sqn)); |
} |
// }}} |
// {{{ nextId() |
/** |
* Returns the next free id in a sequence |
* |
* @param string $seq_name name of the sequence |
* @param boolean $ondemand when true, the seqence is automatically |
* created if it does not exist |
* |
* @return int the next id number in the sequence. DB_Error if problem. |
* |
* @see DB_common::createSequence(), DB_common::dropSequence(), |
* DB_common::getSequenceName() |
* @access public |
*/ |
function nextId($seq_name, $ondemand = true) |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ createSequence() |
/** |
* Creates a new sequence |
* |
* The name of a given sequence is determined by passing the string |
* provided in the <var>$seq_name</var> argument through PHP's sprintf() |
* function using the value from the <var>seqname_format</var> option as |
* the sprintf()'s format argument. |
* |
* <var>seqname_format</var> is set via setOption(). |
* |
* @param string $seq_name name of the new sequence |
* |
* @return int DB_OK on success. A DB_Error object is returned if |
* problems arise. |
* |
* @see DB_common::dropSequence(), DB_common::getSequenceName(), |
* DB_common::nextID() |
* @access public |
*/ |
function createSequence($seq_name) |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ dropSequence() |
/** |
* Deletes a sequence |
* |
* @param string $seq_name name of the sequence to be deleted |
* |
* @return int DB_OK on success. DB_Error if problems. |
* |
* @see DB_common::createSequence(), DB_common::getSequenceName(), |
* DB_common::nextID() |
* @access public |
*/ |
function dropSequence($seq_name) |
{ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ tableInfo() |
/** |
* Returns information about a table or a result set |
* |
* The format of the resulting array depends on which <var>$mode</var> |
* you select. The sample output below is based on this query: |
* <pre> |
* SELECT tblFoo.fldID, tblFoo.fldPhone, tblBar.fldId |
* FROM tblFoo |
* JOIN tblBar ON tblFoo.fldId = tblBar.fldId |
* </pre> |
* |
* <ul> |
* <li> |
* |
* <kbd>null</kbd> (default) |
* <pre> |
* [0] => Array ( |
* [table] => tblFoo |
* [name] => fldId |
* [type] => int |
* [len] => 11 |
* [flags] => primary_key not_null |
* ) |
* [1] => Array ( |
* [table] => tblFoo |
* [name] => fldPhone |
* [type] => string |
* [len] => 20 |
* [flags] => |
* ) |
* [2] => Array ( |
* [table] => tblBar |
* [name] => fldId |
* [type] => int |
* [len] => 11 |
* [flags] => primary_key not_null |
* ) |
* </pre> |
* |
* </li><li> |
* |
* <kbd>DB_TABLEINFO_ORDER</kbd> |
* |
* <p>In addition to the information found in the default output, |
* a notation of the number of columns is provided by the |
* <samp>num_fields</samp> element while the <samp>order</samp> |
* element provides an array with the column names as the keys and |
* their location index number (corresponding to the keys in the |
* the default output) as the values.</p> |
* |
* <p>If a result set has identical field names, the last one is |
* used.</p> |
* |
* <pre> |
* [num_fields] => 3 |
* [order] => Array ( |
* [fldId] => 2 |
* [fldTrans] => 1 |
* ) |
* </pre> |
* |
* </li><li> |
* |
* <kbd>DB_TABLEINFO_ORDERTABLE</kbd> |
* |
* <p>Similar to <kbd>DB_TABLEINFO_ORDER</kbd> but adds more |
* dimensions to the array in which the table names are keys and |
* the field names are sub-keys. This is helpful for queries that |
* join tables which have identical field names.</p> |
* |
* <pre> |
* [num_fields] => 3 |
* [ordertable] => Array ( |
* [tblFoo] => Array ( |
* [fldId] => 0 |
* [fldPhone] => 1 |
* ) |
* [tblBar] => Array ( |
* [fldId] => 2 |
* ) |
* ) |
* </pre> |
* |
* </li> |
* </ul> |
* |
* The <samp>flags</samp> element contains a space separated list |
* of extra information about the field. This data is inconsistent |
* between DBMS's due to the way each DBMS works. |
* + <samp>primary_key</samp> |
* + <samp>unique_key</samp> |
* + <samp>multiple_key</samp> |
* + <samp>not_null</samp> |
* |
* Most DBMS's only provide the <samp>table</samp> and <samp>flags</samp> |
* elements if <var>$result</var> is a table name. The following DBMS's |
* provide full information from queries: |
* + fbsql |
* + mysql |
* |
* If the 'portability' option has <samp>DB_PORTABILITY_LOWERCASE</samp> |
* turned on, the names of tables and fields will be lowercased. |
* |
* @param object|string $result DB_result object from a query or a |
* string containing the name of a table. |
* While this also accepts a query result |
* resource identifier, this behavior is |
* deprecated. |
* @param int $mode either unused or one of the tableInfo modes: |
* <kbd>DB_TABLEINFO_ORDERTABLE</kbd>, |
* <kbd>DB_TABLEINFO_ORDER</kbd> or |
* <kbd>DB_TABLEINFO_FULL</kbd> (which does both). |
* These are bitwise, so the first two can be |
* combined using <kbd>|</kbd>. |
* @return array an associative array with the information requested. |
* If something goes wrong an error object is returned. |
* |
* @see DB_common::setOption() |
* @access public |
*/ |
function tableInfo($result, $mode = null) |
{ |
/* |
* If the DB_<driver> class has a tableInfo() method, that one |
* overrides this one. But, if the driver doesn't have one, |
* this method runs and tells users about that fact. |
*/ |
return $this->raiseError(DB_ERROR_NOT_CAPABLE); |
} |
// }}} |
// {{{ getTables() |
/** |
* @deprecated Deprecated in release 1.2 or lower |
*/ |
function getTables() |
{ |
return $this->getListOf('tables'); |
} |
// }}} |
// {{{ getListOf() |
/** |
* list internal DB info |
* valid values for $type are db dependent, |
* often: databases, users, view, functions |
* |
* @param string $type type of requested info |
* |
* @return mixed DB_Error or the requested data |
* |
* @access public |
*/ |
function getListOf($type) |
{ |
$sql = $this->getSpecialQuery($type); |
if ($sql === null) { // No support |
return $this->raiseError(DB_ERROR_UNSUPPORTED); |
} elseif (is_int($sql) || DB::isError($sql)) { // Previous error |
return $this->raiseError($sql); |
} elseif (is_array($sql)) { // Already the result |
return $sql; |
} |
return $this->getCol($sql); // Launch this query |
} |
// }}} |
// {{{ getSpecialQuery() |
/** |
* Returns the query needed to get some backend info |
* |
* @param string $type What kind of info you want to retrieve |
* |
* @return string The SQL query string |
* |
* @access public |
*/ |
function getSpecialQuery($type) |
{ |
return $this->raiseError(DB_ERROR_UNSUPPORTED); |
} |
// }}} |
// {{{ _rtrimArrayValues() |
/** |
* Right trim all strings in an array |
* |
* @param array $array the array to be trimmed (passed by reference) |
* @return void |
* @access private |
*/ |
function _rtrimArrayValues(&$array) |
{ |
foreach ($array as $key => $value) { |
if (is_string($value)) { |
$array[$key] = rtrim($value); |
} |
} |
} |
// }}} |
// {{{ _convertNullArrayValuesToEmpty() |
/** |
* Convert all null values in an array to empty strings |
* |
* @param array $array the array to be de-nullified (passed by reference) |
* @return void |
* @access private |
*/ |
function _convertNullArrayValuesToEmpty(&$array) |
{ |
foreach ($array as $key => $value) { |
if (is_null($value)) { |
$array[$key] = ''; |
} |
} |
} |
// }}} |
} |
/* |
* Local variables: |
* tab-width: 4 |
* c-basic-offset: 4 |
* End: |
*/ |
?> |
/trunk/applications/jrest/lib/DB/mysql.php |
---|
New file |
0,0 → 1,916 |
<?php |
/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */ |
// +----------------------------------------------------------------------+ |
// | PHP Version 4 | |
// +----------------------------------------------------------------------+ |
// | Copyright (c) 1997-2004 The PHP Group | |
// +----------------------------------------------------------------------+ |
// | This source file is subject to version 2.02 of the PHP license, | |
// | that is bundled with this package in the file LICENSE, and is | |
// | available at through the world-wide-web at | |
// | http://www.php.net/license/2_02.txt. | |
// | If you did not receive a copy of the PHP license and are unable to | |
// | obtain it through the world-wide-web, please send a note to | |
// | license@php.net so we can mail you a copy immediately. | |
// +----------------------------------------------------------------------+ |
// | Author: Stig Bakken <ssb@php.net> | |
// | Maintainer: Daniel Convissor <danielc@php.net> | |
// +----------------------------------------------------------------------+ |
// |
// $Id$ |
// XXX legend: |
// |
// XXX ERRORMSG: The error message from the mysql function should |
// be registered here. |
// |
// TODO/wishlist: |
// longReadlen |
// binmode |
require_once 'DB/common.php'; |
/** |
* Database independent query interface definition for PHP's MySQL |
* extension. |
* |
* This is for MySQL versions 4.0 and below. |
* |
* @package DB |
* @version $Id$ |
* @category Database |
* @author Stig Bakken <ssb@php.net> |
*/ |
class DB_mysql extends DB_common |
{ |
// {{{ properties |
var $connection; |
var $phptype, $dbsyntax; |
var $prepare_tokens = array(); |
var $prepare_types = array(); |
var $num_rows = array(); |
var $transaction_opcount = 0; |
var $autocommit = true; |
var $fetchmode = DB_FETCHMODE_ORDERED; /* Default fetch mode */ |
var $_db = false; |
// }}} |
// {{{ constructor |
/** |
* DB_mysql constructor. |
* |
* @access public |
*/ |
function DB_mysql() |
{ |
$this->DB_common(); |
$this->phptype = 'mysql'; |
$this->dbsyntax = 'mysql'; |
$this->features = array( |
'prepare' => false, |
'pconnect' => true, |
'transactions' => true, |
'limit' => 'alter' |
); |
$this->errorcode_map = array( |
1004 => DB_ERROR_CANNOT_CREATE, |
1005 => DB_ERROR_CANNOT_CREATE, |
1006 => DB_ERROR_CANNOT_CREATE, |
1007 => DB_ERROR_ALREADY_EXISTS, |
1008 => DB_ERROR_CANNOT_DROP, |
1022 => DB_ERROR_ALREADY_EXISTS, |
1046 => DB_ERROR_NODBSELECTED, |
1048 => DB_ERROR_CONSTRAINT, |
1050 => DB_ERROR_ALREADY_EXISTS, |
1051 => DB_ERROR_NOSUCHTABLE, |
1054 => DB_ERROR_NOSUCHFIELD, |
1062 => DB_ERROR_ALREADY_EXISTS, |
1064 => DB_ERROR_SYNTAX, |
1100 => DB_ERROR_NOT_LOCKED, |
1136 => DB_ERROR_VALUE_COUNT_ON_ROW, |
1146 => DB_ERROR_NOSUCHTABLE, |
1216 => DB_ERROR_CONSTRAINT, |
1217 => DB_ERROR_CONSTRAINT, |
); |
} |
// }}} |
// {{{ connect() |
/** |
* Connect to a database and log in as the specified user. |
* |
* @param $dsn the data source name (see DB::parseDSN for syntax) |
* @param $persistent (optional) whether the connection should |
* be persistent |
* @access public |
* @return int DB_OK on success, a DB error on failure |
*/ |
function connect($dsninfo, $persistent = false) |
{ |
if (!DB::assertExtension('mysql')) { |
return $this->raiseError(DB_ERROR_EXTENSION_NOT_FOUND); |
} |
$this->dsn = $dsninfo; |
if ($dsninfo['protocol'] && $dsninfo['protocol'] == 'unix') { |
$dbhost = ':' . $dsninfo['socket']; |
} else { |
$dbhost = $dsninfo['hostspec'] ? $dsninfo['hostspec'] : 'localhost'; |
if ($dsninfo['port']) { |
$dbhost .= ':' . $dsninfo['port']; |
} |
} |
$connect_function = $persistent ? 'mysql_pconnect' : 'mysql_connect'; |
if ($dbhost && $dsninfo['username'] && isset($dsninfo['password'])) { |
$conn = @$connect_function($dbhost, $dsninfo['username'], |
$dsninfo['password']); |
} elseif ($dbhost && $dsninfo['username']) { |
$conn = @$connect_function($dbhost, $dsninfo['username']); |
} elseif ($dbhost) { |
$conn = @$connect_function($dbhost); |
} else { |
$conn = false; |
} |
if (!$conn) { |
if (($err = @mysql_error()) != '') { |
return $this->raiseError(DB_ERROR_CONNECT_FAILED, null, null, |
null, $err); |
} elseif (empty($php_errormsg)) { |
return $this->raiseError(DB_ERROR_CONNECT_FAILED); |
} else { |
return $this->raiseError(DB_ERROR_CONNECT_FAILED, null, null, |
null, $php_errormsg); |
} |
} |
if ($dsninfo['database']) { |
if (!@mysql_select_db($dsninfo['database'], $conn)) { |
switch(mysql_errno($conn)) { |
case 1049: |
return $this->raiseError(DB_ERROR_NOSUCHDB, null, null, |
null, @mysql_error($conn)); |
case 1044: |
return $this->raiseError(DB_ERROR_ACCESS_VIOLATION, null, null, |
null, @mysql_error($conn)); |
default: |
return $this->raiseError(DB_ERROR, null, null, |
null, @mysql_error($conn)); |
} |
} |
// fix to allow calls to different databases in the same script |
$this->_db = $dsninfo['database']; |
} |
$this->connection = $conn; |
return DB_OK; |
} |
// }}} |
// {{{ disconnect() |
/** |
* Log out and disconnect from the database. |
* |
* @access public |
* |
* @return bool true on success, false if not connected. |
*/ |
function disconnect() |
{ |
$ret = @mysql_close($this->connection); |
$this->connection = null; |
return $ret; |
} |
// }}} |
// {{{ simpleQuery() |
/** |
* Send a query to MySQL and return the results as a MySQL resource |
* identifier. |
* |
* @param the SQL query |
* |
* @access public |
* |
* @return mixed returns a valid MySQL result for successful SELECT |
* queries, DB_OK for other successful queries. A DB error is |
* returned on failure. |
*/ |
function simpleQuery($query) |
{ |
$ismanip = DB::isManip($query); |
$this->last_query = $query; |
$query = $this->modifyQuery($query); |
if ($this->_db) { |
if (!@mysql_select_db($this->_db, $this->connection)) { |
return $this->mysqlRaiseError(DB_ERROR_NODBSELECTED); |
} |
} |
if (!$this->autocommit && $ismanip) { |
if ($this->transaction_opcount == 0) { |
$result = @mysql_query('SET AUTOCOMMIT=0', $this->connection); |
$result = @mysql_query('BEGIN', $this->connection); |
if (!$result) { |
return $this->mysqlRaiseError(); |
} |
} |
$this->transaction_opcount++; |
} |
$result = @mysql_query($query, $this->connection); |
if (!$result) { |
return $this->mysqlRaiseError(); |
} |
if (is_resource($result)) { |
$numrows = $this->numrows($result); |
if (is_object($numrows)) { |
return $numrows; |
} |
$this->num_rows[(int)$result] = $numrows; |
return $result; |
} |
return DB_OK; |
} |
// }}} |
// {{{ nextResult() |
/** |
* Move the internal mysql result pointer to the next available result |
* |
* This method has not been implemented yet. |
* |
* @param a valid sql result resource |
* |
* @access public |
* |
* @return false |
*/ |
function nextResult($result) |
{ |
return false; |
} |
// }}} |
// {{{ fetchInto() |
/** |
* Fetch a row and insert the data into an existing array. |
* |
* Formating of the array and the data therein are configurable. |
* See DB_result::fetchInto() for more information. |
* |
* @param resource $result query result identifier |
* @param array $arr (reference) array where data from the row |
* should be placed |
* @param int $fetchmode how the resulting array should be indexed |
* @param int $rownum the row number to fetch |
* |
* @return mixed DB_OK on success, null when end of result set is |
* reached or on failure |
* |
* @see DB_result::fetchInto() |
* @access private |
*/ |
function fetchInto($result, &$arr, $fetchmode, $rownum=null) |
{ |
if ($rownum !== null) { |
if (!@mysql_data_seek($result, $rownum)) { |
return null; |
} |
} |
if ($fetchmode & DB_FETCHMODE_ASSOC) { |
$arr = @mysql_fetch_array($result, MYSQL_ASSOC); |
if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE && $arr) { |
$arr = array_change_key_case($arr, CASE_LOWER); |
} |
} else { |
$arr = @mysql_fetch_row($result); |
} |
if (!$arr) { |
// See: http://bugs.php.net/bug.php?id=22328 |
// for why we can't check errors on fetching |
return null; |
/* |
$errno = @mysql_errno($this->connection); |
if (!$errno) { |
return null; |
} |
return $this->mysqlRaiseError($errno); |
*/ |
} |
if ($this->options['portability'] & DB_PORTABILITY_RTRIM) { |
/* |
* Even though this DBMS already trims output, we do this because |
* a field might have intentional whitespace at the end that |
* gets removed by DB_PORTABILITY_RTRIM under another driver. |
*/ |
$this->_rtrimArrayValues($arr); |
} |
if ($this->options['portability'] & DB_PORTABILITY_NULL_TO_EMPTY) { |
$this->_convertNullArrayValuesToEmpty($arr); |
} |
return DB_OK; |
} |
// }}} |
// {{{ freeResult() |
/** |
* Free the internal resources associated with $result. |
* |
* @param $result MySQL result identifier |
* |
* @access public |
* |
* @return bool true on success, false if $result is invalid |
*/ |
function freeResult($result) |
{ |
unset($this->num_rows[(int)$result]); |
return @mysql_free_result($result); |
} |
// }}} |
// {{{ numCols() |
/** |
* Get the number of columns in a result set. |
* |
* @param $result MySQL result identifier |
* |
* @access public |
* |
* @return int the number of columns per row in $result |
*/ |
function numCols($result) |
{ |
$cols = @mysql_num_fields($result); |
if (!$cols) { |
return $this->mysqlRaiseError(); |
} |
return $cols; |
} |
// }}} |
// {{{ numRows() |
/** |
* Get the number of rows in a result set. |
* |
* @param $result MySQL result identifier |
* |
* @access public |
* |
* @return int the number of rows in $result |
*/ |
function numRows($result) |
{ |
$rows = @mysql_num_rows($result); |
if ($rows === null) { |
return $this->mysqlRaiseError(); |
} |
return $rows; |
} |
// }}} |
// {{{ autoCommit() |
/** |
* Enable/disable automatic commits |
*/ |
function autoCommit($onoff = false) |
{ |
// XXX if $this->transaction_opcount > 0, we should probably |
// issue a warning here. |
$this->autocommit = $onoff ? true : false; |
return DB_OK; |
} |
// }}} |
// {{{ commit() |
/** |
* Commit the current transaction. |
*/ |
function commit() |
{ |
if ($this->transaction_opcount > 0) { |
if ($this->_db) { |
if (!@mysql_select_db($this->_db, $this->connection)) { |
return $this->mysqlRaiseError(DB_ERROR_NODBSELECTED); |
} |
} |
$result = @mysql_query('COMMIT', $this->connection); |
$result = @mysql_query('SET AUTOCOMMIT=1', $this->connection); |
$this->transaction_opcount = 0; |
if (!$result) { |
return $this->mysqlRaiseError(); |
} |
} |
return DB_OK; |
} |
// }}} |
// {{{ rollback() |
/** |
* Roll back (undo) the current transaction. |
*/ |
function rollback() |
{ |
if ($this->transaction_opcount > 0) { |
if ($this->_db) { |
if (!@mysql_select_db($this->_db, $this->connection)) { |
return $this->mysqlRaiseError(DB_ERROR_NODBSELECTED); |
} |
} |
$result = @mysql_query('ROLLBACK', $this->connection); |
$result = @mysql_query('SET AUTOCOMMIT=1', $this->connection); |
$this->transaction_opcount = 0; |
if (!$result) { |
return $this->mysqlRaiseError(); |
} |
} |
return DB_OK; |
} |
// }}} |
// {{{ affectedRows() |
/** |
* Gets the number of rows affected by the data manipulation |
* query. For other queries, this function returns 0. |
* |
* @return number of rows affected by the last query |
*/ |
function affectedRows() |
{ |
if (DB::isManip($this->last_query)) { |
return @mysql_affected_rows($this->connection); |
} else { |
return 0; |
} |
} |
// }}} |
// {{{ errorNative() |
/** |
* Get the native error code of the last error (if any) that |
* occured on the current connection. |
* |
* @access public |
* |
* @return int native MySQL error code |
*/ |
function errorNative() |
{ |
return @mysql_errno($this->connection); |
} |
// }}} |
// {{{ nextId() |
/** |
* Returns the next free id in a sequence |
* |
* @param string $seq_name name of the sequence |
* @param boolean $ondemand when true, the seqence is automatically |
* created if it does not exist |
* |
* @return int the next id number in the sequence. DB_Error if problem. |
* |
* @internal |
* @see DB_common::nextID() |
* @access public |
*/ |
function nextId($seq_name, $ondemand = true) |
{ |
$seqname = $this->getSequenceName($seq_name); |
do { |
$repeat = 0; |
$this->pushErrorHandling(PEAR_ERROR_RETURN); |
$result = $this->query("UPDATE ${seqname} ". |
'SET id=LAST_INSERT_ID(id+1)'); |
$this->popErrorHandling(); |
if ($result === DB_OK) { |
/** COMMON CASE **/ |
$id = @mysql_insert_id($this->connection); |
if ($id != 0) { |
return $id; |
} |
/** EMPTY SEQ TABLE **/ |
// Sequence table must be empty for some reason, so fill it and return 1 |
// Obtain a user-level lock |
$result = $this->getOne("SELECT GET_LOCK('${seqname}_lock',10)"); |
if (DB::isError($result)) { |
return $this->raiseError($result); |
} |
if ($result == 0) { |
// Failed to get the lock, bail with a DB_ERROR_NOT_LOCKED error |
return $this->mysqlRaiseError(DB_ERROR_NOT_LOCKED); |
} |
// add the default value |
$result = $this->query("REPLACE INTO ${seqname} (id) VALUES (0)"); |
if (DB::isError($result)) { |
return $this->raiseError($result); |
} |
// Release the lock |
$result = $this->getOne("SELECT RELEASE_LOCK('${seqname}_lock')"); |
if (DB::isError($result)) { |
return $this->raiseError($result); |
} |
// We know what the result will be, so no need to try again |
return 1; |
/** ONDEMAND TABLE CREATION **/ |
} elseif ($ondemand && DB::isError($result) && |
$result->getCode() == DB_ERROR_NOSUCHTABLE) |
{ |
$result = $this->createSequence($seq_name); |
if (DB::isError($result)) { |
return $this->raiseError($result); |
} else { |
$repeat = 1; |
} |
/** BACKWARDS COMPAT **/ |
} elseif (DB::isError($result) && |
$result->getCode() == DB_ERROR_ALREADY_EXISTS) |
{ |
// see _BCsequence() comment |
$result = $this->_BCsequence($seqname); |
if (DB::isError($result)) { |
return $this->raiseError($result); |
} |
$repeat = 1; |
} |
} while ($repeat); |
return $this->raiseError($result); |
} |
// }}} |
// {{{ createSequence() |
/** |
* Creates a new sequence |
* |
* @param string $seq_name name of the new sequence |
* |
* @return int DB_OK on success. A DB_Error object is returned if |
* problems arise. |
* |
* @internal |
* @see DB_common::createSequence() |
* @access public |
*/ |
function createSequence($seq_name) |
{ |
$seqname = $this->getSequenceName($seq_name); |
$res = $this->query("CREATE TABLE ${seqname} ". |
'(id INTEGER UNSIGNED AUTO_INCREMENT NOT NULL,'. |
' PRIMARY KEY(id))'); |
if (DB::isError($res)) { |
return $res; |
} |
// insert yields value 1, nextId call will generate ID 2 |
$res = $this->query("INSERT INTO ${seqname} (id) VALUES (0)"); |
if (DB::isError($res)) { |
return $res; |
} |
// so reset to zero |
return $this->query("UPDATE ${seqname} SET id = 0;"); |
} |
// }}} |
// {{{ dropSequence() |
/** |
* Deletes a sequence |
* |
* @param string $seq_name name of the sequence to be deleted |
* |
* @return int DB_OK on success. DB_Error if problems. |
* |
* @internal |
* @see DB_common::dropSequence() |
* @access public |
*/ |
function dropSequence($seq_name) |
{ |
return $this->query('DROP TABLE ' . $this->getSequenceName($seq_name)); |
} |
// }}} |
// {{{ _BCsequence() |
/** |
* Backwards compatibility with old sequence emulation implementation |
* (clean up the dupes) |
* |
* @param string $seqname The sequence name to clean up |
* @return mixed DB_Error or true |
*/ |
function _BCsequence($seqname) |
{ |
// Obtain a user-level lock... this will release any previous |
// application locks, but unlike LOCK TABLES, it does not abort |
// the current transaction and is much less frequently used. |
$result = $this->getOne("SELECT GET_LOCK('${seqname}_lock',10)"); |
if (DB::isError($result)) { |
return $result; |
} |
if ($result == 0) { |
// Failed to get the lock, can't do the conversion, bail |
// with a DB_ERROR_NOT_LOCKED error |
return $this->mysqlRaiseError(DB_ERROR_NOT_LOCKED); |
} |
$highest_id = $this->getOne("SELECT MAX(id) FROM ${seqname}"); |
if (DB::isError($highest_id)) { |
return $highest_id; |
} |
// This should kill all rows except the highest |
// We should probably do something if $highest_id isn't |
// numeric, but I'm at a loss as how to handle that... |
$result = $this->query("DELETE FROM ${seqname} WHERE id <> $highest_id"); |
if (DB::isError($result)) { |
return $result; |
} |
// If another thread has been waiting for this lock, |
// it will go thru the above procedure, but will have no |
// real effect |
$result = $this->getOne("SELECT RELEASE_LOCK('${seqname}_lock')"); |
if (DB::isError($result)) { |
return $result; |
} |
return true; |
} |
// }}} |
// {{{ quoteIdentifier() |
/** |
* Quote a string so it can be safely used as a table or column name |
* |
* Quoting style depends on which database driver is being used. |
* |
* MySQL can't handle the backtick character (<kbd>`</kbd>) in |
* table or column names. |
* |
* @param string $str identifier name to be quoted |
* |
* @return string quoted identifier string |
* |
* @since 1.6.0 |
* @access public |
* @internal |
*/ |
function quoteIdentifier($str) |
{ |
return '`' . $str . '`'; |
} |
// }}} |
// {{{ quote() |
/** |
* @deprecated Deprecated in release 1.6.0 |
* @internal |
*/ |
function quote($str) { |
return $this->quoteSmart($str); |
} |
// }}} |
// {{{ escapeSimple() |
/** |
* Escape a string according to the current DBMS's standards |
* |
* @param string $str the string to be escaped |
* |
* @return string the escaped string |
* |
* @internal |
*/ |
function escapeSimple($str) { |
if (function_exists('mysql_real_escape_string')) { |
return @mysql_real_escape_string($str, $this->connection); |
} else { |
return @mysql_escape_string($str); |
} |
} |
// }}} |
// {{{ modifyQuery() |
function modifyQuery($query) |
{ |
if ($this->options['portability'] & DB_PORTABILITY_DELETE_COUNT) { |
// "DELETE FROM table" gives 0 affected rows in MySQL. |
// This little hack lets you know how many rows were deleted. |
if (preg_match('/^\s*DELETE\s+FROM\s+(\S+)\s*$/i', $query)) { |
$query = preg_replace('/^\s*DELETE\s+FROM\s+(\S+)\s*$/', |
'DELETE FROM \1 WHERE 1=1', $query); |
} |
} |
return $query; |
} |
// }}} |
// {{{ modifyLimitQuery() |
function modifyLimitQuery($query, $from, $count, $params = array()) |
{ |
if (DB::isManip($query)) { |
return $query . " LIMIT $count"; |
} else { |
return $query . " LIMIT $from, $count"; |
} |
} |
// }}} |
// {{{ mysqlRaiseError() |
/** |
* Gather information about an error, then use that info to create a |
* DB error object and finally return that object. |
* |
* @param integer $errno PEAR error number (usually a DB constant) if |
* manually raising an error |
* @return object DB error object |
* @see DB_common::errorCode() |
* @see DB_common::raiseError() |
*/ |
function mysqlRaiseError($errno = null) |
{ |
if ($errno === null) { |
if ($this->options['portability'] & DB_PORTABILITY_ERRORS) { |
$this->errorcode_map[1022] = DB_ERROR_CONSTRAINT; |
$this->errorcode_map[1048] = DB_ERROR_CONSTRAINT_NOT_NULL; |
$this->errorcode_map[1062] = DB_ERROR_CONSTRAINT; |
} else { |
// Doing this in case mode changes during runtime. |
$this->errorcode_map[1022] = DB_ERROR_ALREADY_EXISTS; |
$this->errorcode_map[1048] = DB_ERROR_CONSTRAINT; |
$this->errorcode_map[1062] = DB_ERROR_ALREADY_EXISTS; |
} |
$errno = $this->errorCode(mysql_errno($this->connection)); |
} |
return $this->raiseError($errno, null, null, null, |
@mysql_errno($this->connection) . ' ** ' . |
@mysql_error($this->connection)); |
} |
// }}} |
// {{{ tableInfo() |
/** |
* Returns information about a table or a result set. |
* |
* @param object|string $result DB_result object from a query or a |
* string containing the name of a table |
* @param int $mode a valid tableInfo mode |
* @return array an associative array with the information requested |
* or an error object if something is wrong |
* @access public |
* @internal |
* @see DB_common::tableInfo() |
*/ |
function tableInfo($result, $mode = null) { |
if (isset($result->result)) { |
/* |
* Probably received a result object. |
* Extract the result resource identifier. |
*/ |
$id = $result->result; |
$got_string = false; |
} elseif (is_string($result)) { |
/* |
* Probably received a table name. |
* Create a result resource identifier. |
*/ |
$id = @mysql_list_fields($this->dsn['database'], |
$result, $this->connection); |
$got_string = true; |
} else { |
/* |
* Probably received a result resource identifier. |
* Copy it. |
* Deprecated. Here for compatibility only. |
*/ |
$id = $result; |
$got_string = false; |
} |
if (!is_resource($id)) { |
return $this->mysqlRaiseError(DB_ERROR_NEED_MORE_DATA); |
} |
if ($this->options['portability'] & DB_PORTABILITY_LOWERCASE) { |
$case_func = 'strtolower'; |
} else { |
$case_func = 'strval'; |
} |
$count = @mysql_num_fields($id); |
// made this IF due to performance (one if is faster than $count if's) |
if (!$mode) { |
for ($i=0; $i<$count; $i++) { |
$res[$i]['table'] = $case_func(@mysql_field_table($id, $i)); |
$res[$i]['name'] = $case_func(@mysql_field_name($id, $i)); |
$res[$i]['type'] = @mysql_field_type($id, $i); |
$res[$i]['len'] = @mysql_field_len($id, $i); |
$res[$i]['flags'] = @mysql_field_flags($id, $i); |
} |
} else { // full |
$res['num_fields']= $count; |
for ($i=0; $i<$count; $i++) { |
$res[$i]['table'] = $case_func(@mysql_field_table($id, $i)); |
$res[$i]['name'] = $case_func(@mysql_field_name($id, $i)); |
$res[$i]['type'] = @mysql_field_type($id, $i); |
$res[$i]['len'] = @mysql_field_len($id, $i); |
$res[$i]['flags'] = @mysql_field_flags($id, $i); |
if ($mode & DB_TABLEINFO_ORDER) { |
$res['order'][$res[$i]['name']] = $i; |
} |
if ($mode & DB_TABLEINFO_ORDERTABLE) { |
$res['ordertable'][$res[$i]['table']][$res[$i]['name']] = $i; |
} |
} |
} |
// free the result only if we were called on a table |
if ($got_string) { |
@mysql_free_result($id); |
} |
return $res; |
} |
// }}} |
// {{{ getSpecialQuery() |
/** |
* Returns the query needed to get some backend info |
* @param string $type What kind of info you want to retrieve |
* @return string The SQL query string |
*/ |
function getSpecialQuery($type) |
{ |
switch ($type) { |
case 'tables': |
return 'SHOW TABLES'; |
case 'views': |
return DB_ERROR_NOT_CAPABLE; |
case 'users': |
$sql = 'select distinct User from user'; |
if ($this->dsn['database'] != 'mysql') { |
$dsn = $this->dsn; |
$dsn['database'] = 'mysql'; |
if (DB::isError($db = DB::connect($dsn))) { |
return $db; |
} |
$sql = $db->getCol($sql); |
$db->disconnect(); |
// XXX Fixme the mysql driver should take care of this |
if (!@mysql_select_db($this->dsn['database'], $this->connection)) { |
return $this->mysqlRaiseError(DB_ERROR_NODBSELECTED); |
} |
} |
return $sql; |
case 'databases': |
return 'SHOW DATABASES'; |
default: |
return null; |
} |
} |
// }}} |
} |
/* |
* Local variables: |
* tab-width: 4 |
* c-basic-offset: 4 |
* End: |
*/ |
?> |
/trunk/applications/jrest/lib/zip.php |
---|
New file |
0,0 → 1,190 |
<?php |
/* vim: set expandtab sw=4 ts=4 sts=4: */ |
/** |
* |
* @version $Id: zip.lib.php 10240 2007-04-01 11:02:46Z cybot_tm $ |
*/ |
/** |
* Zip file creation class. |
* Makes zip files. |
* |
* Based on : |
* |
* http://www.zend.com/codex.php?id=535&single=1 |
* By Eric Mueller <eric@themepark.com> |
* |
* http://www.zend.com/codex.php?id=470&single=1 |
* by Denis125 <webmaster@atlant.ru> |
* |
* a patch from Peter Listiak <mlady@users.sourceforge.net> for last modified |
* date and time of the compressed file |
* |
* Official ZIP file format: http://www.pkware.com/appnote.txt |
* |
* @access public |
*/ |
class zipfile |
{ |
/** |
* Array to store compressed data |
* |
* @var array $datasec |
*/ |
var $datasec = array(); |
/** |
* Central directory |
* |
* @var array $ctrl_dir |
*/ |
var $ctrl_dir = array(); |
/** |
* End of central directory record |
* |
* @var string $eof_ctrl_dir |
*/ |
var $eof_ctrl_dir = "\x50\x4b\x05\x06\x00\x00\x00\x00"; |
/** |
* Last offset position |
* |
* @var integer $old_offset |
*/ |
var $old_offset = 0; |
/** |
* Converts an Unix timestamp to a four byte DOS date and time format (date |
* in high two bytes, time in low two bytes allowing magnitude comparison). |
* |
* @param integer the current Unix timestamp |
* |
* @return integer the current date in a four byte DOS format |
* |
* @access private |
*/ |
function unix2DosTime($unixtime = 0) { |
$timearray = ($unixtime == 0) ? getdate() : getdate($unixtime); |
if ($timearray['year'] < 1980) { |
$timearray['year'] = 1980; |
$timearray['mon'] = 1; |
$timearray['mday'] = 1; |
$timearray['hours'] = 0; |
$timearray['minutes'] = 0; |
$timearray['seconds'] = 0; |
} // end if |
return (($timearray['year'] - 1980) << 25) | ($timearray['mon'] << 21) | ($timearray['mday'] << 16) | |
($timearray['hours'] << 11) | ($timearray['minutes'] << 5) | ($timearray['seconds'] >> 1); |
} // end of the 'unix2DosTime()' method |
/** |
* Adds "file" to archive |
* |
* @param string file contents |
* @param string name of the file in the archive (may contains the path) |
* @param integer the current timestamp |
* |
* @access public |
*/ |
function addFile($data, $name, $time = 0) |
{ |
$name = str_replace('\\', '/', $name); |
$dtime = dechex($this->unix2DosTime($time)); |
$hexdtime = '\x' . $dtime[6] . $dtime[7] |
. '\x' . $dtime[4] . $dtime[5] |
. '\x' . $dtime[2] . $dtime[3] |
. '\x' . $dtime[0] . $dtime[1]; |
eval('$hexdtime = "' . $hexdtime . '";'); |
$fr = "\x50\x4b\x03\x04"; |
$fr .= "\x14\x00"; // ver needed to extract |
$fr .= "\x00\x00"; // gen purpose bit flag |
$fr .= "\x08\x00"; // compression method |
$fr .= $hexdtime; // last mod time and date |
// "local file header" segment |
$unc_len = strlen($data); |
$crc = crc32($data); |
$zdata = gzcompress($data); |
$zdata = substr(substr($zdata, 0, strlen($zdata) - 4), 2); // fix crc bug |
$c_len = strlen($zdata); |
$fr .= pack('V', $crc); // crc32 |
$fr .= pack('V', $c_len); // compressed filesize |
$fr .= pack('V', $unc_len); // uncompressed filesize |
$fr .= pack('v', strlen($name)); // length of filename |
$fr .= pack('v', 0); // extra field length |
$fr .= $name; |
// "file data" segment |
$fr .= $zdata; |
// "data descriptor" segment (optional but necessary if archive is not |
// served as file) |
// nijel(2004-10-19): this seems not to be needed at all and causes |
// problems in some cases (bug #1037737) |
//$fr .= pack('V', $crc); // crc32 |
//$fr .= pack('V', $c_len); // compressed filesize |
//$fr .= pack('V', $unc_len); // uncompressed filesize |
// add this entry to array |
$this -> datasec[] = $fr; |
// now add to central directory record |
$cdrec = "\x50\x4b\x01\x02"; |
$cdrec .= "\x00\x00"; // version made by |
$cdrec .= "\x14\x00"; // version needed to extract |
$cdrec .= "\x00\x00"; // gen purpose bit flag |
$cdrec .= "\x08\x00"; // compression method |
$cdrec .= $hexdtime; // last mod time & date |
$cdrec .= pack('V', $crc); // crc32 |
$cdrec .= pack('V', $c_len); // compressed filesize |
$cdrec .= pack('V', $unc_len); // uncompressed filesize |
$cdrec .= pack('v', strlen($name)); // length of filename |
$cdrec .= pack('v', 0); // extra field length |
$cdrec .= pack('v', 0); // file comment length |
$cdrec .= pack('v', 0); // disk number start |
$cdrec .= pack('v', 0); // internal file attributes |
$cdrec .= pack('V', 32); // external file attributes - 'archive' bit set |
$cdrec .= pack('V', $this -> old_offset); // relative offset of local header |
$this -> old_offset += strlen($fr); |
$cdrec .= $name; |
// optional extra field, file comment goes here |
// save to central directory |
$this -> ctrl_dir[] = $cdrec; |
} // end of the 'addFile()' method |
/** |
* Dumps out file |
* |
* @return string the zipped file |
* |
* @access public |
*/ |
function file() |
{ |
$data = implode('', $this -> datasec); |
$ctrldir = implode('', $this -> ctrl_dir); |
return |
$data . |
$ctrldir . |
$this -> eof_ctrl_dir . |
pack('v', sizeof($this -> ctrl_dir)) . // total # of entries "on this disk" |
pack('v', sizeof($this -> ctrl_dir)) . // total # of entries overall |
pack('V', strlen($ctrldir)) . // size of central dir |
pack('V', strlen($data)) . // offset to start of central dir |
"\x00\x00"; // .zip file comment length |
} // end of the 'file()' method |
} // end of the 'zipfile' class |
?> |
/trunk/applications/jrest/lib/DBAccessor.php |
---|
New file |
0,0 → 1,34 |
<?php |
require_once 'JrestService.php'; |
class DBAccessor extends JrestService { |
public function connectDB($config, $base = 'database') { |
require_once 'DB.php'; |
$dsn = $config[$base]; |
$DB =& DB::connect($dsn); |
if (DB::isError($DB)) { |
die($DB->getMessage()); |
} |
$DB->query("SET NAMES 'utf8'"); |
return $DB; |
} |
public function connecterPDO($config, $base = 'database') { |
$cfg = $config[$base]; |
$dsn = $cfg['phptype'].':dbname='.$cfg['database'].';host='.$cfg['hostspec']; |
try { |
$PDO = new PDO($dsn, $cfg['username'], $cfg['password']); |
} catch (PDOException $e) { |
echo 'La connexion à la base de donnée via PDO a échouée : ' . $e->getMessage(); |
} |
// Passe en UTF-8 la connexion à la BDD |
$PDO->exec("SET NAMES 'utf8'"); |
// Affiche les erreurs détectées par PDO (sinon mode silencieux => aucune erreur affiché) |
$PDO->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); |
return $PDO; |
} |
} |
?> |
/trunk/applications/jrest/lib/JrestService.php |
---|
New file |
0,0 → 1,128 |
<?php |
/** |
* PHP Version 5 |
* |
* @category PHP |
* @package jrest |
* @author aurelien <aurelien@tela-botanica.org> |
* @copyright 2009 Tela-Botanica |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @version $$id$$ |
* @link /doc/jrest/ |
*/ |
class JrestService { |
protected $config; |
protected $script_time; |
protected $max_exec_time; |
public function JrestService($config) { |
$this->config = config; |
$this->script_time = microtime(true); |
$this->max_exec_time = ini_get('max_execution_time'); |
} |
public function isAdmin($id) { |
$admins = $this->config['jrest_admin']['admin']; |
$admin_tab = split(',',$admins); |
if (in_array($id,$admin_tab)) { |
return true; |
} else { |
return false; |
} |
} |
public function controleUtilisateur($id) { |
if ($_SESSION['user']['name'] == '') { |
//cas de la session temporaire, on ne fait rien de particulier |
} else { |
if (!$this->isAdmin($_SESSION['user']['name']) && $_SESSION['user']['name'] != $id) { |
// cas d'usurpation d'identité |
print 'Accès interdit'; |
exit(); |
} |
} |
} |
public function logger($index,$chaine) { |
if(!class_exists('Log')) { |
include_once('Log.php'); |
Log::getInstance(); |
} |
Log::setCheminLog($this->config['log']['cheminlog']); |
Log::setTimeZone($this->config['log']['timezone']); |
Log::setTailleMax($this->config['log']['taillemax']); |
Log::ajouterEntree($index,$chaine); |
} |
public function verifierOuRelancerExecution() { |
if((microtime(true) - $this->script_time) > ($this->max_exec_time - 5)*100) { |
set_time_limit(2); |
$this->logger('JRestService','Durée du script augmentée :'.microtime(true).' - '.$this->script_time.'.) > ('.$this->max_exec_time.' - 5)*1000000'); |
return true; |
} |
return false; |
} |
/** |
* Méthode prenant en paramètre un chemin de fichier squelette et un tableau associatif de données, |
* en extrait les variables, charge le squelette et retourne le résultat des deux combinés. |
* |
* @param String $fichier le chemin du fichier du squelette |
* @param Array $donnees un tableau associatif contenant les variables a injecter dans le squelette. |
* |
* @return boolean false si le squelette n'existe pas, sinon la chaine résultat. |
*/ |
public static function traiterSquelettePhp($fichier, Array $donnees = array()) { |
$sortie = false; |
if (file_exists($fichier)) { |
// Extraction des variables du tableau de données |
extract($donnees); |
// Démarage de la bufferisation de sortie |
ob_start(); |
// Si les tags courts sont activés |
if ((bool) @ini_get('short_open_tag') === true) { |
// Simple inclusion du squelette |
include $fichier; |
} else { |
// Sinon, remplacement des tags courts par la syntaxe classique avec echo |
$html_et_code_php = self::traiterTagsCourts($fichier); |
// Pour évaluer du php mélangé dans du html il est nécessaire de fermer la balise php ouverte par eval |
$html_et_code_php = '?>'.$html_et_code_php; |
// Interprétation du html et du php dans le buffer |
echo eval($html_et_code_php); |
} |
// Récupèration du contenu du buffer |
$sortie = ob_get_contents(); |
// Suppression du buffer |
@ob_end_clean(); |
} else { |
$msg = "Le fichier du squelette '$fichier' n'existe pas."; |
trigger_error($msg, E_USER_WARNING); |
} |
// Retourne le contenu |
return $sortie; |
} |
/** |
* Fonction chargeant le contenu du squelette et remplaçant les tags court php (<?= ...) par un tag long avec echo. |
* |
* @param String $chemin_squelette le chemin du fichier du squelette |
* |
* @return string le contenu du fichier du squelette php avec les tags courts remplacés. |
*/ |
private static function traiterTagsCourts($chemin_squelette) { |
$contenu = file_get_contents($chemin_squelette); |
// Remplacement de tags courts par un tag long avec echo |
$contenu = str_replace('<?=', '<?php echo ', $contenu); |
// Ajout systématique d'un point virgule avant la fermeture php |
$contenu = preg_replace("/;*\s*\?>/", "; ?>", $contenu); |
return $contenu; |
} |
} |
?> |
/trunk/applications/jrest/lib/JSON.php |
---|
New file |
0,0 → 1,806 |
<?php |
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */ |
/** |
* Converts to and from JSON format. |
* |
* JSON (JavaScript Object Notation) is a lightweight data-interchange |
* format. It is easy for humans to read and write. It is easy for machines |
* to parse and generate. It is based on a subset of the JavaScript |
* Programming Language, Standard ECMA-262 3rd Edition - December 1999. |
* This feature can also be found in Python. JSON is a text format that is |
* completely language independent but uses conventions that are familiar |
* to programmers of the C-family of languages, including C, C++, C#, Java, |
* JavaScript, Perl, TCL, and many others. These properties make JSON an |
* ideal data-interchange language. |
* |
* This package provides a simple encoder and decoder for JSON notation. It |
* is intended for use with client-side Javascript applications that make |
* use of HTTPRequest to perform server communication functions - data can |
* be encoded into JSON notation for use in a client-side javascript, or |
* decoded from incoming Javascript requests. JSON format is native to |
* Javascript, and can be directly eval()'ed with no further parsing |
* overhead |
* |
* All strings should be in ASCII or UTF-8 format! |
* |
* LICENSE: Redistribution and use in source and binary forms, with or |
* without modification, are permitted provided that the following |
* conditions are met: Redistributions of source code must retain the |
* above copyright notice, this list of conditions and the following |
* disclaimer. Redistributions in binary form must reproduce the above |
* copyright notice, this list of conditions and the following disclaimer |
* in the documentation and/or other materials provided with the |
* distribution. |
* |
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED |
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN |
* NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR |
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE |
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH |
* DAMAGE. |
* |
* @category |
* @package Services_JSON |
* @author Michal Migurski <mike-json@teczno.com> |
* @author Matt Knapp <mdknapp[at]gmail[dot]com> |
* @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com> |
* @copyright 2005 Michal Migurski |
* @version CVS: $Id$ |
* @license http://www.opensource.org/licenses/bsd-license.php |
* @link http://pear.php.net/pepr/pepr-proposal-show.php?id=198 |
*/ |
/** |
* Marker constant for Services_JSON::decode(), used to flag stack state |
*/ |
define('SERVICES_JSON_SLICE', 1); |
/** |
* Marker constant for Services_JSON::decode(), used to flag stack state |
*/ |
define('SERVICES_JSON_IN_STR', 2); |
/** |
* Marker constant for Services_JSON::decode(), used to flag stack state |
*/ |
define('SERVICES_JSON_IN_ARR', 3); |
/** |
* Marker constant for Services_JSON::decode(), used to flag stack state |
*/ |
define('SERVICES_JSON_IN_OBJ', 4); |
/** |
* Marker constant for Services_JSON::decode(), used to flag stack state |
*/ |
define('SERVICES_JSON_IN_CMT', 5); |
/** |
* Behavior switch for Services_JSON::decode() |
*/ |
define('SERVICES_JSON_LOOSE_TYPE', 16); |
/** |
* Behavior switch for Services_JSON::decode() |
*/ |
define('SERVICES_JSON_SUPPRESS_ERRORS', 32); |
/** |
* Converts to and from JSON format. |
* |
* Brief example of use: |
* |
* <code> |
* // create a new instance of Services_JSON |
* $json = new Services_JSON(); |
* |
* // convert a complexe value to JSON notation, and send it to the browser |
* $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4))); |
* $output = $json->encode($value); |
* |
* print($output); |
* // prints: ["foo","bar",[1,2,"baz"],[3,[4]]] |
* |
* // accept incoming POST data, assumed to be in JSON notation |
* $input = file_get_contents('php://input', 1000000); |
* $value = $json->decode($input); |
* </code> |
*/ |
class Services_JSON |
{ |
/** |
* constructs a new JSON instance |
* |
* @param int $use object behavior flags; combine with boolean-OR |
* |
* possible values: |
* - SERVICES_JSON_LOOSE_TYPE: loose typing. |
* "{...}" syntax creates associative arrays |
* instead of objects in decode(). |
* - SERVICES_JSON_SUPPRESS_ERRORS: error suppression. |
* Values which can't be encoded (e.g. resources) |
* appear as NULL instead of throwing errors. |
* By default, a deeply-nested resource will |
* bubble up with an error, so all return values |
* from encode() should be checked with isError() |
*/ |
function Services_JSON($use = 0) |
{ |
$this->use = $use; |
} |
/** |
* convert a string from one UTF-16 char to one UTF-8 char |
* |
* Normally should be handled by mb_convert_encoding, but |
* provides a slower PHP-only method for installations |
* that lack the multibye string extension. |
* |
* @param string $utf16 UTF-16 character |
* @return string UTF-8 character |
* @access private |
*/ |
function utf162utf8($utf16) |
{ |
// oh please oh please oh please oh please oh please |
if(function_exists('mb_convert_encoding')) { |
return mb_convert_encoding($utf16, 'UTF-8', 'UTF-16'); |
} |
$bytes = (ord($utf16{0}) << 8) | ord($utf16{1}); |
switch(true) { |
case ((0x7F & $bytes) == $bytes): |
// this case should never be reached, because we are in ASCII range |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return chr(0x7F & $bytes); |
case (0x07FF & $bytes) == $bytes: |
// return a 2-byte UTF-8 character |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return chr(0xC0 | (($bytes >> 6) & 0x1F)) |
. chr(0x80 | ($bytes & 0x3F)); |
case (0xFFFF & $bytes) == $bytes: |
// return a 3-byte UTF-8 character |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return chr(0xE0 | (($bytes >> 12) & 0x0F)) |
. chr(0x80 | (($bytes >> 6) & 0x3F)) |
. chr(0x80 | ($bytes & 0x3F)); |
} |
// ignoring UTF-32 for now, sorry |
return ''; |
} |
/** |
* convert a string from one UTF-8 char to one UTF-16 char |
* |
* Normally should be handled by mb_convert_encoding, but |
* provides a slower PHP-only method for installations |
* that lack the multibye string extension. |
* |
* @param string $utf8 UTF-8 character |
* @return string UTF-16 character |
* @access private |
*/ |
function utf82utf16($utf8) |
{ |
// oh please oh please oh please oh please oh please |
if(function_exists('mb_convert_encoding')) { |
return mb_convert_encoding($utf8, 'UTF-16', 'UTF-8'); |
} |
switch(strlen($utf8)) { |
case 1: |
// this case should never be reached, because we are in ASCII range |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return $utf8; |
case 2: |
// return a UTF-16 character from a 2-byte UTF-8 char |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return chr(0x07 & (ord($utf8{0}) >> 2)) |
. chr((0xC0 & (ord($utf8{0}) << 6)) |
| (0x3F & ord($utf8{1}))); |
case 3: |
// return a UTF-16 character from a 3-byte UTF-8 char |
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
return chr((0xF0 & (ord($utf8{0}) << 4)) |
| (0x0F & (ord($utf8{1}) >> 2))) |
. chr((0xC0 & (ord($utf8{1}) << 6)) |
| (0x7F & ord($utf8{2}))); |
} |
// ignoring UTF-32 for now, sorry |
return ''; |
} |
/** |
* encodes an arbitrary variable into JSON format |
* |
* @param mixed $var any number, boolean, string, array, or object to be encoded. |
* see argument 1 to Services_JSON() above for array-parsing behavior. |
* if var is a strng, note that encode() always expects it |
* to be in ASCII or UTF-8 format! |
* |
* @return mixed JSON string representation of input var or an error if a problem occurs |
* @access public |
*/ |
function encode($var) |
{ |
switch (gettype($var)) { |
case 'boolean': |
return $var ? 'true' : 'false'; |
case 'NULL': |
return 'null'; |
case 'integer': |
return (int) $var; |
case 'double': |
case 'float': |
return (float) $var; |
case 'string': |
// STRINGS ARE EXPECTED TO BE IN ASCII OR UTF-8 FORMAT |
$ascii = ''; |
$strlen_var = strlen($var); |
/* |
* Iterate over every character in the string, |
* escaping with a slash or encoding to UTF-8 where necessary |
*/ |
for ($c = 0; $c < $strlen_var; ++$c) { |
$ord_var_c = ord($var{$c}); |
switch (true) { |
case $ord_var_c == 0x08: |
$ascii .= '\b'; |
break; |
case $ord_var_c == 0x09: |
$ascii .= '\t'; |
break; |
case $ord_var_c == 0x0A: |
$ascii .= '\n'; |
break; |
case $ord_var_c == 0x0C: |
$ascii .= '\f'; |
break; |
case $ord_var_c == 0x0D: |
$ascii .= '\r'; |
break; |
case $ord_var_c == 0x22: |
case $ord_var_c == 0x2F: |
case $ord_var_c == 0x5C: |
// double quote, slash, slosh |
$ascii .= '\\'.$var{$c}; |
break; |
case (($ord_var_c >= 0x20) && ($ord_var_c <= 0x7F)): |
// characters U-00000000 - U-0000007F (same as ASCII) |
$ascii .= $var{$c}; |
break; |
case (($ord_var_c & 0xE0) == 0xC0): |
// characters U-00000080 - U-000007FF, mask 110XXXXX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$char = pack('C*', $ord_var_c, ord($var{$c + 1})); |
$c += 1; |
$utf16 = $this->utf82utf16($char); |
$ascii .= sprintf('\u%04s', bin2hex($utf16)); |
break; |
case (($ord_var_c & 0xF0) == 0xE0): |
// characters U-00000800 - U-0000FFFF, mask 1110XXXX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$char = pack('C*', $ord_var_c, |
ord($var{$c + 1}), |
ord($var{$c + 2})); |
$c += 2; |
$utf16 = $this->utf82utf16($char); |
$ascii .= sprintf('\u%04s', bin2hex($utf16)); |
break; |
case (($ord_var_c & 0xF8) == 0xF0): |
// characters U-00010000 - U-001FFFFF, mask 11110XXX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$char = pack('C*', $ord_var_c, |
ord($var{$c + 1}), |
ord($var{$c + 2}), |
ord($var{$c + 3})); |
$c += 3; |
$utf16 = $this->utf82utf16($char); |
$ascii .= sprintf('\u%04s', bin2hex($utf16)); |
break; |
case (($ord_var_c & 0xFC) == 0xF8): |
// characters U-00200000 - U-03FFFFFF, mask 111110XX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$char = pack('C*', $ord_var_c, |
ord($var{$c + 1}), |
ord($var{$c + 2}), |
ord($var{$c + 3}), |
ord($var{$c + 4})); |
$c += 4; |
$utf16 = $this->utf82utf16($char); |
$ascii .= sprintf('\u%04s', bin2hex($utf16)); |
break; |
case (($ord_var_c & 0xFE) == 0xFC): |
// characters U-04000000 - U-7FFFFFFF, mask 1111110X |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$char = pack('C*', $ord_var_c, |
ord($var{$c + 1}), |
ord($var{$c + 2}), |
ord($var{$c + 3}), |
ord($var{$c + 4}), |
ord($var{$c + 5})); |
$c += 5; |
$utf16 = $this->utf82utf16($char); |
$ascii .= sprintf('\u%04s', bin2hex($utf16)); |
break; |
} |
} |
return '"'.$ascii.'"'; |
case 'array': |
/* |
* As per JSON spec if any array key is not an integer |
* we must treat the the whole array as an object. We |
* also try to catch a sparsely populated associative |
* array with numeric keys here because some JS engines |
* will create an array with empty indexes up to |
* max_index which can cause memory issues and because |
* the keys, which may be relevant, will be remapped |
* otherwise. |
* |
* As per the ECMA and JSON specification an object may |
* have any string as a property. Unfortunately due to |
* a hole in the ECMA specification if the key is a |
* ECMA reserved word or starts with a digit the |
* parameter is only accessible using ECMAScript's |
* bracket notation. |
*/ |
// treat as a JSON object |
if (is_array($var) && count($var) && (array_keys($var) !== range(0, sizeof($var) - 1))) { |
$properties = array_map(array($this, 'name_value'), |
array_keys($var), |
array_values($var)); |
foreach($properties as $property) { |
if(Services_JSON::isError($property)) { |
return $property; |
} |
} |
return '{' . join(',', $properties) . '}'; |
} |
// treat it like a regular array |
$elements = array_map(array($this, 'encode'), $var); |
foreach($elements as $element) { |
if(Services_JSON::isError($element)) { |
return $element; |
} |
} |
return '[' . join(',', $elements) . ']'; |
case 'object': |
$vars = get_object_vars($var); |
$properties = array_map(array($this, 'name_value'), |
array_keys($vars), |
array_values($vars)); |
foreach($properties as $property) { |
if(Services_JSON::isError($property)) { |
return $property; |
} |
} |
return '{' . join(',', $properties) . '}'; |
default: |
return ($this->use & SERVICES_JSON_SUPPRESS_ERRORS) |
? 'null' |
: new Services_JSON_Error(gettype($var)." can not be encoded as JSON string"); |
} |
} |
/** |
* array-walking function for use in generating JSON-formatted name-value pairs |
* |
* @param string $name name of key to use |
* @param mixed $value reference to an array element to be encoded |
* |
* @return string JSON-formatted name-value pair, like '"name":value' |
* @access private |
*/ |
function name_value($name, $value) |
{ |
$encoded_value = $this->encode($value); |
if(Services_JSON::isError($encoded_value)) { |
return $encoded_value; |
} |
return $this->encode(strval($name)) . ':' . $encoded_value; |
} |
/** |
* reduce a string by removing leading and trailing comments and whitespace |
* |
* @param $str string string value to strip of comments and whitespace |
* |
* @return string string value stripped of comments and whitespace |
* @access private |
*/ |
function reduce_string($str) |
{ |
$str = preg_replace(array( |
// eliminate single line comments in '// ...' form |
'#^\s*//(.+)$#m', |
// eliminate multi-line comments in '/* ... */' form, at start of string |
'#^\s*/\*(.+)\*/#Us', |
// eliminate multi-line comments in '/* ... */' form, at end of string |
'#/\*(.+)\*/\s*$#Us' |
), '', $str); |
// eliminate extraneous space |
return trim($str); |
} |
/** |
* decodes a JSON string into appropriate variable |
* |
* @param string $str JSON-formatted string |
* |
* @return mixed number, boolean, string, array, or object |
* corresponding to given JSON input string. |
* See argument 1 to Services_JSON() above for object-output behavior. |
* Note that decode() always returns strings |
* in ASCII or UTF-8 format! |
* @access public |
*/ |
function decode($str) |
{ |
$str = $this->reduce_string($str); |
switch (strtolower($str)) { |
case 'true': |
return true; |
case 'false': |
return false; |
case 'null': |
return null; |
default: |
$m = array(); |
if (is_numeric($str)) { |
// Lookie-loo, it's a number |
// This would work on its own, but I'm trying to be |
// good about returning integers where appropriate: |
// return (float)$str; |
// Return float or int, as appropriate |
return ((float)$str == (integer)$str) |
? (integer)$str |
: (float)$str; |
} elseif (preg_match('/^("|\').*(\1)$/s', $str, $m) && $m[1] == $m[2]) { |
// STRINGS RETURNED IN UTF-8 FORMAT |
$delim = substr($str, 0, 1); |
$chrs = substr($str, 1, -1); |
$utf8 = ''; |
$strlen_chrs = strlen($chrs); |
for ($c = 0; $c < $strlen_chrs; ++$c) { |
$substr_chrs_c_2 = substr($chrs, $c, 2); |
$ord_chrs_c = ord($chrs{$c}); |
switch (true) { |
case $substr_chrs_c_2 == '\b': |
$utf8 .= chr(0x08); |
++$c; |
break; |
case $substr_chrs_c_2 == '\t': |
$utf8 .= chr(0x09); |
++$c; |
break; |
case $substr_chrs_c_2 == '\n': |
$utf8 .= chr(0x0A); |
++$c; |
break; |
case $substr_chrs_c_2 == '\f': |
$utf8 .= chr(0x0C); |
++$c; |
break; |
case $substr_chrs_c_2 == '\r': |
$utf8 .= chr(0x0D); |
++$c; |
break; |
case $substr_chrs_c_2 == '\\"': |
case $substr_chrs_c_2 == '\\\'': |
case $substr_chrs_c_2 == '\\\\': |
case $substr_chrs_c_2 == '\\/': |
if (($delim == '"' && $substr_chrs_c_2 != '\\\'') || |
($delim == "'" && $substr_chrs_c_2 != '\\"')) { |
$utf8 .= $chrs{++$c}; |
} |
break; |
case preg_match('/\\\u[0-9A-F]{4}/i', substr($chrs, $c, 6)): |
// single, escaped unicode character |
$utf16 = chr(hexdec(substr($chrs, ($c + 2), 2))) |
. chr(hexdec(substr($chrs, ($c + 4), 2))); |
$utf8 .= $this->utf162utf8($utf16); |
$c += 5; |
break; |
case ($ord_chrs_c >= 0x20) && ($ord_chrs_c <= 0x7F): |
$utf8 .= $chrs{$c}; |
break; |
case ($ord_chrs_c & 0xE0) == 0xC0: |
// characters U-00000080 - U-000007FF, mask 110XXXXX |
//see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$utf8 .= substr($chrs, $c, 2); |
++$c; |
break; |
case ($ord_chrs_c & 0xF0) == 0xE0: |
// characters U-00000800 - U-0000FFFF, mask 1110XXXX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$utf8 .= substr($chrs, $c, 3); |
$c += 2; |
break; |
case ($ord_chrs_c & 0xF8) == 0xF0: |
// characters U-00010000 - U-001FFFFF, mask 11110XXX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$utf8 .= substr($chrs, $c, 4); |
$c += 3; |
break; |
case ($ord_chrs_c & 0xFC) == 0xF8: |
// characters U-00200000 - U-03FFFFFF, mask 111110XX |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$utf8 .= substr($chrs, $c, 5); |
$c += 4; |
break; |
case ($ord_chrs_c & 0xFE) == 0xFC: |
// characters U-04000000 - U-7FFFFFFF, mask 1111110X |
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8 |
$utf8 .= substr($chrs, $c, 6); |
$c += 5; |
break; |
} |
} |
return $utf8; |
} elseif (preg_match('/^\[.*\]$/s', $str) || preg_match('/^\{.*\}$/s', $str)) { |
// array, or object notation |
if ($str{0} == '[') { |
$stk = array(SERVICES_JSON_IN_ARR); |
$arr = array(); |
} else { |
if ($this->use & SERVICES_JSON_LOOSE_TYPE) { |
$stk = array(SERVICES_JSON_IN_OBJ); |
$obj = array(); |
} else { |
$stk = array(SERVICES_JSON_IN_OBJ); |
$obj = new stdClass(); |
} |
} |
array_push($stk, array('what' => SERVICES_JSON_SLICE, |
'where' => 0, |
'delim' => false)); |
$chrs = substr($str, 1, -1); |
$chrs = $this->reduce_string($chrs); |
if ($chrs == '') { |
if (reset($stk) == SERVICES_JSON_IN_ARR) { |
return $arr; |
} else { |
return $obj; |
} |
} |
//print("\nparsing {$chrs}\n"); |
$strlen_chrs = strlen($chrs); |
for ($c = 0; $c <= $strlen_chrs; ++$c) { |
$top = end($stk); |
$substr_chrs_c_2 = substr($chrs, $c, 2); |
if (($c == $strlen_chrs) || (($chrs{$c} == ',') && ($top['what'] == SERVICES_JSON_SLICE))) { |
// found a comma that is not inside a string, array, etc., |
// OR we've reached the end of the character list |
$slice = substr($chrs, $top['where'], ($c - $top['where'])); |
array_push($stk, array('what' => SERVICES_JSON_SLICE, 'where' => ($c + 1), 'delim' => false)); |
//print("Found split at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); |
if (reset($stk) == SERVICES_JSON_IN_ARR) { |
// we are in an array, so just push an element onto the stack |
array_push($arr, $this->decode($slice)); |
} elseif (reset($stk) == SERVICES_JSON_IN_OBJ) { |
// we are in an object, so figure |
// out the property name and set an |
// element in an associative array, |
// for now |
$parts = array(); |
if (preg_match('/^\s*(["\'].*[^\\\]["\'])\s*:\s*(\S.*),?$/Uis', $slice, $parts)) { |
// "name":value pair |
$key = $this->decode($parts[1]); |
$val = $this->decode($parts[2]); |
if ($this->use & SERVICES_JSON_LOOSE_TYPE) { |
$obj[$key] = $val; |
} else { |
$obj->$key = $val; |
} |
} elseif (preg_match('/^\s*(\w+)\s*:\s*(\S.*),?$/Uis', $slice, $parts)) { |
// name:value pair, where name is unquoted |
$key = $parts[1]; |
$val = $this->decode($parts[2]); |
if ($this->use & SERVICES_JSON_LOOSE_TYPE) { |
$obj[$key] = $val; |
} else { |
$obj->$key = $val; |
} |
} |
} |
} elseif ((($chrs{$c} == '"') || ($chrs{$c} == "'")) && ($top['what'] != SERVICES_JSON_IN_STR)) { |
// found a quote, and we are not inside a string |
array_push($stk, array('what' => SERVICES_JSON_IN_STR, 'where' => $c, 'delim' => $chrs{$c})); |
//print("Found start of string at {$c}\n"); |
} elseif (($chrs{$c} == $top['delim']) && |
($top['what'] == SERVICES_JSON_IN_STR) && |
((strlen(substr($chrs, 0, $c)) - strlen(rtrim(substr($chrs, 0, $c), '\\'))) % 2 != 1)) { |
// found a quote, we're in a string, and it's not escaped |
// we know that it's not escaped becase there is _not_ an |
// odd number of backslashes at the end of the string so far |
array_pop($stk); |
//print("Found end of string at {$c}: ".substr($chrs, $top['where'], (1 + 1 + $c - $top['where']))."\n"); |
} elseif (($chrs{$c} == '[') && |
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) { |
// found a left-bracket, and we are in an array, object, or slice |
array_push($stk, array('what' => SERVICES_JSON_IN_ARR, 'where' => $c, 'delim' => false)); |
//print("Found start of array at {$c}\n"); |
} elseif (($chrs{$c} == ']') && ($top['what'] == SERVICES_JSON_IN_ARR)) { |
// found a right-bracket, and we're in an array |
array_pop($stk); |
//print("Found end of array at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); |
} elseif (($chrs{$c} == '{') && |
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) { |
// found a left-brace, and we are in an array, object, or slice |
array_push($stk, array('what' => SERVICES_JSON_IN_OBJ, 'where' => $c, 'delim' => false)); |
//print("Found start of object at {$c}\n"); |
} elseif (($chrs{$c} == '}') && ($top['what'] == SERVICES_JSON_IN_OBJ)) { |
// found a right-brace, and we're in an object |
array_pop($stk); |
//print("Found end of object at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); |
} elseif (($substr_chrs_c_2 == '/*') && |
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) { |
// found a comment start, and we are in an array, object, or slice |
array_push($stk, array('what' => SERVICES_JSON_IN_CMT, 'where' => $c, 'delim' => false)); |
$c++; |
//print("Found start of comment at {$c}\n"); |
} elseif (($substr_chrs_c_2 == '*/') && ($top['what'] == SERVICES_JSON_IN_CMT)) { |
// found a comment end, and we're in one now |
array_pop($stk); |
$c++; |
for ($i = $top['where']; $i <= $c; ++$i) |
$chrs = substr_replace($chrs, ' ', $i, 1); |
//print("Found end of comment at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n"); |
} |
} |
if (reset($stk) == SERVICES_JSON_IN_ARR) { |
return $arr; |
} elseif (reset($stk) == SERVICES_JSON_IN_OBJ) { |
return $obj; |
} |
} |
} |
} |
/** |
* @todo Ultimately, this should just call PEAR::isError() |
*/ |
function isError($data, $code = null) |
{ |
if (class_exists('pear')) { |
return PEAR::isError($data, $code); |
} elseif (is_object($data) && (get_class($data) == 'services_json_error' || |
is_subclass_of($data, 'services_json_error'))) { |
return true; |
} |
return false; |
} |
} |
if (class_exists('PEAR_Error')) { |
class Services_JSON_Error extends PEAR_Error |
{ |
function Services_JSON_Error($message = 'unknown error', $code = null, |
$mode = null, $options = null, $userinfo = null) |
{ |
parent::PEAR_Error($message, $code, $mode, $options, $userinfo); |
} |
} |
} else { |
/** |
* @todo Ultimately, this class shall be descended from PEAR_Error |
*/ |
class Services_JSON_Error |
{ |
function Services_JSON_Error($message = 'unknown error', $code = null, |
$mode = null, $options = null, $userinfo = null) |
{ |
} |
} |
} |
?> |
/trunk/applications/jrest/lib/PDF.php |
---|
New file |
0,0 → 1,3001 |
<?php |
/** |
* File_PDF:: |
* |
* The File_PDF:: class provides a PHP-only implementation of a PDF library. |
* No external libs or PHP extensions are required. |
* |
* Based on the FPDF class by Olivier Plathey (http://www.fpdf.org). |
* |
* Copyright 2001-2003 Olivier Plathey <olivier@fpdf.org> |
* Copyright 2003-2007 The Horde Project (http://www.horde.org/) |
* |
* See the enclosed file COPYING for license information (LGPL). If you |
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html. |
* |
* $Horde: framework/File_PDF/PDF.php,v 1.48 2007/01/05 13:12:21 jan Exp $ |
* |
* @author Olivier Plathey <olivier@fpdf.org> |
* @author Marko Djukic <marko@oblo.com> |
* @author Jan Schneider <jan@horde.org> |
* @package File_PDF |
* @category Fileformats |
*/ |
class File_PDF { |
/** |
* Current page number. |
* |
* @var integer |
*/ |
var $_page = 0; |
/** |
* Current object number. |
* |
* @var integer |
*/ |
var $_n = 2; |
/** |
* Array of object offsets. |
* |
* @var array |
*/ |
var $_offsets = array(); |
/** |
* Buffer holding in-memory PDF. |
* |
* @var string |
*/ |
var $_buffer = ''; |
/** |
* Array containing the pages. |
* |
* @var array |
*/ |
var $_pages = array(); |
/** |
* Current document state. |
* 0 - initial state |
* 1 - document opened |
* 2 - page opened |
* 3 - document closed |
* |
* @var integer |
*/ |
var $_state = 0; |
/** |
* Flag indicating if PDF file is to be compressed or not. |
* |
* @var boolean |
*/ |
var $_compress; |
/** |
* The default page orientation. |
* |
* @var string |
*/ |
var $_default_orientation; |
/** |
* The current page orientation. |
* |
* @var string |
*/ |
var $_current_orientation; |
/** |
* Array indicating orientation changes. |
* |
* @var array |
*/ |
var $_orientation_changes = array(); |
/** |
* Current width of page format in points. |
* |
* @var float |
*/ |
var $fwPt; |
/** |
* Current height of page format in points. |
* |
* @var float |
*/ |
var $fhPt; |
/** |
* Current width of page format in user units. |
* |
* @var float |
*/ |
var $fw; |
/** |
* Current height of page format in user units. |
* |
* @var float |
*/ |
var $fh; |
/** |
* Current width of page in points. |
* |
* @var float |
*/ |
var $wPt; |
/** |
* Current height of page in points. |
* |
* @var float |
*/ |
var $hPt; |
/** |
* Current width of page in user units |
* |
* @var float |
*/ |
var $w; |
/** |
* Current height of page in user units |
* |
* @var float |
*/ |
var $h; |
/** |
* Scale factor (number of points in user units). |
* |
* @var float |
*/ |
var $_scale; |
/** |
* Left page margin size. |
* |
* @var float |
*/ |
var $_left_margin; |
/** |
* Top page margin size. |
* |
* @var float |
*/ |
var $_top_margin; |
/** |
* Right page margin size. |
* |
* @var float |
*/ |
var $_right_margin; |
/** |
* Break page margin size, the bottom margin which triggers a page break. |
* |
* @var float |
*/ |
var $_break_margin; |
/** |
* Cell margin size. |
* |
* @var float |
*/ |
var $_cell_margin; |
/** |
* The current horizontal position for cell positioning. |
* Value is set in user units and is calculated from the top left corner |
* as origin. |
* |
* @var float |
*/ |
var $x; |
/** |
* The current vertical position for cell positioning. |
* Value is set in user units and is calculated from the top left corner |
* as origin. |
* |
* @var float |
*/ |
var $y; |
/** |
* The height of the last cell printed. |
* |
* @var float |
*/ |
var $_last_height; |
/** |
* Line width in user units. |
* |
* @var float |
*/ |
var $_line_width; |
/** |
* An array of standard font names. |
* |
* @var array |
*/ |
var $_core_fonts = array('courier' => 'Courier', |
'courierB' => 'Courier-Bold', |
'courierI' => 'Courier-Oblique', |
'courierBI' => 'Courier-BoldOblique', |
'helvetica' => 'Helvetica', |
'helveticaB' => 'Helvetica-Bold', |
'helveticaI' => 'Helvetica-Oblique', |
'helveticaBI' => 'Helvetica-BoldOblique', |
'times' => 'Times-Roman', |
'timesB' => 'Times-Bold', |
'timesI' => 'Times-Italic', |
'timesBI' => 'Times-BoldItalic', |
'symbol' => 'Symbol', |
'zapfdingbats' => 'ZapfDingbats'); |
/** |
* An array of used fonts. |
* |
* @var array |
*/ |
var $_fonts = array(); |
/** |
* An array of font files. |
* |
* @var array |
*/ |
var $_font_files = array(); |
/** |
* An array of encoding differences. |
* |
* @var array |
*/ |
var $_diffs = array(); |
/** |
* An array of used images. |
* |
* @var array |
*/ |
var $_images = array(); |
/** |
* An array of links in pages. |
* |
* @var array |
*/ |
var $_page_links; |
/** |
* An array of internal links. |
* |
* @var array |
*/ |
var $_links = array(); |
/** |
* Current font family. |
* |
* @var string |
*/ |
var $_font_family = ''; |
/** |
* Current font style. |
* |
* @var string |
*/ |
var $_font_style = ''; |
/** |
* Underlining flag. |
* |
* @var boolean |
*/ |
var $_underline = false; |
/** |
* An array containing current font info. |
* |
* @var array |
*/ |
var $_current_font; |
/** |
* Current font size in points. |
* |
* @var float |
*/ |
var $_font_size_pt = 12; |
/** |
* Current font size in user units. |
* |
* @var float |
*/ |
var $_font_size; |
/** |
* Commands for filling color. |
* |
* @var string |
*/ |
var $_fill_color = '0 g'; |
/** |
* Commands for text color. |
* |
* @var string |
*/ |
var $_text_color = '0 g'; |
/** |
* Whether text color is different from fill color. |
* |
* @var boolean |
*/ |
var $_color_flag = false; |
/** |
* Commands for drawing color. |
* |
* @var string |
*/ |
var $_draw_color = '0 G'; |
/** |
* Word spacing. |
* |
* @var integer |
*/ |
var $_word_spacing = 0; |
/** |
* Automatic page breaking. |
* |
* @var boolean |
*/ |
var $_auto_page_break; |
/** |
* Threshold used to trigger page breaks. |
* |
* @var float |
*/ |
var $_page_break_trigger; |
/** |
* Flag set when processing footer. |
* |
* @var boolean |
*/ |
var $_in_footer = false; |
/** |
* Zoom display mode. |
* |
* @var string |
*/ |
var $_zoom_mode; |
/** |
* Layout display mode. |
* |
* @var string |
*/ |
var $_layout_mode; |
/** |
* An array containing the document info, consisting of: |
* - title |
* - subject |
* - author |
* - keywords |
* - creator |
* |
* @var array |
*/ |
var $_info = array(); |
/** |
* Alias for total number of pages. |
* |
* @var string |
*/ |
var $_alias_nb_pages = '{nb}'; |
/** |
* Attempts to return a conrete PDF instance. It allows to set up the page |
* format, the orientation and the units of measurement used in all the |
* methods (except for the font sizes). |
* |
* Example:<pre> |
* $pdf = &File_PDF::factory(array('orientation' => 'P', |
* 'unit' => 'mm', |
* 'format' => 'A4'));</pre> |
* |
* @param array $params A hash with parameters for the created PDF object. |
* Possible parameters are: |
* orientation - Default page orientation. Possible |
* values are (case insensitive): |
* <pre> |
* - P or Portrait (default) |
* - L or Landscape |
* </pre> |
* unit - User measure units. Possible values values |
* are: |
* <pre> |
* - pt: point |
* - mm: millimeter (default) |
* - cm: centimeter |
* - in: inch |
* </pre> |
* A point equals 1/72 of inch, that is to say about |
* 0.35 mm (an inch being 2.54 cm). This is a very |
* common unit in typography; font sizes are |
* expressed in that unit. |
* format - The format used for pages. It can be |
* either one of the following values (case |
* insensitive): |
* <pre> |
* - A3 |
* - A4 (default) |
* - A5 |
* - Letter |
* - Legal |
* </pre> |
* or a custom format in the form of a two-element |
* array containing the width and the height |
* (expressed in the unit given by the unit |
* parameter). |
* @param string $class The concrete class name to return an instance of. |
* Defaults to File_PDF. |
*/ |
function &factory($params = array(), $class = 'File_PDF') |
{ |
/* Check for PHP locale-related bug. */ |
if (1.1 == 1) { |
$error = File_PDF::raiseError('Do not alter the locale before including the class file.'); |
return $error; |
} |
/* Default parameters. */ |
$defaults = array('orientation' => 'P', 'unit' => 'mm', 'format' => 'A4'); |
/* Backward compatibility with old method signature. */ |
/* Should be removed a few versions later. */ |
if (!is_array($params)) { |
$class = 'File_PDF'; |
$params = $defaults; |
$names = array_keys($defaults); |
for ($i = 0; $i < func_num_args(); $i++) { |
$params[$names[$i]] = func_get_arg($i); |
} |
} else { |
$params = array_merge($defaults, $params); |
} |
/* Create the PDF object. */ |
$pdf = &new $class(); |
/* Scale factor. */ |
if ($params['unit'] == 'pt') { |
$pdf->_scale = 1; |
} elseif ($params['unit'] == 'mm') { |
$pdf->_scale = 72 / 25.4; |
} elseif ($params['unit'] == 'cm') { |
$pdf->_scale = 72 / 2.54; |
} elseif ($params['unit'] == 'in') { |
$pdf->_scale = 72; |
} else { |
$error = File_PDF::raiseError(sprintf('Incorrect units: %s', $params['unit'])); |
return $error; |
} |
/* Page format. */ |
if (is_string($params['format'])) { |
$params['format'] = strtolower($params['format']); |
if ($params['format'] == 'a3') { |
$params['format'] = array(841.89, 1190.55); |
} elseif ($params['format'] == 'a4') { |
$params['format'] = array(595.28, 841.89); |
} elseif ($params['format'] == 'a5') { |
$params['format'] = array(420.94, 595.28); |
} elseif ($params['format'] == 'letter') { |
$params['format'] = array(612, 792); |
} elseif ($params['format'] == 'legal') { |
$params['format'] = array(612, 1008); |
} else { |
$error = File_PDF::raiseError(sprintf('Unknown page format: %s', $params['format'])); |
return $error; |
} |
$pdf->fwPt = $params['format'][0]; |
$pdf->fhPt = $params['format'][1]; |
} else { |
$pdf->fwPt = $params['format'][0] * $pdf->_scale; |
$pdf->fhPt = $params['format'][1] * $pdf->_scale; |
} |
$pdf->fw = $pdf->fwPt / $pdf->_scale; |
$pdf->fh = $pdf->fhPt / $pdf->_scale; |
/* Page orientation. */ |
$params['orientation'] = strtolower($params['orientation']); |
if ($params['orientation'] == 'p' || $params['orientation'] == 'portrait') { |
$pdf->_default_orientation = 'P'; |
$pdf->wPt = $pdf->fwPt; |
$pdf->hPt = $pdf->fhPt; |
} elseif ($params['orientation'] == 'l' || $params['orientation'] == 'landscape') { |
$pdf->_default_orientation = 'L'; |
$pdf->wPt = $pdf->fhPt; |
$pdf->hPt = $pdf->fwPt; |
} else { |
$error = File_PDF::raiseError(sprintf('Incorrect orientation: %s', $params['orientation'])); |
return $error; |
} |
$pdf->_current_orientation = $pdf->_default_orientation; |
$pdf->w = $pdf->wPt / $pdf->_scale; |
$pdf->h = $pdf->hPt / $pdf->_scale; |
/* Page margins (1 cm) */ |
$margin = 28.35 / $pdf->_scale; |
$pdf->setMargins($margin, $margin); |
/* Interior cell margin (1 mm) */ |
$pdf->_cell_margin = $margin / 10; |
/* Line width (0.2 mm) */ |
$pdf->_line_width = .567 / $pdf->_scale; |
/* Automatic page break */ |
$pdf->setAutoPageBreak(true, 2 * $margin); |
/* Full width display mode */ |
$pdf->setDisplayMode('fullwidth'); |
/* Compression */ |
$pdf->setCompression(true); |
return $pdf; |
} |
/** |
* Returns a PEAR_Error object. Wraps around PEAR::raiseError() to |
* avoid having to include PEAR.php unless an error occurs. |
* |
* @param mixed $error The error message. |
* |
* @return object PEAR_Error |
*/ |
function raiseError($error) |
{ |
require_once 'PEAR.php'; |
return PEAR::raiseError($error); |
} |
/** |
* Defines the left, top and right margins. By default, they equal 1 cm. |
* Call this method to change them. |
* |
* @param float $left Left margin. |
* @param float $top Top margin. |
* @param float $right Right margin. If not specified default to the value |
* of the left one. |
* |
* @see File_PDF::setAutoPageBreak |
* @see File_PDF::setLeftMargin |
* @see File_PDF::setRightMargin |
* @see File_PDF::setTopMargin |
*/ |
function setMargins($left, $top, $right = null) |
{ |
/* Set left and top margins. */ |
$this->_left_margin = $left; |
$this->_top_margin = $top; |
/* If no right margin set default to same as left. */ |
$this->_right_margin = (is_null($right) ? $left : $right); |
} |
/** |
* Defines the left margin. The method can be called before creating the |
* first page. |
* If the current abscissa gets out of page, it is brought back to the |
* margin. |
* |
* @param float $margin The margin. |
* |
* @see File_PDF::setAutoPageBreak |
* @see File_PDF::setMargins |
* @see File_PDF::setRightMargin |
* @see File_PDF::setTopMargin |
*/ |
function setLeftMargin($margin) |
{ |
$this->_left_margin = $margin; |
/* If there is a current page and the current X position is less than |
* margin set the X position to the margin value. */ |
if ($this->_page > 0 && $this->x < $margin) { |
$this->x = $margin; |
} |
} |
/** |
* Defines the top margin. The method can be called before creating the |
* first page. |
* |
* @param float $margin The margin. |
*/ |
function setTopMargin($margin) |
{ |
$this->_top_margin = $margin; |
} |
/** |
* Defines the right margin. The method can be called before creating the |
* first page. |
* |
* @param float $margin The margin. |
*/ |
function setRightMargin($margin) |
{ |
$this->_right_margin = $margin; |
} |
/** |
* Returns the actual page width. |
* |
* @since File_PDF 0.2.0 |
* @since Horde 3.2 |
* |
* @return float The page width. |
*/ |
function getPageWidth() |
{ |
return ($this->w - $this->_right_margin - $this->_left_margin); |
} |
/** |
* Returns the actual page height. |
* |
* @since File_PDF 0.2.0 |
* @since Horde 3.2 |
* |
* @return float The page height. |
*/ |
function getPageHeight() |
{ |
return ($this->h - $this->_top_margin - $this->_break_margin); |
} |
/** |
* Enables or disables the automatic page breaking mode. When enabling, |
* the second parameter is the distance from the bottom of the page that |
* defines the triggering limit. By default, the mode is on and the margin |
* is 2 cm. |
* |
* @param boolean auto Boolean indicating if mode should be on or off. |
* @param float $margin Distance from the bottom of the page. |
*/ |
function setAutoPageBreak($auto, $margin = 0) |
{ |
$this->_auto_page_break = $auto; |
$this->_break_margin = $margin; |
$this->_page_break_trigger = $this->h - $margin; |
} |
/** |
* Defines the way the document is to be displayed by the viewer. The zoom |
* level can be set: pages can be displayed entirely on screen, occupy the |
* full width of the window, use real size, be scaled by a specific |
* zooming factor or use viewer default (configured in the Preferences |
* menu of Acrobat). The page layout can be specified too: single at once, |
* continuous display, two columns or viewer default. |
* By default, documents use the full width mode with continuous display. |
* |
* @param mixed $zoom The zoom to use. It can be one of the |
* following string values: |
* - fullpage: entire page on screen |
* - fullwidth: maximum width of window |
* - real: uses real size (100% zoom) |
* - default: uses viewer default mode |
* or a number indicating the zooming factor. |
* @param string layout The page layout. Possible values are: |
* - single: one page at once |
* - continuous: pages in continuously |
* - two: two pages on two columns |
* - default: uses viewer default mode |
* Default value is continuous. |
*/ |
function setDisplayMode($zoom, $layout = 'continuous') |
{ |
$zoom = strtolower($zoom); |
if ($zoom == 'fullpage' || $zoom == 'fullwidth' || $zoom == 'real' |
|| $zoom == 'default' || !is_string($zoom)) { |
$this->_zoom_mode = $zoom; |
} elseif ($zoom == 'zoom') { |
$this->_zoom_mode = $layout; |
} else { |
return $this->raiseError(sprintf('Incorrect zoom display mode: %s', $zoom)); |
} |
$layout = strtolower($layout); |
if ($layout == 'single' || $layout == 'continuous' || $layout == 'two' |
|| $layout == 'default') { |
$this->_layout_mode = $layout; |
} elseif ($zoom != 'zoom') { |
return $this->raiseError(sprintf('Incorrect layout display mode: %s', $layout)); |
} |
} |
/** |
* Activates or deactivates page compression. When activated, the internal |
* representation of each page is compressed, which leads to a compression |
* ratio of about 2 for the resulting document. |
* Compression is on by default. |
* Note: the Zlib extension is required for this feature. If not present, |
* compression will be turned off. |
* |
* @param boolean $compress Boolean indicating if compression must be |
* enabled or not. |
*/ |
function setCompression($compress) |
{ |
/* If no gzcompress function is available then default to false. */ |
$this->_compress = (function_exists('gzcompress') ? $compress : false); |
} |
/** |
* Set the info to a document. Possible info settings are: |
* - title |
* - subject |
* - author |
* - keywords |
* - creator |
* |
* @param mixed $info If passed as an array then the complete hash |
* containing the info to be inserted into the |
* document. Otherwise the name of setting to be set. |
* @param string $value The value of the setting. |
*/ |
function setInfo($info, $value = '') |
{ |
if (is_array($info)) { |
$this->_info = $info; |
} else { |
$this->_info[$info] = $value; |
} |
} |
/** |
* Defines an alias for the total number of pages. It will be substituted |
* as the document is closed. |
* |
* Example: |
* class My_File_PDF extends File_PDF { |
* function footer() |
* { |
* // Go to 1.5 cm from bottom |
* $this->setY(-15); |
* // Select Arial italic 8 |
* $this->setFont('Arial', 'I', 8); |
* // Print current and total page numbers |
* $this->cell(0, 10, 'Page ' . $this->getPageNo() . '/{nb}', 0, |
* 0, 'C'); |
* } |
* } |
* $pdf = &My_File_PDF::factory(); |
* $pdf->aliasNbPages(); |
* |
* @param string $alias The alias. Default value: {nb}. |
* |
* @see File_PDF::getPageNo |
* @see File_PDF::footer |
*/ |
function aliasNbPages($alias = '{nb}') |
{ |
$this->_alias_nb_pages = $alias; |
} |
/** |
* This method begins the generation of the PDF document; it must be |
* called before any output commands. No page is created by this method, |
* therefore it is necessary to call File_PDF::addPage. |
* |
* @see File_PDF::addPage |
* @see File_PDF::close |
*/ |
function open() |
{ |
$this->_beginDoc(); |
} |
/** |
* Terminates the PDF document. It is not necessary to call this method |
* explicitly because File_PDF::output does it automatically. |
* If the document contains no page, File_PDF::addPage is called to prevent |
* from getting an invalid document. |
* |
* @see File_PDF::open |
* @see File_PDF::output |
*/ |
function close() |
{ |
/* Terminate document */ |
if ($this->_page == 0) { |
$this->addPage(); |
} |
/* Page footer */ |
$this->_in_footer = true; |
$this->footer(); |
$this->_in_footer = false; |
/* Close page */ |
$this->_endPage(); |
/* Close document */ |
$this->_endDoc(); |
} |
/** |
* Adds a new page to the document. If a page is already present, the |
* File_PDF::footer method is called first to output the footer. Then the |
* page is added, the current position set to the top-left corner according |
* to the left and top margins, and File_PDF::header is called to display |
* the header. |
* The font which was set before calling is automatically restored. There |
* is no need to call File_PDF::setFont again if you want to continue with |
* the same font. The same is true for colors and line width. |
* The origin of the coordinate system is at the top-left corner and |
* increasing ordinates go downwards. |
* |
* @param string $orientation Page orientation. Possible values |
* are (case insensitive): |
* - P or Portrait |
* - L or Landscape |
* The default value is the one passed to the |
* constructor. |
* |
* @see File_PDF::PDF |
* @see File_PDF::header |
* @see File_PDF::footer |
* @see File_PDF::setMargins |
*/ |
function addPage($orientation = '') |
{ |
/* For good measure make sure this is called. */ |
$this->_beginDoc(); |
/* Save style settings so that they are not overridden by footer(). */ |
$lw = $this->_line_width; |
$dc = $this->_draw_color; |
$fc = $this->_fill_color; |
$tc = $this->_text_color; |
$cf = $this->_color_flag; |
if ($this->_page > 0) { |
/* Page footer. */ |
$this->_in_footer = true; |
$this->footer(); |
$this->_in_footer = false; |
/* Close page. */ |
$this->_endPage(); |
} |
/* Start new page. */ |
$this->_beginPage($orientation); |
/* Set line cap style to square. */ |
$this->_out('2 J'); |
/* Set line width. */ |
$this->_line_width = $lw; |
$this->_out(sprintf('%.2f w', $lw * $this->_scale)); |
/* Set font for the beginning of the page. */ |
$font_family = null; |
if ($this->_font_family) { |
$font_family = $this->_font_family; |
$font_style = $this->_font_style . ($this->_underline ? 'U' : ''); |
$font_size = $this->_font_size_pt; |
$this->setFont($font_family, $font_style, $font_size); |
} |
/* Set colors. */ |
$this->_fill_color = $fc; |
/* Check if fill color has been set before this page. */ |
if ($this->_fill_color != '0 g') { |
$this->_out($this->_fill_color); |
} |
$this->_draw_color = $dc; |
/* Check if draw color has been set before this page. */ |
if ($this->_draw_color != '0 G') { |
$this->_out($this->_draw_color); |
} |
$this->_text_color = $tc; |
$this->_color_flag = $cf; |
/* Page header. */ |
$this->header(); |
/* Restore line width. */ |
if ($this->_line_width != $lw) { |
$this->_line_width = $lw; |
$this->_out(sprintf('%.2f w', $lw * $this->_scale)); |
} |
/* Make sure the font is set for this page as it was before the |
* header. */ |
if ($font_family) { |
$this->setFont($font_family, $font_style, $font_size, true); |
} |
/* Restore colors. */ |
if ($this->_draw_color != $dc) { |
$this->_draw_color = $dc; |
$this->_out($dc); |
} |
if ($this->_fill_color != $fc) { |
$this->_fill_color = $fc; |
$this->_out($fc); |
} |
$this->_text_color = $tc; |
$this->_color_flag = $cf; |
} |
/** |
* This method is used to render the page header. It is automatically |
* called by File_PDF::addPage and should not be called directly by the |
* application. The implementation in File_PDF:: is empty, so you have to |
* subclass it and override the method if you want a specific processing. |
* |
* Example: |
* |
* class My_File_PDF extends File_PDF { |
* function header() |
* { |
* // Select Arial bold 15 |
* $this->setFont('Arial', 'B', 15); |
* // Move to the right |
* $this->cell(80); |
* // Framed title |
* $this->cell(30, 10, 'Title', 1, 0, 'C'); |
* // Line break |
* $this->newLine(20); |
* } |
* } |
* |
* @see File_PDF::footer |
*/ |
function header() |
{ |
/* To be implemented in your own inherited class. */ |
} |
/** |
* This method is used to render the page footer. It is automatically |
* called by File_PDF::addPage and File_PDF::close and should not be called |
* directly by the application. The implementation in File_PDF:: is empty, |
* so you have to subclass it and override the method if you want a specific |
* processing. |
* |
* Example: |
* |
* class My_File_PDF extends File_PDF { |
* function footer() |
* { |
* // Go to 1.5 cm from bottom |
* $this->setY(-15); |
* // Select Arial italic 8 |
* $this->setFont('Arial', 'I', 8); |
* // Print centered page number |
* $this->cell(0, 10, 'Page ' . $this->getPageNo(), 0, 0, 'C'); |
* } |
* } |
* |
* @see File_PDF::header |
*/ |
function footer() |
{ |
/* To be implemented in your own inherited class. */ |
} |
/** |
* Returns the current page number. |
* |
* @return integer |
* |
* @see File_PDF::aliasNbPages |
*/ |
function getPageNo() |
{ |
return $this->_page; |
} |
/** |
* Sets the fill color. |
* |
* Depending on the colorspace called, the number of color component |
* parameters required can be either 1, 3 or 4. The method can be called |
* before the first page is created and the color is retained from page to |
* page. |
* |
* @param string $cs Indicates the colorspace which can be either 'rgb', |
* 'cmyk' or 'gray'. Defaults to 'rgb'. |
* @param float $c1 First color component, floating point value between 0 |
* and 1. Required for gray, rgb and cmyk. |
* @param float $c2 Second color component, floating point value between |
* 0 and 1. Required for rgb and cmyk. |
* @param float $c3 Third color component, floating point value between |
* 0 and 1. Required for rgb and cmyk. |
* @param float $c4 Fourth color component, floating point value between |
* 0 and 1. Required for cmyk. |
* |
* @see File_PDF::setTextColor |
* @see File_PDF::setDrawColor |
* @see File_PDF::rect |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
*/ |
function setFillColor($cs = 'rgb', $c1, $c2 = 0, $c3 = 0, $c4 = 0) |
{ |
$cs = strtolower($cs); |
if ($cs == 'rgb') { |
$this->_fill_color = sprintf('%.3f %.3f %.3f rg', $c1, $c2, $c3); |
} elseif ($cs == 'cmyk') { |
$this->_fill_color = sprintf('%.3f %.3f %.3f %.3f k', $c1, $c2, $c3, $c4); |
} else { |
$this->_fill_color = sprintf('%.3f g', $c1); |
} |
if ($this->_page > 0) { |
$this->_out($this->_fill_color); |
} |
$this->_color_flag = $this->_fill_color != $this->_text_color; |
} |
/** |
* Sets the text color. |
* |
* Depending on the colorspace called, the number of color component |
* parameters required can be either 1, 3 or 4. The method can be called |
* before the first page is created and the color is retained from page to |
* page. |
* |
* @param string $cs Indicates the colorspace which can be either 'rgb', |
* 'cmyk' or 'gray'. Defaults to 'rgb'. |
* @param float $c1 First color component, floating point value between 0 |
* and 1. Required for gray, rgb and cmyk. |
* @param float $c2 Second color component, floating point value between |
* 0 and 1. Required for rgb and cmyk. |
* @param float $c3 Third color component, floating point value between |
* 0 and 1. Required for rgb and cmyk. |
* @param float $c4 Fourth color component, floating point value between |
* 0 and 1. Required for cmyk. |
* |
* @since File_PDF 0.2.0 |
* @since Horde 3.2 |
* @see File_PDF::setFillColor |
* @see File_PDF::setDrawColor |
* @see File_PDF::rect |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
*/ |
function setTextColor($cs = 'rgb', $c1, $c2 = 0, $c3 = 0, $c4 = 0) |
{ |
$cs = strtolower($cs); |
if ($cs == 'rgb') { |
$this->_text_color = sprintf('%.3f %.3f %.3f rg', $c1, $c2, $c3); |
} elseif ($cs == 'cmyk') { |
$this->_text_color = sprintf('%.3f %.3f %.3f %.3f k', $c1, $c2, $c3, $c4); |
} else { |
$this->_text_color = sprintf('%.3f g', $c1); |
} |
if ($this->_page > 0) { |
$this->_out($this->_text_color); |
} |
$this->_color_flag = $this->_fill_color != $this->_text_color; |
} |
/** |
* Sets the draw color, used when drawing lines. Depending on the |
* colorspace called, the number of color component parameters required |
* can be either 1, 3 or 4. The method can be called before the first page |
* is created and the color is retained from page to page. |
* |
* @param string $cs Indicates the colorspace which can be either 'rgb', |
* 'cmyk' or 'gray'. Defaults to 'rgb'. |
* @param float $c1 First color component, floating point value between 0 |
* and 1. Required for gray, rgb and cmyk. |
* @param float $c2 Second color component, floating point value between |
* 0 and 1. Required for rgb and cmyk. |
* @param float $c3 Third color component, floating point value between 0 |
* and 1. Required for rgb and cmyk. |
* @param float $c4 Fourth color component, floating point value between |
* 0 and 1. Required for cmyk. |
* |
* @see File_PDF::setFillColor |
* @see File_PDF::line |
* @see File_PDF::rect |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
*/ |
function setDrawColor($cs = 'rgb', $c1, $c2 = 0, $c3 = 0, $c4 = 0) |
{ |
$cs = strtolower($cs); |
if ($cs == 'rgb') { |
$this->_draw_color = sprintf('%.3f %.3f %.3f RG', $c1, $c2, $c3); |
} elseif ($cs == 'cmyk') { |
$this->_draw_color = sprintf('%.3f %.3f %.3f %.3f K', $c1, $c2, $c3, $c4); |
} else { |
$this->_draw_color = sprintf('%.3f G', $c1); |
} |
if ($this->_page > 0) { |
$this->_out($this->_draw_color); |
} |
} |
/** |
* Returns the length of a text string. A font must be selected. |
* |
* @param string $text The text whose length is to be computed. |
* @param boolean $pt Boolean to indicate if the width should be returned |
* in points or user units. Default is 'false'. |
* |
* @return float |
*/ |
function getStringWidth($text, $pt = false) |
{ |
$text = (string)$text; |
$width = 0; |
$length = strlen($text); |
for ($i = 0; $i < $length; $i++) { |
$width += $this->_current_font['cw'][$text{$i}]; |
} |
/* Adjust for word spacing. */ |
$width += $this->_word_spacing * substr_count($text, ' ') * $this->_current_font['cw'][' ']; |
if ($pt) { |
return $width * $this->_font_size_pt / 1000; |
} else { |
return $width * $this->_font_size / 1000; |
} |
} |
/** |
* Defines the line width. By default, the value equals 0.2 mm. The method |
* can be called before the first page is created and the value is |
* retained from page to page. |
* |
* @param float $width The width. |
* |
* @see File_PDF::line |
* @see File_PDF::rect |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
*/ |
function setLineWidth($width) |
{ |
$this->_line_width = $width; |
if ($this->_page > 0) { |
$this->_out(sprintf('%.2f w', $width * $this->_scale)); |
} |
} |
/** |
* Draws a line between two points. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param float $x1 Abscissa of first point. |
* @param float $y1 Ordinate of first point. |
* @param float $x2 Abscissa of second point. |
* @param float $y2 Ordinate of second point. |
* |
* @see File_PDF::setLineWidth |
* @see File_PDF::setDrawColor. |
*/ |
function line($x1, $y1, $x2, $y2) |
{ |
if ($x1 < 0) { |
$x1 += $this->w; |
} |
if ($y1 < 0) { |
$y1 += $this->h; |
} |
if ($x2 < 0) { |
$x2 += $this->w; |
} |
if ($y2 < 0) { |
$y2 += $this->h; |
} |
$this->_out(sprintf('%.2f %.2f m %.2f %.2f l S', $x1 * $this->_scale, ($this->h - $y1) * $this->_scale, $x2 * $this->_scale, ($this->h - $y2) * $this->_scale)); |
} |
/** |
* Outputs a rectangle. It can be drawn (border only), filled (with no |
* border) or both. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param float $x Abscissa of upper-left corner. |
* @param float $y Ordinate of upper-left corner. |
* @param float $width Width. |
* @param float $height Height. |
* @param float $style Style of rendering. Possible values are: |
* - D or empty string: draw (default) |
* - F: fill |
* - DF or FD: draw and fill |
* |
* @see File_PDF::setLineWidth |
* @see File_PDF::setDrawColor |
* @see File_PDF::setFillColor |
*/ |
function rect($x, $y, $width, $height, $style = '') |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
$style = strtoupper($style); |
if ($style == 'F') { |
$op = 'f'; |
} elseif ($style == 'FD' || $style == 'DF') { |
$op = 'B'; |
} else { |
$op = 'S'; |
} |
$x = $this->_toPt($x); |
$y = $this->_toPt($y); |
$width = $this->_toPt($width); |
$height = $this->_toPt($height); |
$this->_out(sprintf('%.2f %.2f %.2f %.2f re %s', $x, $this->hPt - $y, $width, -$height, $op)); |
} |
/** |
* Outputs a circle. It can be drawn (border only), filled (with no |
* border) or both. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param float $x Abscissa of the center of the circle. |
* @param float $y Ordinate of the center of the circle. |
* @param float $r Circle radius. |
* @param string $style Style of rendering. Possible values are: |
* - D or empty string: draw (default) |
* - F: fill |
* - DF or FD: draw and fill |
*/ |
function circle($x, $y, $r, $style = '') |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
$style = strtolower($style); |
if ($style == 'f') { |
$op = 'f'; // Style is fill only. |
} elseif ($style == 'fd' || $style == 'df') { |
$op = 'B'; // Style is fill and stroke. |
} else { |
$op = 'S'; // Style is stroke only. |
} |
$x = $this->_toPt($x); |
$y = $this->_toPt($y); |
$r = $this->_toPt($r); |
/* Invert the y scale. */ |
$y = $this->hPt - $y; |
/* Length of the Bezier control. */ |
$b = $r * 0.552; |
/* Move from the given origin and set the current point |
* to the start of the first Bezier curve. */ |
$c = sprintf('%.2f %.2f m', $x - $r, $y); |
$x = $x - $r; |
/* First circle quarter. */ |
$c .= sprintf(' %.2f %.2f %.2f %.2f %.2f %.2f c', |
$x, $y + $b, // First control point. |
$x + $r - $b, $y + $r, // Second control point. |
$x + $r, $y + $r); // Final point. |
/* Set x/y to the final point. */ |
$x = $x + $r; |
$y = $y + $r; |
/* Second circle quarter. */ |
$c .= sprintf(' %.2f %.2f %.2f %.2f %.2f %.2f c', |
$x + $b, $y, |
$x + $r, $y - $r + $b, |
$x + $r, $y - $r); |
/* Set x/y to the final point. */ |
$x = $x + $r; |
$y = $y - $r; |
/* Third circle quarter. */ |
$c .= sprintf(' %.2f %.2f %.2f %.2f %.2f %.2f c', |
$x, $y - $b, |
$x - $r + $b, $y - $r, |
$x - $r, $y - $r); |
/* Set x/y to the final point. */ |
$x = $x - $r; |
$y = $y - $r; |
/* Fourth circle quarter. */ |
$c .= sprintf(' %.2f %.2f %.2f %.2f %.2f %.2f c %s', |
$x - $b, $y, |
$x - $r, $y + $r - $b, |
$x - $r, $y + $r, |
$op); |
/* Output the whole string. */ |
$this->_out($c); |
} |
/** |
* Imports a TrueType or Type1 font and makes it available. It is |
* necessary to generate a font definition file first with the |
* makefont.php utility. |
* The location of the definition file (and the font file itself when |
* embedding) must be found at the full path name included. |
* |
* Example: |
* $pdf->addFont('Comic', 'I'); |
* is equivalent to: |
* $pdf->addFont('Comic', 'I', 'comici.php'); |
* |
* @param string $family Font family. The name can be chosen arbitrarily. |
* If it is a standard family name, it will |
* override the corresponding font. |
* @param string $style Font style. Possible values are (case |
* insensitive): |
* - empty string: regular (default) |
* - B: bold |
* - I: italic |
* - BI or IB: bold italic |
* @param string $file The font definition file. By default, the name is |
* built from the family and style, in lower case |
* with no space. |
* |
* @see File_PDF::setFont |
*/ |
function addFont($family, $style = '', $file = '') |
{ |
$family = strtolower($family); |
if ($family == 'arial') { |
$family = 'helvetica'; |
} |
$style = strtoupper($style); |
if ($style == 'IB') { |
$style = 'BI'; |
} |
if (isset($this->_fonts[$family . $style])) { |
return $this->raiseError(sprintf('Font already added: %s %s', $family, $style)); |
} |
if ($file == '') { |
$file = str_replace(' ', '', $family) . strtolower($style) . '.php'; |
} |
include($file); |
if (!isset($name)) { |
return $this->raiseError('Could not include font definition file.'); |
} |
$i = count($this->_fonts) + 1; |
$this->_fonts[$family . $style] = array('i' => $i, 'type' => $type, 'name' => $name, 'desc' => $desc, 'up' => $up, 'ut' => $ut, 'cw' => $cw, 'enc' => $enc, 'file' => $file); |
if ($diff) { |
/* Search existing encodings. */ |
$d = 0; |
$nb = count($this->_diffs); |
for ($i = 1; $i <= $nb; $i++) { |
if ($this->_diffs[$i] == $diff) { |
$d = $i; |
break; |
} |
} |
if ($d == 0) { |
$d = $nb + 1; |
$this->_diffs[$d] = $diff; |
} |
$this->_fonts[$family.$style]['diff'] = $d; |
} |
if ($file) { |
if ($type == 'TrueType') { |
$this->_font_files[$file] = array('length1' => $originalsize); |
} else { |
$this->_font_files[$file] = array('length1' => $size1, 'length2' => $size2); |
} |
} |
} |
/** |
* Sets the font used to print character strings. It is mandatory to call |
* this method at least once before printing text or the resulting |
* document would not be valid. The font can be either a standard one or a |
* font added via the File_PDF::addFont method. Standard fonts use Windows |
* encoding cp1252 (Western Europe). |
* The method can be called before the first page is created and the font |
* is retained from page to page. |
* If you just wish to change the current font size, it is simpler to call |
* File_PDF::setFontSize. |
* |
* @param string $family Family font. It can be either a name defined by |
* File_PDF::addFont or one of the standard families |
* (case insensitive): |
* - Courier (fixed-width) |
* - Helvetica or Arial (sans serif) |
* - Times (serif) |
* - Symbol (symbolic) |
* - ZapfDingbats (symbolic) |
* It is also possible to pass an empty string. In |
* that case, the current family is retained. |
* @param string $style Font style. Possible values are (case |
* insensitive): |
* - empty string: regular |
* - B: bold |
* - I: italic |
* - U: underline |
* or any combination. The default value is regular. |
* Bold and italic styles do not apply to Symbol and |
* ZapfDingbats. |
* @param integer $size Font size in points. The default value is the |
* current size. If no size has been specified since |
* the beginning of the document, the value taken |
* is 12. |
* @param boolean $force Force the setting of the font. Each new page will |
* require a new call to File_PDF::setFont and |
* settings this to true will make sure that the |
* checks for same font calls will be skipped. |
* |
* @see File_PDF::addFont |
* @see File_PDF::setFontSize |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
* @see File_PDF::Write |
*/ |
function setFont($family, $style = '', $size = null, $force = false) |
{ |
$family = strtolower($family); |
if ($family == 'arial') { |
/* Use helvetica instead of arial. */ |
$family = 'helvetica'; |
} elseif ($family == 'symbol' || $family == 'zapfdingbats') { |
/* These two fonts do not have styles available. */ |
$style = ''; |
} |
$style = strtoupper($style); |
/* Underline is handled separately, if specified in the style var |
* remove it from the style and set the underline flag. */ |
if (strpos($style, 'U') !== false) { |
$this->_underline = true; |
$style = str_replace('U', '', $style); |
} else { |
$this->_underline = false; |
} |
if ($style == 'IB') { |
$style = 'BI'; |
} |
/* If no size specified, use current size. */ |
if (is_null($size)) { |
$size = $this->_font_size_pt; |
} |
/* If font requested is already the current font and no force setting |
* of the font is requested (eg. when adding a new page) don't bother |
* with the rest of the function and simply return. */ |
if ($this->_font_family == $family && $this->_font_style == $style && |
$this->_font_size_pt == $size && !$force) { |
return; |
} |
/* Set the font key. */ |
$fontkey = $family . $style; |
/* Test if already cached. */ |
if (!isset($this->_fonts[$fontkey])) { |
/* Get the character width definition file. */ |
$font_widths = &File_PDF::_getFontFile($fontkey); |
if (is_a($font_widths, 'PEAR_Error')) { |
return $font_widths; |
} |
$i = count($this->_fonts) + 1; |
$this->_fonts[$fontkey] = array( |
'i' => $i, |
'type' => 'core', |
'name' => $this->_core_fonts[$fontkey], |
'up' => -100, |
'ut' => 50, |
'cw' => $font_widths[$fontkey]); |
} |
/* Store font information as current font. */ |
$this->_font_family = $family; |
$this->_font_style = $style; |
$this->_font_size_pt = $size; |
$this->_font_size = $size / $this->_scale; |
$this->_current_font = &$this->_fonts[$fontkey]; |
/* Output font information if at least one page has been defined. */ |
if ($this->_page > 0) { |
$this->_out(sprintf('BT /F%d %.2f Tf ET', $this->_current_font['i'], $this->_font_size_pt)); |
} |
} |
/** |
* Defines the size of the current font. |
* |
* @param float $size The size (in points). |
* |
* @see File_PDF::setFont |
*/ |
function setFontSize($size) |
{ |
/* If the font size is already the current font size, just return. */ |
if ($this->_font_size_pt == $size) { |
return; |
} |
/* Set the current font size, both in points and scaled to user |
* units. */ |
$this->_font_size_pt = $size; |
$this->_font_size = $size / $this->_scale; |
/* Output font information if at least one page has been defined. */ |
if ($this->_page > 0) { |
$this->_out(sprintf('BT /F%d %.2f Tf ET', $this->_current_font['i'], $this->_font_size_pt)); |
} |
} |
/** |
* Defines the style of the current font. |
* |
* @param string $style The font style. |
* |
* @see File_PDF::setFont |
* @since File_PDF 0.2.0 |
* @since Horde 3.2 |
*/ |
function setFontStyle($style) |
{ |
$this->setFont($this->_font_family, $style); |
} |
/** |
* Creates a new internal link and returns its identifier. An internal |
* link is a clickable area which directs to another place within the |
* document. |
* The identifier can then be passed to File_PDF::cell, File_PDF::write, |
* File_PDF::image or File_PDF::link. The destination is defined with |
* File_PDF::setLink. |
* |
* @see File_PDF::cell |
* @see File_PDF::Write |
* @see File_PDF::image |
* @see File_PDF::Link |
* @see File_PDF::SetLink |
*/ |
function addLink() |
{ |
$n = count($this->_links) + 1; |
$this->_links[$n] = array(0, 0); |
return $n; |
} |
/** |
* Defines the page and position a link points to. |
* |
* @param integer $link The link identifier returned by File_PDF::addLink. |
* @param float $y Ordinate of target position; -1 indicates the |
* current position. The default value is 0 (top of |
* page). |
* @param integer $page Number of target page; -1 indicates the current |
* page. This is the default value. |
* |
* @see File_PDF::addLink |
*/ |
function setLink($link, $y = 0, $page = -1) |
{ |
if ($y == -1) { |
$y = $this->y; |
} |
if ($page == -1) { |
$page = $this->_page; |
} |
$this->_links[$link] = array($page, $y); |
} |
/** |
* Puts a link on a rectangular area of the page. Text or image links are |
* generally put via File_PDF::cell, File_PDF::Write or File_PDF::image, |
* but this method can be useful for instance to define a clickable area |
* inside an image. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param float $x Abscissa of the upper-left corner of the rectangle. |
* @param float $y Ordinate of the upper-left corner of the rectangle. |
* @param float $width Width of the rectangle. |
* @param float $height Height of the rectangle. |
* @param mixed $link URL or identifier returned by File_PDF::addLink. |
* |
* @see File_PDF::addLink |
* @see File_PDF::cell |
* @see File_PDF::Write |
* @see File_PDF::image |
*/ |
function link($x, $y, $width, $height, $link) |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
/* Set up the coordinates with correct scaling in pt. */ |
$x = $this->_toPt($x); |
$y = $this->hPt - $this->_toPt($y); |
$width = $this->_toPt($width); |
$height = $this->_toPt($height); |
/* Save link to page links array. */ |
$this->_link($x, $y, $width, $height, $link); |
} |
/** |
* Prints a character string. The origin is on the left of the first |
* character, on the baseline. This method allows to place a string |
* precisely on the page, but it is usually easier to use File_PDF::cell, |
* File_PDF::multiCell or File_PDF::Write which are the standard methods to |
* print text. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param float $x Abscissa of the origin. |
* @param float $y Ordinate of the origin. |
* @param string $text String to print. |
* |
* @see File_PDF::setFont |
* @see File_PDF::cell |
* @see File_PDF::multiCell |
* @see File_PDF::Write |
*/ |
function text($x, $y, $text) |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
/* Scale coordinates into points and set correct Y position. */ |
$x = $this->_toPt($x); |
$y = $this->hPt - $this->_toPt($y); |
/* Escape any potentially harmful characters. */ |
$text = $this->_escape($text); |
$out = sprintf('BT %.2f %.2f Td (%s) Tj ET', $x, $y, $text); |
if ($this->_underline && $text != '') { |
$out .= ' ' . $this->_doUnderline($x, $y, $text); |
} |
if ($this->_color_flag) { |
$out = sprintf('q %s %s Q', $this->_text_color, $out); |
} |
$this->_out($out); |
} |
/** |
* Whenever a page break condition is met, the method is called, and the |
* break is issued or not depending on the returned value. The default |
* implementation returns a value according to the mode selected by |
* File_PDF:setAutoPageBreak. |
* This method is called automatically and should not be called directly |
* by the application. |
* |
* @return boolean |
* |
* @see File_PDF::setAutoPageBreak. |
*/ |
function acceptPageBreak() |
{ |
return $this->_auto_page_break; |
} |
/** |
* Prints a cell (rectangular area) with optional borders, background |
* color and character string. The upper-left corner of the cell |
* corresponds to the current position. The text can be aligned or |
* centered. After the call, the current position moves to the right or to |
* the next line. It is possible to put a link on the text. |
* If automatic page breaking is enabled and the cell goes beyond the |
* limit, a page break is done before outputting. |
* |
* @param float $width Cell width. If 0, the cell extends up to the right |
* margin. |
* @param float $height Cell height. Default value: 0. |
* @param string $text String to print. Default value: empty. |
* @param mixed $border Indicates if borders must be drawn around the |
* cell. The value can be either a number: |
* - 0: no border (default) |
* - 1: frame |
* or a string containing some or all of the |
* following characters (in any order): |
* - L: left |
* - T: top |
* - R: right |
* - B: bottom |
* @param integer $ln Indicates where the current position should go |
* after the call. Possible values are: |
* - 0: to the right (default) |
* - 1: to the beginning of the next line |
* - 2: below |
* Putting 1 is equivalent to putting 0 and calling |
* File_PDF::newLine just after. |
* @param string $align Allows to center or align the text. Possible |
* values are: |
* - L or empty string: left (default) |
* - C: center |
* - R: right |
* @param integer $fill Indicates if the cell fill type. Possible values |
* are: |
* - 0: transparent (default) |
* - 1: painted |
* @param string $link URL or identifier returned by |
* File_PDF:addLink. |
* |
* @see File_PDF::setFont |
* @see File_PDF::setDrawColor |
* @see File_PDF::setFillColor |
* @see File_PDF::setLineWidth |
* @see File_PDF::addLink |
* @see File_PDF::newLine |
* @see File_PDF::multiCell |
* @see File_PDF::Write |
* @see File_PDF::setAutoPageBreak |
*/ |
function cell($width, $height = 0, $text = '', $border = 0, $ln = 0, |
$align = '', $fill = 0, $link = '') |
{ |
$k = $this->_scale; |
if ($this->y + $height > $this->_page_break_trigger && |
!$this->_in_footer && $this->AcceptPageBreak()) { |
$x = $this->x; |
$ws = $this->_word_spacing; |
if ($ws > 0) { |
$this->_word_spacing = 0; |
$this->_out('0 Tw'); |
} |
$this->addPage($this->_current_orientation); |
$this->x = $x; |
if ($ws > 0) { |
$this->_word_spacing = $ws; |
$this->_out(sprintf('%.3f Tw', $ws * $k)); |
} |
} |
if ($width == 0) { |
$width = $this->w - $this->_right_margin - $this->x; |
} |
$s = ''; |
if ($fill == 1 || $border == 1) { |
if ($fill == 1) { |
$op = ($border == 1) ? 'B' : 'f'; |
} else { |
$op = 'S'; |
} |
$s = sprintf('%.2f %.2f %.2f %.2f re %s ', $this->x * $k, ($this->h - $this->y) * $k, $width * $k, -$height * $k, $op); |
} |
if (is_string($border)) { |
if (strpos($border, 'L') !== false) { |
$s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $this->x * $k, ($this->h - $this->y) * $k, $this->x * $k, ($this->h - ($this->y + $height)) * $k); |
} |
if (strpos($border, 'T') !== false) { |
$s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $this->x * $k, ($this->h - $this->y) * $k, ($this->x + $width) * $k, ($this->h - $this->y) * $k); |
} |
if (strpos($border, 'R') !== false) { |
$s .= sprintf('%.2f %.2f m %.2f %.2f l S ', ($this->x + $width) * $k, ($this->h - $this->y) * $k, ($this->x + $width) * $k, ($this->h - ($this->y + $height)) * $k); |
} |
if (strpos($border, 'B') !== false) { |
$s .= sprintf('%.2f %.2f m %.2f %.2f l S ', $this->x * $k, ($this->h - ($this->y + $height)) * $k, ($this->x + $width) * $k, ($this->h - ($this->y + $height)) * $k); |
} |
} |
if ($text != '') { |
if ($align == 'R') { |
$dx = $width - $this->_cell_margin - $this->getStringWidth($text); |
} elseif ($align == 'C') { |
$dx = ($width - $this->getStringWidth($text)) / 2; |
} else { |
$dx = $this->_cell_margin; |
} |
if ($this->_color_flag) { |
$s .= 'q ' . $this->_text_color . ' '; |
} |
$text = str_replace(')', '\\)', str_replace('(', '\\(', str_replace('\\', '\\\\', $text))); |
$test2 = ((.5 * $height) + (.3 * $this->_font_size)); |
$test1 = $this->fhPt - (($this->y + $test2) * $k); |
$s .= sprintf('BT %.2f %.2f Td (%s) Tj ET', ($this->x + $dx) * $k, ($this->h - ($this->y + .5 * $height + .3 * $this->_font_size)) * $k, $text); |
if ($this->_underline) { |
$s .= ' ' . $this->_doUnderline($this->x + $dx, $this->y + .5 * $height + .3 * $this->_font_size, $text); |
} |
if ($this->_color_flag) { |
$s .= ' Q'; |
} |
if ($link) { |
$this->link($this->x + $dx, $this->y + .5 * $height-.5 * $this->_font_size, $this->getStringWidth($text), $this->_font_size, $link); |
} |
} |
if ($s) { |
$this->_out($s); |
} |
$this->_last_height = $height; |
if ($ln > 0) { |
/* Go to next line. */ |
$this->y += $height; |
if ($ln == 1) { |
$this->x = $this->_left_margin; |
} |
} else { |
$this->x += $width; |
} |
} |
/** |
* This method allows printing text with line breaks. They can be |
* automatic (as soon as the text reaches the right border of the cell) or |
* explicit (via the \n character). As many cells as necessary are output, |
* one below the other. |
* Text can be aligned, centered or justified. The cell block can be |
* framed and the background painted. |
* |
* @param float $width Width of cells. If 0, they extend up to the right |
* margin of the page. |
* @param float $height Height of cells. |
* @param string $text String to print. |
* @param mixed $border Indicates if borders must be drawn around the cell |
* block. The value can be either a number: |
* - 0: no border (default) |
* - 1: frame |
* or a string containing some or all of the |
* following characters (in any order): |
* - L: left |
* - T: top |
* - R: right |
* - B: bottom |
* @param string $align Sets the text alignment. Possible values are: |
* - L: left alignment |
* - C: center |
* - R: right alignment |
* - J: justification (default value) |
* @param integer $fill Indicates if the cell background must: |
* - 0: transparent (default) |
* - 1: painted |
* |
* @see File_PDF::setFont |
* @see File_PDF::setDrawColor |
* @see File_PDF::setFillColor |
* @see File_PDF::setLineWidth |
* @see File_PDF::cell |
* @see File_PDF::write |
* @see File_PDF::setAutoPageBreak |
*/ |
function multiCell($width, $height, $text, $border = 0, $align = 'J', |
$fill = 0) |
{ |
$cw = &$this->_current_font['cw']; |
if ($width == 0) { |
$width = $this->w - $this->_right_margin - $this->x; |
} |
$wmax = ($width-2 * $this->_cell_margin) * 1000 / $this->_font_size; |
$s = str_replace("\r", '', $text); |
$nb = strlen($s); |
if ($nb > 0 && $s[$nb-1] == "\n") { |
$nb--; |
} |
$b = 0; |
if ($border) { |
if ($border == 1) { |
$border = 'LTRB'; |
$b = 'LRT'; |
$b2 = 'LR'; |
} else { |
$b2 = ''; |
if (strpos($border, 'L') !== false) { |
$b2 .= 'L'; |
} |
if (strpos($border, 'R') !== false) { |
$b2 .= 'R'; |
} |
$b = (strpos($border, 'T') !== false) ? $b2 . 'T' : $b2; |
} |
} |
$sep = -1; |
$i = 0; |
$j = 0; |
$l = 0; |
$ns = 0; |
$nl = 1; |
while ($i < $nb) { |
/* Get next character. */ |
$c = $s[$i]; |
if ($c == "\n") { |
/* Explicit line break. */ |
if ($this->_word_spacing > 0) { |
$this->_word_spacing = 0; |
$this->_out('0 Tw'); |
} |
$this->cell($width, $height, substr($s, $j, $i-$j), $b, 2, $align, $fill); |
$i++; |
$sep = -1; |
$j = $i; |
$l = 0; |
$ns = 0; |
$nl++; |
if ($border && $nl == 2) { |
$b = $b2; |
} |
continue; |
} |
if ($c == ' ') { |
$sep = $i; |
$ls = $l; |
$ns++; |
} |
$l += $cw[$c]; |
if ($l > $wmax) { |
/* Automatic line break. */ |
if ($sep == -1) { |
if ($i == $j) { |
$i++; |
} |
if ($this->_word_spacing > 0) { |
$this->_word_spacing = 0; |
$this->_out('0 Tw'); |
} |
$this->cell($width, $height, substr($s, $j, $i - $j), $b, 2, $align, $fill); |
} else { |
if ($align == 'J') { |
$this->_word_spacing = ($ns>1) ? ($wmax - $ls)/1000 * $this->_font_size / ($ns - 1) : 0; |
$this->_out(sprintf('%.3f Tw', $this->_word_spacing * $this->_scale)); |
} |
$this->cell($width, $height, substr($s, $j, $sep - $j), $b, 2, $align, $fill); |
$i = $sep + 1; |
} |
$sep = -1; |
$j = $i; |
$l = 0; |
$ns = 0; |
$nl++; |
if ($border && $nl == 2) { |
$b = $b2; |
} |
} else { |
$i++; |
} |
} |
/* Last chunk. */ |
if ($this->_word_spacing > 0) { |
$this->_word_spacing = 0; |
$this->_out('0 Tw'); |
} |
if ($border && strpos($border, 'B') !== false) { |
$b .= 'B'; |
} |
$this->cell($width, $height, substr($s, $j, $i), $b, 2, $align, $fill); |
$this->x = $this->_left_margin; |
} |
/** |
* This method prints text from the current position. When the right |
* margin is reached (or the \n character is met) a line break occurs and |
* text continues from the left margin. Upon method exit, the current |
* position is left just at the end of the text. |
* It is possible to put a link on the text. |
* |
* Example: |
* //Begin with regular font |
* $pdf->setFont('Arial','',14); |
* $pdf->write(5,'Visit '); |
* //Then put a blue underlined link |
* $pdf->setTextColor(0,0,255); |
* $pdf->setFont('','U'); |
* $pdf->write(5,'www.fpdf.org','http://www.fpdf.org'); |
* |
* @param float $height Line height. |
* @param string $text String to print. |
* @param mixed $link URL or identifier returned by AddLink(). |
* |
* @see File_PDF::setFont |
* @see File_PDF::addLink |
* @see File_PDF::multiCell |
* @see File_PDF::setAutoPageBreak |
*/ |
function write($height, $text, $link = '') |
{ |
$cw = &$this->_current_font['cw']; |
$width = $this->w - $this->_right_margin - $this->x; |
$wmax = ($width - 2 * $this->_cell_margin) * 1000 / $this->_font_size; |
$s = str_replace("\r", '', $text); |
$nb = strlen($s); |
$sep = -1; |
$i = 0; |
$j = 0; |
$l = 0; |
$nl = 1; |
while ($i < $nb) { |
/* Get next character. */ |
$c = $s{$i}; |
if ($c == "\n") { |
/* Explicit line break. */ |
$this->cell($width, $height, substr($s, $j, $i - $j), 0, 2, '', 0, $link); |
$i++; |
$sep = -1; |
$j = $i; |
$l = 0; |
if ($nl == 1) { |
$this->x = $this->_left_margin; |
$width = $this->w - $this->_right_margin - $this->x; |
$wmax = ($width - 2 * $this->_cell_margin) * 1000 / $this->_font_size; |
} |
$nl++; |
continue; |
} |
if ($c == ' ') { |
$sep = $i; |
$ls = $l; |
} |
$l += (isset($cw[$c]) ? $cw[$c] : 0); |
if ($l > $wmax) { |
/* Automatic line break. */ |
if ($sep == -1) { |
if ($this->x > $this->_left_margin) { |
/* Move to next line. */ |
$this->x = $this->_left_margin; |
$this->y += $height; |
$width = $this->w - $this->_right_margin - $this->x; |
$wmax = ($width - 2 * $this->_cell_margin) * 1000 / $this->_font_size; |
$i++; |
$nl++; |
continue; |
} |
if ($i == $j) { |
$i++; |
} |
$this->cell($width, $height, substr($s, $j, $i - $j), 0, 2, '', 0, $link); |
} else { |
$this->cell($width, $height, substr($s, $j, $sep - $j), 0, 2, '', 0, $link); |
$i = $sep + 1; |
} |
$sep = -1; |
$j = $i; |
$l = 0; |
if ($nl == 1) { |
$this->x = $this->_left_margin; |
$width = $this->w - $this->_right_margin - $this->x; |
$wmax = ($width - 2 * $this->_cell_margin) * 1000 / $this->_font_size; |
} |
$nl++; |
} else { |
$i++; |
} |
} |
/* Last chunk. */ |
if ($i != $j) { |
$this->cell($l / 1000 * $this->_font_size, $height, substr($s, $j, $i), 0, 0, '', 0, $link); |
} |
} |
/** |
* Writes text at an angle. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* @param integer $x X coordinate. |
* @param integer $y Y coordinate. |
* @param string $text Text to write. |
* @param float $text_angle Angle to rotate (Eg. 90 = bottom to top). |
* @param float $font_angle Rotate characters as well as text. |
* |
* @see File_PDF::setFont |
*/ |
function writeRotated($x, $y, $text, $text_angle, $font_angle = 0) |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
/* Escape text. */ |
$text = $this->_escape($text); |
$font_angle += 90 + $text_angle; |
$text_angle *= M_PI / 180; |
$font_angle *= M_PI / 180; |
$text_dx = cos($text_angle); |
$text_dy = sin($text_angle); |
$font_dx = cos($font_angle); |
$font_dy = sin($font_angle); |
$s= sprintf('BT %.2f %.2f %.2f %.2f %.2f %.2f Tm (%s) Tj ET', |
$text_dx, $text_dy, $font_dx, $font_dy, |
$x * $this->_scale, ($this->h-$y) * $this->_scale, $text); |
if ($this->_draw_color) { |
$s = 'q ' . $this->_draw_color . ' ' . $s . ' Q'; |
} |
$this->_out($s); |
} |
/** |
* Prints an image in the page. The upper-left corner and at least one of |
* the dimensions must be specified; the height or the width can be |
* calculated automatically in order to keep the image proportions. |
* Supported formats are JPEG and PNG. |
* |
* All coordinates can be negative to provide values from the right or |
* bottom edge of the page (since File_PDF 0.2.0, Horde 3.2). |
* |
* For JPEG, all flavors are allowed: |
* - gray scales |
* - true colors (24 bits) |
* - CMYK (32 bits) |
* |
* For PNG, are allowed: |
* - gray scales on at most 8 bits (256 levels) |
* - indexed colors |
* - true colors (24 bits) |
* but are not supported: |
* - Interlacing |
* - Alpha channel |
* |
* If a transparent color is defined, it will be taken into account (but |
* will be only interpreted by Acrobat 4 and above). |
* The format can be specified explicitly or inferred from the file |
* extension. |
* It is possible to put a link on the image. |
* |
* Remark: if an image is used several times, only one copy will be |
* embedded in the file. |
* |
* @param string $file Name of the file containing the image. |
* @param float $x Abscissa of the upper-left corner. |
* @param float $y Ordinate of the upper-left corner. |
* @param float $width Width of the image in the page. If equal to zero, |
* it is automatically calculated to keep the |
* original proportions. |
* @param float $height Height of the image in the page. If not specified |
* or equal to zero, it is automatically calculated |
* to keep the original proportions. |
* @param string $type Image format. Possible values are (case |
* insensitive) : JPG, JPEG, PNG. If not specified, |
* the type is inferred from the file extension. |
* @param mixed $link URL or identifier returned by File_PDF::addLink. |
* |
* @see File_PDF::addLink |
*/ |
function image($file, $x, $y, $width = 0, $height = 0, $type = '', |
$link = '') |
{ |
if ($x < 0) { |
$x += $this->w; |
} |
if ($y < 0) { |
$y += $this->h; |
} |
if (!isset($this->_images[$file])) { |
/* First use of image, get some file info. */ |
if ($type == '') { |
$pos = strrpos($file, '.'); |
if ($pos === false) { |
return $this->raiseError(sprintf('Image file has no extension and no type was specified: %s', $file)); |
} |
$type = substr($file, $pos + 1); |
} |
$type = strtolower($type); |
$mqr = get_magic_quotes_runtime(); |
set_magic_quotes_runtime(0); |
if ($type == 'jpg' || $type == 'jpeg') { |
$info = $this->_parseJPG($file); |
} elseif ($type == 'png') { |
$info = $this->_parsePNG($file); |
} else { |
return $this->raiseError(sprintf('Unsupported image file type: %s', $type)); |
} |
if (is_a($info, 'PEAR_Error')) { |
return $info; |
} |
set_magic_quotes_runtime($mqr); |
$info['i'] = count($this->_images) + 1; |
$this->_images[$file] = $info; |
} else { |
$info = $this->_images[$file]; |
} |
/* Make sure all vars are converted to pt scale. */ |
$x = $this->_toPt($x); |
$y = $this->_toPt($y); |
$width = $this->_toPt($width); |
$height = $this->_toPt($height); |
/* If not specified do automatic width and height calculations. */ |
if (empty($width) && empty($height)) { |
$width = $info['w']; |
$height = $info['h']; |
} elseif (empty($width)) { |
$width = $height * $info['w'] / $info['h']; |
} elseif (empty($height)) { |
$height = $width * $info['h'] / $info['w']; |
} |
$this->_out(sprintf('q %.2f 0 0 %.2f %.2f %.2f cm /I%d Do Q', $width, $height, $x, $this->hPt - ($y + $height), $info['i'])); |
/* Set any link if requested. */ |
if ($link) { |
$this->_link($x, $y, $width, $height, $link); |
} |
} |
/** |
* Performs a line break. The current abscissa goes back to the left |
* margin and the ordinate increases by the amount passed in parameter. |
* |
* @param float $height The height of the break. By default, the value |
* equals the height of the last printed cell. |
* |
* @see File_PDF::cell |
*/ |
function newLine($height = '') |
{ |
$this->x = $this->_left_margin; |
if (is_string($height)) { |
$this->y += $this->_last_height; |
} else { |
$this->y += $height; |
} |
} |
/** |
* Returns the abscissa of the current position in user units. |
* |
* @return float |
* |
* @see File_PDF::setX |
* @see File_PDF::getY |
* @see File_PDF::setY |
*/ |
function getX() |
{ |
return $this->x; |
} |
/** |
* Defines the abscissa of the current position. If the passed value is |
* negative, it is relative to the right of the page. |
* |
* @param float $x The value of the abscissa. |
* |
* @see File_PDF::getX |
* @see File_PDF::getY |
* @see File_PDF::setY |
* @see File_PDF::setXY |
*/ |
function setX($x) |
{ |
if ($x >= 0) { |
/* Absolute value. */ |
$this->x = $x; |
} else { |
/* Negative, so relative to right edge of the page. */ |
$this->x = $this->w + $x; |
} |
} |
/** |
* Returns the ordinate of the current position in user units. |
* |
* @return float |
* |
* @see File_PDF::setY |
* @see File_PDF::getX |
* @see File_PDF::setX |
*/ |
function getY() |
{ |
return $this->y; |
} |
/** |
* Defines the ordinate of the current position. If the passed value is |
* negative, it is relative to the bottom of the page. |
* |
* @param float $y The value of the ordinate. |
* |
* @see File_PDF::getX |
* @see File_PDF::getY |
* @see File_PDF::setY |
* @see File_PDF::setXY |
*/ |
function setY($y) |
{ |
if ($y >= 0) { |
/* Absolute value. */ |
$this->y = $y; |
} else { |
/* Negative, so relative to bottom edge of the page. */ |
$this->y = $this->h + $y; |
} |
} |
/** |
* Defines the abscissa and ordinate of the current position. If the |
* passed values are negative, they are relative respectively to the right |
* and bottom of the page. |
* |
* @param float $x The value of the abscissa. |
* @param float $y The value of the ordinate. |
* |
* @see File_PDF::setX |
* @see File_PDF::setY |
*/ |
function setXY($x, $y) |
{ |
$this->setY($y); |
$this->setX($x); |
} |
/** |
* Returns the raw PDF file. |
* |
* @see File_PDF::output |
*/ |
function getOutput() |
{ |
/* Check whether file has been closed. */ |
if ($this->_state < 3) { |
$this->close(); |
} |
return $this->_buffer; |
} |
/** |
* Function to output the buffered data to the browser. |
* |
* @param string $filename The filename for the output file. |
* @param boolean $inline True if inline, false if attachment. |
*/ |
function output($filename = 'unknown.pdf', $inline = false) |
{ |
/* Check whether file has been closed. */ |
if ($this->_state < 3) { |
$this->close(); |
} |
/* Check if headers have been sent. */ |
if (headers_sent()) { |
return $this->raiseError('Unable to send PDF file, some data has already been output to browser.'); |
} |
/* If HTTP_Download is not available return a PEAR_Error. */ |
if (!include_once 'HTTP/Download.php') { |
return $this->raiseError('Missing PEAR package HTTP_Download.'); |
} |
/* Params for the output. */ |
$disposition = !$inline ? HTTP_DOWNLOAD_ATTACHMENT : HTTP_DOWNLOAD_INLINE; |
$params = array('data' => $this->_buffer, |
'contenttype' => 'application/pdf', |
'contentdisposition' => array($disposition, $filename)); |
/* Output the file. */ |
return HTTP_Download::staticSend($params); |
} |
/** |
* Function to save the PDF file somewhere local to the server. |
* |
* @param string $filename The filename for the output file. |
*/ |
function save($filename = 'unknown.pdf') |
{ |
/* Check whether file has been closed. */ |
if ($this->_state < 3) { |
$this->close(); |
} |
$f = fopen($filename, 'wb'); |
if (!$f) { |
return $this->raiseError(sprintf('Unable to save PDF file: %s', $filename)); |
} |
fwrite($f, $this->_buffer, strlen($this->_buffer)); |
fclose($f); |
} |
function _toPt($val) |
{ |
return $val * $this->_scale; |
} |
function &_getFontFile($fontkey, $path = '') |
{ |
static $font_widths; |
if (!isset($font_widths[$fontkey])) { |
if (!empty($path)) { |
$file = $path . strtolower($fontkey) . '.php'; |
} else { |
$file = 'File/PDF/fonts/' . strtolower($fontkey) . '.php'; |
} |
include $file; |
if (!isset($font_widths[$fontkey])) { |
return $this->raiseError(sprintf('Could not include font metric file: %s', $file)); |
} |
} |
return $font_widths; |
} |
function _link($x, $y, $width, $height, $link) |
{ |
/* Save link to page links array. */ |
$this->_page_links[$this->_page][] = array($x, $y, $width, $height, $link); |
} |
function _beginDoc() |
{ |
/* Start document, but only if not yet started. */ |
if ($this->_state < 1) { |
$this->_state = 1; |
$this->_out('%PDF-1.3'); |
} |
} |
function _putPages() |
{ |
$nb = $this->_page; |
if (!empty($this->_alias_nb_pages)) { |
/* Replace number of pages. */ |
for ($n = 1; $n <= $nb; $n++) { |
$this->_pages[$n] = str_replace($this->_alias_nb_pages, $nb, $this->_pages[$n]); |
} |
} |
if ($this->_default_orientation == 'P') { |
$wPt = $this->fwPt; |
$hPt = $this->fhPt; |
} else { |
$wPt = $this->fhPt; |
$hPt = $this->fwPt; |
} |
$filter = ($this->_compress) ? '/Filter /FlateDecode ' : ''; |
for ($n = 1; $n <= $nb; $n++) { |
/* Page */ |
$this->_newobj(); |
$this->_out('<</Type /Page'); |
$this->_out('/Parent 1 0 R'); |
if (isset($this->_orientation_changes[$n])) { |
$this->_out(sprintf('/MediaBox [0 0 %.2f %.2f]', $hPt, $wPt)); |
} |
$this->_out('/Resources 2 0 R'); |
if (isset($this->_page_links[$n])) { |
/* Links */ |
$annots = '/Annots ['; |
foreach ($this->_page_links[$n] as $pl) { |
$rect = sprintf('%.2f %.2f %.2f %.2f', $pl[0], $pl[1], $pl[0] + $pl[2], $pl[1] - $pl[3]); |
$annots .= '<</Type /Annot /Subtype /Link /Rect [' . $rect . '] /Border [0 0 0] '; |
if (is_string($pl[4])) { |
$annots .= '/A <</S /URI /URI ' . $this->_textString($pl[4]) . '>>>>'; |
} else { |
$l = $this->_links[$pl[4]]; |
$height = isset($this->_orientation_changes[$l[0]]) ? $wPt : $hPt; |
$annots .= sprintf('/Dest [%d 0 R /XYZ 0 %.2f null]>>', 1 + 2 * $l[0], $height - $l[1] * $this->_scale); |
} |
} |
$this->_out($annots.']'); |
} |
$this->_out('/Contents ' . ($this->_n + 1) . ' 0 R>>'); |
$this->_out('endobj'); |
/* Page content */ |
$p = ($this->_compress) ? gzcompress($this->_pages[$n]) : $this->_pages[$n]; |
$this->_newobj(); |
$this->_out('<<' . $filter . '/Length ' . strlen($p) . '>>'); |
$this->_putStream($p); |
$this->_out('endobj'); |
} |
/* Pages root */ |
$this->_offsets[1] = strlen($this->_buffer); |
$this->_out('1 0 obj'); |
$this->_out('<</Type /Pages'); |
$kids = '/Kids ['; |
for ($i = 0; $i < $nb; $i++) { |
$kids .= (3 + 2 * $i) . ' 0 R '; |
} |
$this->_out($kids . ']'); |
$this->_out('/Count ' . $nb); |
$this->_out(sprintf('/MediaBox [0 0 %.2f %.2f]', $wPt, $hPt)); |
$this->_out('>>'); |
$this->_out('endobj'); |
} |
function _putFonts() |
{ |
$nf = $this->_n; |
foreach ($this->_diffs as $diff) { |
/* Encodings */ |
$this->_newobj(); |
$this->_out('<</Type /Encoding /BaseEncoding /WinAnsiEncoding /Differences [' . $diff . ']>>'); |
$this->_out('endobj'); |
} |
$mqr = get_magic_quotes_runtime(); |
set_magic_quotes_runtime(0); |
foreach ($this->_font_files as $file => $info) { |
/* Font file embedding. */ |
$this->_newobj(); |
$this->_font_files[$file]['n'] = $this->_n; |
$size = filesize($file); |
if (!$size) { |
return $this->raiseError('Font file not found.'); |
} |
$this->_out('<</Length ' . $size); |
if (substr($file, -2) == '.z') { |
$this->_out('/Filter /FlateDecode'); |
} |
$this->_out('/Length1 ' . $info['length1']); |
if (isset($info['length2'])) { |
$this->_out('/Length2 ' . $info['length2'] . ' /Length3 0'); |
} |
$this->_out('>>'); |
$f = fopen($file, 'rb'); |
$this->_putStream(fread($f, $size)); |
fclose($f); |
$this->_out('endobj'); |
} |
set_magic_quotes_runtime($mqr); |
foreach ($this->_fonts as $k => $font) { |
/* Font objects */ |
$this->_newobj(); |
$this->_fonts[$k]['n'] = $this->_n; |
$name = $font['name']; |
$this->_out('<</Type /Font'); |
$this->_out('/BaseFont /' . $name); |
if ($font['type'] == 'core') { |
/* Standard font. */ |
$this->_out('/Subtype /Type1'); |
if ($name != 'Symbol' && $name != 'ZapfDingbats') { |
$this->_out('/Encoding /WinAnsiEncoding'); |
} |
} else { |
/* Additional font. */ |
$this->_out('/Subtype /' . $font['type']); |
$this->_out('/FirstChar 32'); |
$this->_out('/LastChar 255'); |
$this->_out('/Widths ' . ($this->_n + 1) . ' 0 R'); |
$this->_out('/FontDescriptor ' . ($this->_n + 2) . ' 0 R'); |
if ($font['enc']) { |
if (isset($font['diff'])) { |
$this->_out('/Encoding ' . ($nf + $font['diff']).' 0 R'); |
} else { |
$this->_out('/Encoding /WinAnsiEncoding'); |
} |
} |
} |
$this->_out('>>'); |
$this->_out('endobj'); |
if ($font['type'] != 'core') { |
/* Widths. */ |
$this->_newobj(); |
$cw = &$font['cw']; |
$s = '['; |
for ($i = 32; $i <= 255; $i++) { |
$s .= $cw[chr($i)] . ' '; |
} |
$this->_out($s . ']'); |
$this->_out('endobj'); |
/* Descriptor. */ |
$this->_newobj(); |
$s = '<</Type /FontDescriptor /FontName /' . $name; |
foreach ($font['desc'] as $k => $v) { |
$s .= ' /' . $k . ' ' . $v; |
} |
$file = $font['file']; |
if ($file) { |
$s .= ' /FontFile' . ($font['type'] == 'Type1' ? '' : '2') . ' ' . $this->_font_files[$file]['n'] . ' 0 R'; |
} |
$this->_out($s . '>>'); |
$this->_out('endobj'); |
} |
} |
} |
function _putImages() |
{ |
$filter = ($this->_compress) ? '/Filter /FlateDecode ' : ''; |
foreach ($this->_images as $file => $info) { |
$this->_newobj(); |
$this->_images[$file]['n'] = $this->_n; |
$this->_out('<</Type /XObject'); |
$this->_out('/Subtype /Image'); |
$this->_out('/Width ' . $info['w']); |
$this->_out('/Height ' . $info['h']); |
if ($info['cs'] == 'Indexed') { |
$this->_out('/ColorSpace [/Indexed /DeviceRGB ' . (strlen($info['pal'])/3 - 1) . ' ' . ($this->_n + 1).' 0 R]'); |
} else { |
$this->_out('/ColorSpace /' . $info['cs']); |
if ($info['cs'] == 'DeviceCMYK') { |
$this->_out('/Decode [1 0 1 0 1 0 1 0]'); |
} |
} |
$this->_out('/BitsPerComponent ' . $info['bpc']); |
$this->_out('/Filter /' . $info['f']); |
if (isset($info['parms'])) { |
$this->_out($info['parms']); |
} |
if (isset($info['trns']) && is_array($info['trns'])) { |
$trns = ''; |
$i_max = count($info['trns']); |
for ($i = 0; $i < $i_max; $i++) { |
$trns .= $info['trns'][$i] . ' ' . $info['trns'][$i].' '; |
} |
$this->_out('/Mask [' . $trns . ']'); |
} |
$this->_out('/Length ' . strlen($info['data']) . '>>'); |
$this->_putStream($info['data']); |
$this->_out('endobj'); |
/* Palette. */ |
if ($info['cs'] == 'Indexed') { |
$this->_newobj(); |
$pal = ($this->_compress) ? gzcompress($info['pal']) : $info['pal']; |
$this->_out('<<' . $filter . '/Length ' . strlen($pal) . '>>'); |
$this->_putStream($pal); |
$this->_out('endobj'); |
} |
} |
} |
function _putResources() |
{ |
$this->_putFonts(); |
$this->_putImages(); |
/* Resource dictionary */ |
$this->_offsets[2] = strlen($this->_buffer); |
$this->_out('2 0 obj'); |
$this->_out('<</ProcSet [/PDF /Text /ImageB /ImageC /ImageI]'); |
$this->_out('/Font <<'); |
foreach ($this->_fonts as $font) { |
$this->_out('/F' . $font['i'] . ' ' . $font['n'] . ' 0 R'); |
} |
$this->_out('>>'); |
if (count($this->_images)) { |
$this->_out('/XObject <<'); |
foreach ($this->_images as $image) { |
$this->_out('/I' . $image['i'] . ' ' . $image['n'] . ' 0 R'); |
} |
$this->_out('>>'); |
} |
$this->_out('>>'); |
$this->_out('endobj'); |
} |
function _putInfo() |
{ |
$this->_out('/Producer ' . $this->_textString('Horde PDF')); |
if (!empty($this->_info['title'])) { |
$this->_out('/Title ' . $this->_textString($this->_info['title'])); |
} |
if (!empty($this->_info['subject'])) { |
$this->_out('/Subject ' . $this->_textString($this->_info['subject'])); |
} |
if (!empty($this->_info['author'])) { |
$this->_out('/Author ' . $this->_textString($this->_info['author'])); |
} |
if (!empty($this->keywords)) { |
$this->_out('/Keywords ' . $this->_textString($this->keywords)); |
} |
if (!empty($this->creator)) { |
$this->_out('/Creator ' . $this->_textString($this->creator)); |
} |
$this->_out('/CreationDate ' . $this->_textString('D:' . date('YmdHis'))); |
} |
function _putCatalog() |
{ |
$this->_out('/Type /Catalog'); |
$this->_out('/Pages 1 0 R'); |
if ($this->_zoom_mode == 'fullpage') { |
$this->_out('/OpenAction [3 0 R /Fit]'); |
} elseif ($this->_zoom_mode == 'fullwidth') { |
$this->_out('/OpenAction [3 0 R /FitH null]'); |
} elseif ($this->_zoom_mode == 'real') { |
$this->_out('/OpenAction [3 0 R /XYZ null null 1]'); |
} elseif (!is_string($this->_zoom_mode)) { |
$this->_out('/OpenAction [3 0 R /XYZ null null ' . ($this->_zoom_mode / 100).']'); |
} |
if ($this->_layout_mode == 'single') { |
$this->_out('/PageLayout /SinglePage'); |
} elseif ($this->_layout_mode == 'continuous') { |
$this->_out('/PageLayout /OneColumn'); |
} elseif ($this->_layout_mode == 'two') { |
$this->_out('/PageLayout /TwoColumnLeft'); |
} |
} |
function _putTrailer() |
{ |
$this->_out('/Size ' . ($this->_n + 1)); |
$this->_out('/Root ' . $this->_n . ' 0 R'); |
$this->_out('/Info ' . ($this->_n - 1) . ' 0 R'); |
} |
function _endDoc() |
{ |
$this->_putPages(); |
$this->_putResources(); |
/* Info */ |
$this->_newobj(); |
$this->_out('<<'); |
$this->_putInfo(); |
$this->_out('>>'); |
$this->_out('endobj'); |
/* Catalog */ |
$this->_newobj(); |
$this->_out('<<'); |
$this->_putCatalog(); |
$this->_out('>>'); |
$this->_out('endobj'); |
/* Cross-ref */ |
$o = strlen($this->_buffer); |
$this->_out('xref'); |
$this->_out('0 ' . ($this->_n + 1)); |
$this->_out('0000000000 65535 f '); |
for ($i = 1; $i <= $this->_n; $i++) { |
$this->_out(sprintf('%010d 00000 n ', $this->_offsets[$i])); |
} |
/* Trailer */ |
$this->_out('trailer'); |
$this->_out('<<'); |
$this->_putTrailer(); |
$this->_out('>>'); |
$this->_out('startxref'); |
$this->_out($o); |
$this->_out('%%EOF'); |
$this->_state = 3; |
} |
function _beginPage($orientation) |
{ |
$this->_page++; |
$this->_pages[$this->_page] = ''; |
$this->_state = 2; |
$this->x = $this->_left_margin; |
$this->y = $this->_top_margin; |
$this->_last_height = 0; |
/* Page orientation */ |
if (!$orientation) { |
$orientation = $this->_default_orientation; |
} else { |
$orientation = strtoupper($orientation[0]); |
if ($orientation != $this->_default_orientation) { |
$this->_orientation_changes[$this->_page] = true; |
} |
} |
if ($orientation != $this->_current_orientation) { |
/* Change orientation */ |
if ($orientation == 'P') { |
$this->wPt = $this->fwPt; |
$this->hPt = $this->fhPt; |
$this->w = $this->fw; |
$this->h = $this->fh; |
} else { |
$this->wPt = $this->fhPt; |
$this->hPt = $this->fwPt; |
$this->w = $this->fh; |
$this->h = $this->fw; |
} |
$this->_page_break_trigger = $this->h - $this->_break_margin; |
$this->_current_orientation = $orientation; |
} |
} |
function _endPage() |
{ |
/* End of page contents */ |
$this->_state = 1; |
} |
function _newobj() |
{ |
/* Begin a new object */ |
$this->_n++; |
$this->_offsets[$this->_n] = strlen($this->_buffer); |
$this->_out($this->_n . ' 0 obj'); |
} |
function _doUnderline($x, $y, $text) |
{ |
/* Set the rectangle width according to text width. */ |
$width = $this->getStringWidth($text, true); |
/* Set rectangle position and height, using underline position and |
* thickness settings scaled by the font size. */ |
$y = $y + ($this->_current_font['up'] * $this->_font_size_pt / 1000); |
$height = -$this->_current_font['ut'] * $this->_font_size_pt / 1000; |
return sprintf('%.2f %.2f %.2f %.2f re f', $x, $y, $width, $height); |
} |
function _parseJPG($file) |
{ |
/* Extract info from a JPEG file. */ |
$img = @getimagesize($file); |
if (!$img) { |
return $this->raiseError(sprintf('Missing or incorrect image file: %s', $file)); |
} |
if ($img[2] != 2) { |
return $this->raiseError(sprintf('Not a JPEG file: %s', $file)); |
} |
if (!isset($img['channels']) || $img['channels'] == 3) { |
$colspace = 'DeviceRGB'; |
} elseif ($img['channels'] == 4) { |
$colspace = 'DeviceCMYK'; |
} else { |
$colspace = 'DeviceGray'; |
} |
$bpc = isset($img['bits']) ? $img['bits'] : 8; |
/* Read whole file. */ |
$f = fopen($file, 'rb'); |
$data = fread($f, filesize($file)); |
fclose($f); |
return array('w' => $img[0], 'h' => $img[1], 'cs' => $colspace, 'bpc' => $bpc, 'f' => 'DCTDecode', 'data' => $data); |
} |
function _parsePNG($file) |
{ |
/* Extract info from a PNG file. */ |
$f = fopen($file, 'rb'); |
if (!$f) { |
return $this->raiseError(sprintf('Unable to open image file: %s', $file)); |
} |
/* Check signature. */ |
if (fread($f, 8) != chr(137) . 'PNG' . chr(13) . chr(10) . chr(26) . chr(10)) { |
return $this->raiseError(sprintf('Not a PNG file: %s', $file)); |
} |
/* Read header chunk. */ |
fread($f, 4); |
if (fread($f, 4) != 'IHDR') { |
return $this->raiseError(sprintf('Incorrect PNG file: %s', $file)); |
} |
$width = $this->_freadInt($f); |
$height = $this->_freadInt($f); |
$bpc = ord(fread($f, 1)); |
if ($bpc > 8) { |
return $this->raiseError(sprintf('16-bit depth not supported: %s', $file)); |
} |
$ct = ord(fread($f, 1)); |
if ($ct == 0) { |
$colspace = 'DeviceGray'; |
} elseif ($ct == 2) { |
$colspace = 'DeviceRGB'; |
} elseif ($ct == 3) { |
$colspace = 'Indexed'; |
} else { |
return $this->raiseError(sprintf('Alpha channel not supported: %s', $file)); |
} |
if (ord(fread($f, 1)) != 0) { |
return $this->raiseError(sprintf('Unknown compression method: %s', $file)); |
} |
if (ord(fread($f, 1)) != 0) { |
return $this->raiseError(sprintf('Unknown filter method: %s', $file)); |
} |
if (ord(fread($f, 1)) != 0) { |
return $this->raiseError(sprintf('Interlacing not supported: %s', $file)); |
} |
fread($f, 4); |
$parms = '/DecodeParms <</Predictor 15 /Colors ' . ($ct == 2 ? 3 : 1).' /BitsPerComponent ' . $bpc . ' /Columns ' . $width.'>>'; |
/* Scan chunks looking for palette, transparency and image data. */ |
$pal = ''; |
$trns = ''; |
$data = ''; |
do { |
$n = $this->_freadInt($f); |
$type = fread($f, 4); |
if ($type == 'PLTE') { |
/* Read palette */ |
$pal = fread($f, $n); |
fread($f, 4); |
} elseif ($type == 'tRNS') { |
/* Read transparency info */ |
$t = fread($f, $n); |
if ($ct == 0) { |
$trns = array(ord(substr($t, 1, 1))); |
} elseif ($ct == 2) { |
$trns = array(ord(substr($t, 1, 1)), ord(substr($t, 3, 1)), ord(substr($t, 5, 1))); |
} else { |
$pos = strpos($t, chr(0)); |
if (is_int($pos)) { |
$trns = array($pos); |
} |
} |
fread($f, 4); |
} elseif ($type == 'IDAT') { |
/* Read image data block */ |
$data .= fread($f, $n); |
fread($f, 4); |
} elseif ($type == 'IEND') { |
break; |
} else { |
fread($f, $n + 4); |
} |
} while ($n); |
if ($colspace == 'Indexed' && empty($pal)) { |
return $this->raiseError(sprintf('Missing palette in: %s', $file)); |
} |
fclose($f); |
return array('w' => $width, 'h' => $height, 'cs' => $colspace, 'bpc' => $bpc, 'f' => 'FlateDecode', 'parms' => $parms, 'pal' => $pal, 'trns' => $trns, 'data' => $data); |
} |
function _freadInt($f) |
{ |
/* Read a 4-byte integer from file. */ |
$i = ord(fread($f, 1)) << 24; |
$i += ord(fread($f, 1)) << 16; |
$i += ord(fread($f, 1)) << 8; |
$i += ord(fread($f, 1)); |
return $i; |
} |
function _textString($s) |
{ |
/* Format a text string */ |
return '(' . $this->_escape($s) . ')'; |
} |
function _escape($s) |
{ |
/* Add \ before \, ( and ) */ |
return str_replace(array(')','(','\\'), |
array('\\)','\\(','\\\\'), |
$s); |
} |
function _putStream($s) |
{ |
$this->_out('stream'); |
$this->_out($s); |
$this->_out('endstream'); |
} |
function _out($s) |
{ |
/* Add a line to the document. */ |
if ($this->_state == 2) { |
$this->_pages[$this->_page] .= $s . "\n"; |
} else { |
$this->_buffer .= $s . "\n"; |
} |
} |
} |
/trunk/applications/jrest/lib/SpreadsheetProductor.php |
---|
New file |
0,0 → 1,15 |
<?php |
Class SpreadsheetProductor { |
function initSpreadsheet() { |
require_once("Spreadsheet/Excel/Writer.php"); |
} |
} |
?> |
/trunk/applications/jrest/lib/PDFProductor.php |
---|
New file |
0,0 → 1,14 |
<?php |
Class PDFProductor { |
function initPDF() { |
require_once("PDF.php"); |
} |
} |
?> |
/trunk/applications/jrest/lib/Writer.php |
---|
New file |
0,0 → 1,104 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once 'PEAR.php'; |
require_once 'Spreadsheet/Excel/Writer/Workbook.php'; |
/** |
* Class for writing Excel Spreadsheets. This class should change COMPLETELY. |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer extends Spreadsheet_Excel_Writer_Workbook |
{ |
/** |
* The constructor. It just creates a Workbook |
* |
* @param string $filename The optional filename for the Workbook. |
* @return Spreadsheet_Excel_Writer_Workbook The Workbook created |
*/ |
function Spreadsheet_Excel_Writer($filename = '') |
{ |
$this->_filename = $filename; |
$this->Spreadsheet_Excel_Writer_Workbook($filename); |
} |
/** |
* Send HTTP headers for the Excel file. |
* |
* @param string $filename The filename to use for HTTP headers |
* @access public |
*/ |
function send($filename) |
{ |
header("Content-type: application/vnd.ms-excel"); |
header("Content-Disposition: attachment; filename=\"$filename\""); |
header("Expires: 0"); |
header("Cache-Control: must-revalidate, post-check=0,pre-check=0"); |
header("Pragma: public"); |
} |
/** |
* Utility function for writing formulas |
* Converts a cell's coordinates to the A1 format. |
* |
* @access public |
* @static |
* @param integer $row Row for the cell to convert (0-indexed). |
* @param integer $col Column for the cell to convert (0-indexed). |
* @return string The cell identifier in A1 format |
*/ |
function rowcolToCell($row, $col) |
{ |
if ($col > 255) { //maximum column value exceeded |
return new PEAR_Error("Maximum column value exceeded: $col"); |
} |
$int = (int)($col / 26); |
$frac = $col % 26; |
$chr1 = ''; |
if ($int > 0) { |
$chr1 = chr(ord('A') + $int - 1); |
} |
$chr2 = chr(ord('A') + $frac); |
$row++; |
return $chr1 . $chr2 . $row; |
} |
} |
?> |
/trunk/applications/jrest/lib/WdHTMLParser.php |
---|
New file |
0,0 → 1,144 |
<?php |
/** |
* |
* @author Olivier Laviale |
* @see http://www.weirdog.com/blog/php/un-parser-html-des-plus-leger.html |
* |
*/ |
class WdHTMLParser { |
private $encoding; |
private $matches; |
private $escaped; |
private $opened = array(); |
public $malformed; |
public function parse($html, $namespace=NULL, $encoding='utf-8') { |
$this->malformed = false; |
$this->encoding = $encoding; |
// we take care of escaping comments and processing options. they will not be parsed |
// and will end as text nodes |
$html = $this->escapeSpecials($html); |
// in order to create a tree, we first need to split the HTML using the markups, |
// creating a nice flat array of texts and opening and closing markups. |
// |
// the array can be read as follows : |
// |
// i+0 => some text |
// i+1 => '/' for closing markups, nothing otherwise |
// i+2 => the markup it self, without the '<' '>' |
// |
// note that i+2 might end with a '/' indicating an auto-closing markup |
$this->matches = preg_split('#<(/?)' . $namespace . '([^>]*)>#', $html, -1, PREG_SPLIT_DELIM_CAPTURE); |
// the flat representation is now ready, we can create our tree |
$tree = $this->buildTree(); |
// if comments or processing options where escaped, we can |
// safely unescape them now |
if ($this->escaped) { |
$tree = $this->unescapeSpecials($tree); |
} |
return $tree; |
} |
private function escapeSpecials($html) { |
// here we escape comments |
$html = preg_replace_callback('#<\!--.+-->#sU', array($this, 'escapeSpecials_callback'), $html); |
// and processing options |
$html = preg_replace_callback('#<\?.+\?>#sU', array($this, 'escapeSpecials_callback'), $html); |
return $html; |
} |
private function escapeSpecials_callback($m) { |
$this->escaped = true; |
$text = $m[0]; |
$text = str_replace(array('<', '>'), array("\x01", "\x02"), $text); |
return $text; |
} |
private function unescapeSpecials($tree) { |
return is_array($tree) ? array_map(array($this, 'unescapeSpecials'), $tree) : str_replace(array("\x01", "\x02"), array('<', '>'), $tree); |
} |
private function buildTree() { |
$nodes = array(); |
$i = 0; |
$text = NULL; |
while (($value = array_shift($this->matches)) !== NULL) { |
switch ($i++ % 3) { |
case 0: |
// if the trimed value is not empty we preserve the value, |
// otherwise we discard it. |
if (trim($value)){ |
$nodes[] = $value; |
} |
break; |
case 1: |
$closing = ($value == '/'); |
break; |
case 2: |
if (substr($value, -1, 1) == '/') { |
// auto closing |
$nodes[] = $this->parseMarkup(substr($value, 0, -1)); |
} else if ($closing) { |
// closing markup |
$open = array_pop($this->opened); |
if ($value != $open) { |
$this->error($value, $open); |
} |
return $nodes; |
} else { |
// this is an open markup with possible children |
$node = $this->parseMarkup($value); |
// push the markup name into the opened markups |
$this->opened[] = $node['name']; |
// create the node and parse its children |
$node['children'] = $this->buildTree($this->matches); |
$nodes[] = $node; |
} |
break; |
} |
} |
return $nodes; |
} |
public function parseMarkup($markup) { |
// get markup's name |
preg_match('#^[^\s]+#', $markup, $matches); |
$name = $matches[0]; |
// get markup's arguments |
preg_match_all('#\s+([^=]+)\s*=\s*"([^"]+)"#', $markup, $matches, PREG_SET_ORDER); |
// transform the matches into a nice key/value array |
$args = array(); |
foreach ($matches as $m) { |
// we unescape the html entities of the argument's value |
$args[$m[1]] = html_entity_decode($m[2], ENT_QUOTES, $this->encoding); |
} |
return array('name' => $name, 'args' => $args); |
} |
public function error($markup, $expected) { |
$this->malformed = true; |
printf('unexpected closing markup "%s", should be "%s"', $markup, $expected); |
} |
} |
?> |
/trunk/applications/jrest/lib/Log.php |
---|
New file |
0,0 → 1,195 |
<?php |
//declare(encoding='UTF-8'); |
/** |
* Classe permettant de logger des messages dans les fichier situés dans le dossier de log |
* |
* PHP Version 5 |
* |
* @category PHP |
* @package Framework |
* @author aurelien <aurelien@tela-botanica.org> |
* @copyright 2009 Tela-Botanica |
* @license http://www.cecill.info/licences/Licence_CeCILL_V2-fr.txt Licence CECILL |
* @version SVN: <svn_id> |
* @link /doc/framework/ |
*/ |
class Log { |
/** |
* Tableau associatif stockant les descripteurs de fichiers |
*/ |
private static $fichiersLog = array(); |
/** |
* Chemin de base du dossier log de l'application |
*/ |
private static $cheminLogs = ''; |
/** |
* Booleen indiquant si l'on peut correctement écrire dans les fichiers de logs |
*/ |
private static $droitLogger = true; |
/** |
* Zone horaire (pour éviter des avertissements dans les dates) |
*/ |
private static $timeZone = ''; |
/** |
* Taille maximum d'un fichier de log avant que celui ne soit archivé (en octets) |
*/ |
private static $tailleMax = 10000; |
/** |
* séparateur de chemin |
*/ |
private static $sd = DIRECTORY_SEPARATOR; |
/** |
* Extension des fichiers de log |
*/ |
private static $ext = '.log'; |
/** |
* La classe registre se contient elle-même, (pour le pattern singleton) |
*/ |
private static $log; |
/** |
* Constructeur par défaut, privé, car on accède à la classe par le getInstance |
*/ |
private function __construct() { |
self::$sd = $sd; |
// gestion de la timezone pour éviter des erreurs |
if(function_exists("date_default_timezone_set") and function_exists("date_default_timezone_get")) { |
date_default_timezone_set(self::$timeZone); |
} |
if(!is_dir(self::$cheminLogs) || !is_writable(self::$cheminLogs)) { |
self::desactiverEcriture(); |
} |
} |
public static function setCheminLog($nouveauCheminLogs) { |
self::$cheminLogs = $nouveauCheminLogs; |
} |
public static function getCheminLog() { |
return self::$cheminLogs; |
} |
public static function setTimeZone($NouvelleTimeZone) { |
self::$timeZone = $NouvelleTimeZone; |
} |
public static function setTailleMax($nouvelleTailleMax) { |
self::$tailleMax = $nouvelleTailleMax; |
} |
/** |
* Fonction qui renvoie l'instance de classe en assurant son unicité, c'est l'unique méthode qui doit être |
* utilisée pour récupérer l'objet Registre |
* @return Log le gestionnaire de log en cours |
*/ |
public static function getInstance() { |
if (self::$log instanceof Log) { |
return self::$log; |
} |
self::$log = new Log(); |
return self::$log; |
} |
/** |
* Ajoute une entrée au log spécifié par le paramètre $nomFichier |
* @param string $nomFichier le nom du fichier dans lequel écrire |
*/ |
public static function ajouterEntree($nomFichier,$entree,$mode='a+') { |
if(self::$droitLogger) { |
$date = "\n"."\n".date('d m Y H:i')."\n" ; |
// si le fichier est déjà dans le tableau et qu'on peut y écrire |
if(self::verifierOuvrirFichier($nomFichier,$mode)) { |
// on y écrit le message de log |
fwrite(self::$fichiersLog[$nomFichier],$date.$entree); |
// on vérifie si le fichier ne dépasse pas la taille maximale |
self::verifierTailleFichierOuArchiver($nomFichier); |
} else { |
// sinon on interdit l'écriture |
self::desactiverEcriture($nomFichier); |
} |
} |
} |
/** |
* Vide un fichier log indiqué |
* @param string $nomFichier le nom du fichier à vider |
*/ |
public static function viderLog($nomFichier) { |
ajouterEntree($nomFichier,'','w'); |
} |
/** |
* Vérifie la présence d'un fichier dans le tableau, ses droits d'écriture, |
* l'ouvre si nécessaire |
* @param string $nomFichier le nom du fichier dont on doit vérifier la présence |
* @return boolean true si le fichier est ouvert ou maintenant accessible, false sinon |
*/ |
public static function verifierOuvrirFichier($nomFichier,$mode) { |
// le fichier est il déjà ouvert ? |
if(in_array($nomFichier,self::$fichiersLog)) { |
// si oui peut on y écrire ? |
if(is_writable(self::$cheminLogs.$nomFichier.self::$ext)) { |
// si oui on renvoie le descripteur |
return true; |
} |
return false; |
} else { |
// sinon on l'ouvre |
$fp = @fopen(self::$cheminLogs.$nomFichier.self::$ext,$mode); |
// si l'ouverture a réussi et si le fichier a les droits d'écriture |
if($fp && is_writable(self::$cheminLogs.$nomFichier.self::$ext)) { |
// si oui on renvoie le descripteur qu'on ajoute au tableau |
self::$fichiersLog[$nomFichier] = $fp; |
return true; |
} |
return false; |
} |
} |
/** |
* Vérifie la taille d'un fichier donné et si celle ci est trop importante |
* archive le fichier de log |
* @param string $nomFichier nom du fichier à vérifier |
*/ |
private static function verifierTailleFichierOuArchiver($nomFichier) { |
if(filesize(self::$cheminLogs.$nomFichier.self::$ext) > self::$tailleMax) { |
rename(self::$cheminLogs.$nomFichier.self::$ext,self::$cheminLogs.$nomFichier.date('d_m_Y_H:i').self::$ext); |
self::ajouterEntree($nomFichier,''); |
} |
} |
/** |
* Désactive l'écriture du log et envoie un message au gestionnaire d'erreurs |
* @param string $nomFichier le nom du fichier qui a causé l'erreur |
*/ |
private static function desactiverEcriture($nomFichier = '') { |
self::$droitLogger = false; |
if($nomFichier != '') { |
$fichierDossier = 'fichier '.$nomFichier ; |
} else { |
$fichierDossier = 'dossier des logs'; |
} |
} |
/** |
* destructeur de classe, ferme les descripteurs ouverts |
*/ |
public function __destruct() { |
foreach(self::$fichiersLog as $nomFichier => $fp) { |
fclose($fp); |
} |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer.php |
---|
New file |
0,0 → 1,75 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once('PEAR.php'); |
require_once('Writer/Workbook.php'); |
/** |
* Class for writing Excel Spreadsheets. This class should change COMPLETELY. |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer extends Spreadsheet_Excel_Writer_Workbook |
{ |
/** |
* The constructor. It just creates a Workbook |
* |
* @param string $filename The optional filename for the Workbook. |
* @return Spreadsheet_Excel_Writer_Workbook The Workbook created |
*/ |
function Spreadsheet_Excel_Writer($filename = '') |
{ |
$this->_filename = $filename; |
$this->Spreadsheet_Excel_Writer_Workbook($filename); |
} |
/** |
* Send HTTP headers for the Excel file. |
* |
* @param string $filename The filename to use for HTTP headers |
* @access public |
*/ |
function send($filename) |
{ |
header("Content-type: application/vnd.ms-excel"); |
header("Content-Disposition: attachment; filename=$filename"); |
header("Expires: 0"); |
header("Cache-Control: must-revalidate, post-check=0,pre-check=0"); |
header("Pragma: public"); |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer/BIFFwriter.php |
---|
New file |
0,0 → 1,235 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* The majority of this is _NOT_ my code. I simply ported it from the |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once('PEAR.php'); |
/** |
* Class for writing Excel BIFF records. |
* |
* From "MICROSOFT EXCEL BINARY FILE FORMAT" by Mark O'Brien (Microsoft Corporation): |
* |
* BIFF (BInary File Format) is the file format in which Excel documents are |
* saved on disk. A BIFF file is a complete description of an Excel document. |
* BIFF files consist of sequences of variable-length records. There are many |
* different types of BIFF records. For example, one record type describes a |
* formula entered into a cell; one describes the size and location of a |
* window into a document; another describes a picture format. |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer_BIFFwriter extends PEAR |
{ |
/** |
* The BIFF/Excel version (5). |
* @var integer |
*/ |
var $_BIFF_version = 0x0500; |
/** |
* The byte order of this architecture. 0 => little endian, 1 => big endian |
* @var integer |
*/ |
var $_byte_order; |
/** |
* The string containing the data of the BIFF stream |
* @var string |
*/ |
var $_data; |
/** |
* The size of the data in bytes. Should be the same as strlen($this->_data) |
* @var integer |
*/ |
var $_datasize; |
/** |
* The maximun length for a BIFF record. See _addContinue() |
* @var integer |
* @see _addContinue() |
*/ |
var $_limit; |
/** |
* Constructor |
* |
* @access public |
*/ |
function Spreadsheet_Excel_Writer_BIFFwriter() |
{ |
$this->_byte_order = ''; |
$this->_data = ''; |
$this->_datasize = 0; |
$this->_limit = 2080; |
// Set the byte order |
$this->_setByteOrder(); |
} |
/** |
* Determine the byte order and store it as class data to avoid |
* recalculating it for each call to new(). |
* |
* @access private |
*/ |
function _setByteOrder() |
{ |
if ($this->_byte_order == '') |
{ |
// Check if "pack" gives the required IEEE 64bit float |
$teststr = pack("d", 1.2345); |
$number = pack("C8", 0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F); |
if ($number == $teststr) { |
$byte_order = 0; // Little Endian |
} |
elseif ($number == strrev($teststr)){ |
$byte_order = 1; // Big Endian |
} |
else { |
// Give up. I'll fix this in a later version. |
$this->raiseError("Required floating point format not supported ". |
"on this platform."); |
} |
} |
$this->_byte_order = $byte_order; |
} |
/** |
* General storage function |
* |
* @param string $data binary data to prepend |
* @access private |
*/ |
function _prepend($data) |
{ |
if (strlen($data) > $this->_limit) { |
$data = $this->_addContinue($data); |
} |
$this->_data = $data.$this->_data; |
$this->_datasize += strlen($data); |
} |
/** |
* General storage function |
* |
* @param string $data binary data to append |
* @access private |
*/ |
function _append($data) |
{ |
if (strlen($data) > $this->_limit) { |
$data = $this->_addContinue($data); |
} |
$this->_data = $this->_data.$data; |
$this->_datasize += strlen($data); |
} |
/** |
* Writes Excel BOF record to indicate the beginning of a stream or |
* sub-stream in the BIFF file. |
* |
* @param integer $type type of BIFF file to write: 0x0005 Workbook, 0x0010 Worksheet. |
* @access private |
*/ |
function _storeBof($type) |
{ |
$record = 0x0809; // Record identifier |
$length = 0x0008; // Number of bytes to follow |
$version = $this->_BIFF_version; |
// According to the SDK $build and $year should be set to zero. |
// However, this throws a warning in Excel 5. So, use these |
// magic numbers. |
$build = 0x096C; |
$year = 0x07C9; |
$header = pack("vv", $record, $length); |
$data = pack("vvvv", $version, $type, $build, $year); |
$this->_prepend($header.$data); |
} |
/** |
* Writes Excel EOF record to indicate the end of a BIFF stream. |
* |
* @access private |
*/ |
function _storeEof() |
{ |
$record = 0x000A; // Record identifier |
$length = 0x0000; // Number of bytes to follow |
$header = pack("vv", $record, $length); |
$this->_append($header); |
} |
/** |
* Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In |
* Excel 97 the limit is 8228 bytes. Records that are longer than these limits |
* must be split up into CONTINUE blocks. |
* |
* This function takes a long BIFF record and inserts CONTINUE records as |
* necessary. |
* |
* @param string $data The original binary data to be written |
* @return string A very convenient string of continue blocks |
* @access private |
*/ |
function _addContinue($data) |
{ |
$limit = $this->_limit; |
$record = 0x003C; // Record identifier |
// The first 2080/8224 bytes remain intact. However, we have to change |
// the length field of the record. |
$tmp = substr($data, 0, 2).pack("v", $limit-4).substr($data, 4, $limit - 4); |
$header = pack("vv", $record, $limit); // Headers for continue records |
// Retrieve chunks of 2080/8224 bytes +4 for the header. |
for($i = $limit; $i < strlen($data) - $limit; $i += $limit) |
{ |
$tmp .= $header; |
$tmp .= substr($data, $i, $limit); |
} |
// Retrieve the last chunk of data |
$header = pack("vv", $record, strlen($data) - $i); |
$tmp .= $header; |
$tmp .= substr($data,$i,strlen($data) - $i); |
return($tmp); |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer/Format.php |
---|
New file |
0,0 → 1,940 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* The majority of this is _NOT_ my code. I simply ported it from the |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once('PEAR.php'); |
/** |
* Class for generating Excel XF records (formats) |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer_Format extends PEAR |
{ |
/** |
* The index given by the workbook when creating a new format. |
* @var integer |
*/ |
var $_xf_index; |
/** |
* Index to the FONT record. |
* @var integer |
*/ |
var $font_index; |
/** |
* The font name (ASCII). |
* @var string |
*/ |
var $_font_name; |
/** |
* Height of font (1/20 of a point) |
* @var integer |
*/ |
var $_size; |
/** |
* Bold style |
* @var integer |
*/ |
var $_bold; |
/** |
* Bit specifiying if the font is italic. |
* @var integer |
*/ |
var $_italic; |
/** |
* Index to the cell's color |
* @var integer |
*/ |
var $_color; |
/** |
* The text underline property |
* @var integer |
*/ |
var $_underline; |
/** |
* Bit specifiying if the font has strikeout. |
* @var integer |
*/ |
var $_font_strikeout; |
/** |
* Bit specifiying if the font has outline. |
* @var integer |
*/ |
var $_font_outline; |
/** |
* Bit specifiying if the font has shadow. |
* @var integer |
*/ |
var $_font_shadow; |
/** |
* 2 bytes specifiying the script type for the font. |
* @var integer |
*/ |
var $_font_script; |
/** |
* Byte specifiying the font family. |
* @var integer |
*/ |
var $_font_family; |
/** |
* Byte specifiying the font charset. |
* @var integer |
*/ |
var $_font_charset; |
/** |
* An index (2 bytes) to a FORMAT record (number format). |
* @var integer |
*/ |
var $_num_format; |
/** |
* Bit specifying if formulas are hidden. |
* @var integer |
*/ |
var $_hidden; |
/** |
* Bit specifying if the cell is locked. |
* @var integer |
*/ |
var $_locked; |
/** |
* The three bits specifying the text horizontal alignment. |
* @var integer |
*/ |
var $_text_h_align; |
/** |
* Bit specifying if the text is wrapped at the right border. |
* @var integer |
*/ |
var $_text_wrap; |
/** |
* The three bits specifying the text vertical alignment. |
* @var integer |
*/ |
var $_text_v_align; |
/** |
* 1 bit, apparently not used. |
* @var integer |
*/ |
var $_text_justlast; |
/** |
* The two bits specifying the text rotation. |
* @var integer |
*/ |
var $_rotation; |
/** |
* The cell's foreground color. |
* @var integer |
*/ |
var $_fg_color; |
/** |
* The cell's background color. |
* @var integer |
*/ |
var $_bg_color; |
/** |
* The cell's background fill pattern. |
* @var integer |
*/ |
var $_pattern; |
/** |
* Style of the bottom border of the cell |
* @var integer |
*/ |
var $_bottom; |
/** |
* Color of the bottom border of the cell. |
* @var integer |
*/ |
var $_bottom_color; |
/** |
* Style of the top border of the cell |
* @var integer |
*/ |
var $_top; |
/** |
* Color of the top border of the cell. |
* @var integer |
*/ |
var $_top_color; |
/** |
* Style of the left border of the cell |
* @var integer |
*/ |
var $_left; |
/** |
* Color of the left border of the cell. |
* @var integer |
*/ |
var $_left_color; |
/** |
* Style of the right border of the cell |
* @var integer |
*/ |
var $_right; |
/** |
* Color of the right border of the cell. |
* @var integer |
*/ |
var $_right_color; |
/** |
* Constructor |
* |
* @access public |
* @param integer $index the XF index for the format. |
* @param array $properties array with properties to be set on initialization. |
*/ |
function Spreadsheet_Excel_Writer_Format($index = 0,$properties = array()) |
{ |
$this->_xf_index = $index; |
$this->font_index = 0; |
$this->_font_name = 'Arial'; |
$this->_size = 10; |
$this->_bold = 0x0190; |
$this->_italic = 0; |
$this->_color = 0x7FFF; |
$this->_underline = 0; |
$this->_font_strikeout = 0; |
$this->_font_outline = 0; |
$this->_font_shadow = 0; |
$this->_font_script = 0; |
$this->_font_family = 0; |
$this->_font_charset = 0; |
$this->_num_format = 0; |
$this->_hidden = 0; |
$this->_locked = 1; |
$this->_text_h_align = 0; |
$this->_text_wrap = 0; |
$this->_text_v_align = 2; |
$this->_text_justlast = 0; |
$this->_rotation = 0; |
$this->_fg_color = 0x40; |
$this->_bg_color = 0x41; |
$this->_pattern = 0; |
$this->_bottom = 0; |
$this->_top = 0; |
$this->_left = 0; |
$this->_right = 0; |
$this->_bottom_color = 0x40; |
$this->_top_color = 0x40; |
$this->_left_color = 0x40; |
$this->_right_color = 0x40; |
// Set properties passed to Spreadsheet_Excel_Writer_Workbook::addFormat() |
foreach($properties as $property => $value) |
{ |
if(method_exists($this,'set'.ucwords($property))) |
{ |
$method_name = 'set'.ucwords($property); |
$this->$method_name($value); |
} |
} |
} |
/** |
* Generate an Excel BIFF XF record (style or cell). |
* |
* @param string $style The type of the XF record ('style' or 'cell'). |
* @return string The XF record |
*/ |
function getXf($style) |
{ |
// Set the type of the XF record and some of the attributes. |
if ($style == "style") { |
$style = 0xFFF5; |
} |
else { |
$style = $this->_locked; |
$style |= $this->_hidden << 1; |
} |
// Flags to indicate if attributes have been set. |
$atr_num = ($this->_num_format != 0)?1:0; |
$atr_fnt = ($this->font_index != 0)?1:0; |
$atr_alc = ($this->_text_wrap)?1:0; |
$atr_bdr = ($this->_bottom || |
$this->_top || |
$this->_left || |
$this->_right)?1:0; |
$atr_pat = (($this->_fg_color != 0x40) || |
($this->_bg_color != 0x41) || |
$this->_pattern)?1:0; |
$atr_prot = 0; |
// Zero the default border colour if the border has not been set. |
if ($this->_bottom == 0) { |
$this->_bottom_color = 0; |
} |
if ($this->_top == 0) { |
$this->_top_color = 0; |
} |
if ($this->_right == 0) { |
$this->_right_color = 0; |
} |
if ($this->_left == 0) { |
$this->_left_color = 0; |
} |
$record = 0x00E0; // Record identifier |
$length = 0x0010; // Number of bytes to follow |
$ifnt = $this->font_index; // Index to FONT record |
$ifmt = $this->_num_format; // Index to FORMAT record |
$align = $this->_text_h_align; // Alignment |
$align |= $this->_text_wrap << 3; |
$align |= $this->_text_v_align << 4; |
$align |= $this->_text_justlast << 7; |
$align |= $this->_rotation << 8; |
$align |= $atr_num << 10; |
$align |= $atr_fnt << 11; |
$align |= $atr_alc << 12; |
$align |= $atr_bdr << 13; |
$align |= $atr_pat << 14; |
$align |= $atr_prot << 15; |
$icv = $this->_fg_color; // fg and bg pattern colors |
$icv |= $this->_bg_color << 7; |
$fill = $this->_pattern; // Fill and border line style |
$fill |= $this->_bottom << 6; |
$fill |= $this->_bottom_color << 9; |
$border1 = $this->_top; // Border line style and color |
$border1 |= $this->_left << 3; |
$border1 |= $this->_right << 6; |
$border1 |= $this->_top_color << 9; |
$border2 = $this->_left_color; // Border color |
$border2 |= $this->_right_color << 7; |
$header = pack("vv", $record, $length); |
$data = pack("vvvvvvvv", $ifnt, $ifmt, $style, $align, |
$icv, $fill, |
$border1, $border2); |
return($header.$data); |
} |
/** |
* Generate an Excel BIFF FONT record. |
* |
* @return string The FONT record |
*/ |
function getFont() |
{ |
$dyHeight = $this->_size * 20; // Height of font (1/20 of a point) |
$icv = $this->_color; // Index to color palette |
$bls = $this->_bold; // Bold style |
$sss = $this->_font_script; // Superscript/subscript |
$uls = $this->_underline; // Underline |
$bFamily = $this->_font_family; // Font family |
$bCharSet = $this->_font_charset; // Character set |
$rgch = $this->_font_name; // Font name |
$cch = strlen($rgch); // Length of font name |
$record = 0x31; // Record identifier |
$length = 0x0F + $cch; // Record length |
$reserved = 0x00; // Reserved |
$grbit = 0x00; // Font attributes |
if ($this->_italic) { |
$grbit |= 0x02; |
} |
if ($this->_font_strikeout) { |
$grbit |= 0x08; |
} |
if ($this->_font_outline) { |
$grbit |= 0x10; |
} |
if ($this->_font_shadow) { |
$grbit |= 0x20; |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvvvvCCCCC", $dyHeight, $grbit, $icv, $bls, |
$sss, $uls, $bFamily, |
$bCharSet, $reserved, $cch); |
return($header . $data. $this->_font_name); |
} |
/** |
* Returns a unique hash key for a font. |
* Used by Spreadsheet_Excel_Writer_Workbook::_storeAllFonts() |
* |
* The elements that form the key are arranged to increase the probability of |
* generating a unique key. Elements that hold a large range of numbers |
* (eg. _color) are placed between two binary elements such as _italic |
* |
* @return string A key for this font |
*/ |
function getFontKey() |
{ |
$key = "$this->_font_name$this->_size"; |
$key .= "$this->_font_script$this->_underline"; |
$key .= "$this->_font_strikeout$this->_bold$this->_font_outline"; |
$key .= "$this->_font_family$this->_font_charset"; |
$key .= "$this->_font_shadow$this->_color$this->_italic"; |
$key = str_replace(" ","_",$key); |
return ($key); |
} |
/** |
* Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF() |
* |
* @return integer The index for the XF record |
*/ |
function getXfIndex() |
{ |
return($this->_xf_index); |
} |
/** |
* Used in conjunction with the set_xxx_color methods to convert a color |
* string into a number. Color range is 0..63 but we will restrict it |
* to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15. |
* |
* @access private |
* @param string $name_color name of the color (i.e.: 'blue', 'red', etc..). Optional. |
* @return integer The color index |
*/ |
function _getColor($name_color = '') |
{ |
$colors = array( |
'aqua' => 0x0F, |
'cyan' => 0x0F, |
'black' => 0x08, |
'blue' => 0x0C, |
'brown' => 0x10, |
'magenta' => 0x0E, |
'fuchsia' => 0x0E, |
'gray' => 0x17, |
'grey' => 0x17, |
'green' => 0x11, |
'lime' => 0x0B, |
'navy' => 0x12, |
'orange' => 0x35, |
'purple' => 0x14, |
'red' => 0x0A, |
'silver' => 0x16, |
'white' => 0x09, |
'yellow' => 0x0D |
); |
// Return the default color, 0x7FFF, if undef, |
if($name_color == '') { |
return(0x7FFF); |
} |
// or the color string converted to an integer, |
if(isset($colors[$name_color])) { |
return($colors[$name_color]); |
} |
// or the default color if string is unrecognised, |
if(preg_match("/\D/",$name_color)) { |
return(0x7FFF); |
} |
// or an index < 8 mapped into the correct range, |
if($name_color < 8) { |
return($name_color + 8); |
} |
// or the default color if arg is outside range, |
if($name_color > 63) { |
return(0x7FFF); |
} |
// or an integer in the valid range |
return($name_color); |
} |
/** |
* Set cell alignment. |
* |
* @access public |
* @param string $location alignment for the cell ('left', 'right', etc...). |
*/ |
function setAlign($location) |
{ |
if (preg_match("/\d/",$location)) { |
return; // Ignore numbers |
} |
$location = strtolower($location); |
if ($location == 'left') { |
$this->_text_h_align = 1; |
} |
if ($location == 'centre') { |
$this->_text_h_align = 2; |
} |
if ($location == 'center') { |
$this->_text_h_align = 2; |
} |
if ($location == 'right') { |
$this->_text_h_align = 3; |
} |
if ($location == 'fill') { |
$this->_text_h_align = 4; |
} |
if ($location == 'justify') { |
$this->_text_h_align = 5; |
} |
if ($location == 'merge') { |
$this->_text_h_align = 6; |
} |
if ($location == 'equal_space') { // For T.K. |
$this->_text_h_align = 7; |
} |
if ($location == 'top') { |
$this->_text_v_align = 0; |
} |
if ($location == 'vcentre') { |
$this->_text_v_align = 1; |
} |
if ($location == 'vcenter') { |
$this->_text_v_align = 1; |
} |
if ($location == 'bottom') { |
$this->_text_v_align = 2; |
} |
if ($location == 'vjustify') { |
$this->_text_v_align = 3; |
} |
if ($location == 'vequal_space') { // For T.K. |
$this->_text_v_align = 4; |
} |
} |
/** |
* This is an alias for the unintuitive setAlign('merge') |
* |
* @access public |
*/ |
function setMerge() |
{ |
$this->setAlign('merge'); |
} |
/** |
* Sets the boldness of the text. |
* Bold has a range 100..1000. |
* 0 (400) is normal. 1 (700) is bold. |
* |
* @access public |
* @param integer $weight Weight for the text, 0 maps to 400 (normal text), |
1 maps to 700 (bold text). Valid range is: 100-1000. |
It's Optional, default is 1 (bold). |
*/ |
function setBold($weight = 1) |
{ |
if($weight == 1) { |
$weight = 0x2BC; // Bold text |
} |
if($weight == 0) { |
$weight = 0x190; // Normal text |
} |
if($weight < 0x064) { |
$weight = 0x190; // Lower bound |
} |
if($weight > 0x3E8) { |
$weight = 0x190; // Upper bound |
} |
$this->_bold = $weight; |
} |
/************************************ |
* FUNCTIONS FOR SETTING CELLS BORDERS |
*/ |
/** |
* Sets the width for the bottom border of the cell |
* |
* @access public |
* @param integer $style style of the cell border. 1 => thin, 2 => thick. |
*/ |
function setBottom($style) |
{ |
$this->_bottom = $style; |
} |
/** |
* Sets the width for the top border of the cell |
* |
* @access public |
* @param integer $style style of the cell top border. 1 => thin, 2 => thick. |
*/ |
function setTop($style) |
{ |
$this->_top = $style; |
} |
/** |
* Sets the width for the left border of the cell |
* |
* @access public |
* @param integer $style style of the cell left border. 1 => thin, 2 => thick. |
*/ |
function setLeft($style) |
{ |
$this->_left = $style; |
} |
/** |
* Sets the width for the right border of the cell |
* |
* @access public |
* @param integer $style style of the cell right border. 1 => thin, 2 => thick. |
*/ |
function setRight($style) |
{ |
$this->_right = $style; |
} |
/** |
* Set cells borders to the same style |
* |
* @access public |
* @param integer $style style to apply for all cell borders. 1 => thin, 2 => thick. |
*/ |
function setBorder($style) |
{ |
$this->setBottom($style); |
$this->setTop($style); |
$this->setLeft($style); |
$this->setRight($style); |
} |
/******************************************* |
* FUNCTIONS FOR SETTING CELLS BORDERS COLORS |
*/ |
/** |
* Sets all the cell's borders to the same color |
* |
* @access public |
* @param mixed $color The color we are setting. Either a string (like 'blue'), |
* or an integer (range is [8...63]). |
*/ |
function setBorderColor($color) |
{ |
$this->setBottomColor($color); |
$this->setTopColor($color); |
$this->setLeftColor($color); |
$this->setRightColor($color); |
} |
/** |
* Sets the cell's bottom border color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setBottomColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_bottom_color = $value; |
} |
/** |
* Sets the cell's top border color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setTopColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_top_color = $value; |
} |
/** |
* Sets the cell's left border color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setLeftColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_left_color = $value; |
} |
/** |
* Sets the cell's right border color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setRightColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_right_color = $value; |
} |
/** |
* Sets the cell's foreground color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setFgColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_fg_color = $value; |
} |
/** |
* Sets the cell's background color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setBgColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_bg_color = $value; |
} |
/** |
* Sets the cell's color |
* |
* @access public |
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]). |
*/ |
function setColor($color) |
{ |
$value = $this->_getColor($color); |
$this->_color = $value; |
} |
/** |
* Sets the fill pattern attribute of a cell |
* |
* @access public |
* @param integer $arg Optional. Defaults to 1. Meaningful values are: 0-18, |
* 0 meaning no background. |
*/ |
function setPattern($arg = 1) |
{ |
$this->_pattern = $arg; |
} |
/** |
* Sets the underline of the text |
* |
* @access public |
* @param integer $underline The value for underline. Possible values are: |
* 1 => underline, 2 => double underline. |
*/ |
function setUnderline($underline) |
{ |
$this->_underline = $underline; |
} |
/** |
* Sets the font style as italic |
* |
* @access public |
*/ |
function setItalic() |
{ |
$this->_italic = 1; |
} |
/** |
* Sets the font size |
* |
* @access public |
* @param integer $size The font size (in pixels I think). |
*/ |
function setSize($size) |
{ |
$this->_size = $size; |
} |
/** |
* Sets text wrapping |
* |
* @access public |
*/ |
function setTextWrap() |
{ |
$this->_text_wrap = 1; |
} |
/** |
* Sets the orientation of the text |
* |
* @access public |
* @param integer $angle The rotation angle for the text (clockwise). Possible |
values are: 0, 90, 270 and -1 for stacking top-to-bottom. |
*/ |
function setTextRotation($angle) |
{ |
switch ($angle) |
{ |
case 0: |
$this->_rotation = 0; |
break; |
case 90: |
$this->_rotation = 3; |
break; |
case 270: |
$this->_rotation = 2; |
break; |
case -1: |
$this->_rotation = 1; |
break; |
default : |
$this->raiseError("Invalid value for angle.". |
" Possible values are: 0, 90, 270 and -1 ". |
"for stacking top-to-bottom."); |
$this->_rotation = 0; |
break; |
} |
} |
/** |
* Sets the numeric format. |
* It can be date, time, currency, etc... |
* |
* @access public |
* @param integer $num_format The numeric format. |
*/ |
function setNumFormat($num_format) |
{ |
$this->_num_format = $num_format; |
} |
/** |
* Sets font as strikeout. |
* |
* @access public |
*/ |
function setStrikeOut() |
{ |
$this->_font_strikeout = 1; |
} |
/** |
* Sets outlining for a font. |
* |
* @access public |
*/ |
function setOutLine() |
{ |
$this->_font_outline = 1; |
} |
/** |
* Sets font as shadow. |
* |
* @access public |
*/ |
function setShadow() |
{ |
$this->_font_shadow = 1; |
} |
/** |
* Sets the script type of the text |
* |
* @access public |
* @param integer $script The value for script type. Possible values are: |
* 1 => superscript, 2 => subscript. |
*/ |
function setScript($script) |
{ |
$this->_font_script = $script; |
} |
/** |
* Unlocks a cell. Useful for unprotecting particular cells of a protected sheet. |
* |
* @access public |
*/ |
function setUnLocked() |
{ |
$this->_locked = 0; |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer/Worksheet.php |
---|
New file |
0,0 → 1,3095 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* The majority of this is _NOT_ my code. I simply ported it from the |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once('Parser.php'); |
require_once('BIFFwriter.php'); |
/** |
* Class for generating Excel Spreadsheets |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwriter |
{ |
/** |
* Name of the Worksheet |
* @var string |
*/ |
var $name; |
/** |
* Index for the Worksheet |
* @var integer |
*/ |
var $index; |
/** |
* Reference to the (default) Format object for URLs |
* @var object Format |
*/ |
var $_url_format; |
/** |
* Reference to the parser used for parsing formulas |
* @var object Format |
*/ |
var $_parser; |
/** |
* Filehandle to the temporary file for storing data |
* @var resource |
*/ |
var $_filehandle; |
/** |
* Boolean indicating if we are using a temporary file for storing data |
* @var bool |
*/ |
var $_using_tmpfile; |
/** |
* Maximum number of rows for an Excel spreadsheet (BIFF5) |
* @var integer |
*/ |
var $_xls_rowmax; |
/** |
* Maximum number of columns for an Excel spreadsheet (BIFF5) |
* @var integer |
*/ |
var $_xls_colmax; |
/** |
* Maximum number of characters for a string (LABEL record in BIFF5) |
* @var integer |
*/ |
var $_xls_strmax; |
/** |
* First row for the DIMENSIONS record |
* @var integer |
* @see storeDimensions() |
*/ |
var $_dim_rowmin; |
/** |
* Last row for the DIMENSIONS record |
* @var integer |
* @see storeDimensions() |
*/ |
var $_dim_rowmax; |
/** |
* First column for the DIMENSIONS record |
* @var integer |
* @see storeDimensions() |
*/ |
var $_dim_colmin; |
/** |
* Last column for the DIMENSIONS record |
* @var integer |
* @see storeDimensions() |
*/ |
var $_dim_colmax; |
/** |
* Array containing format information for columns |
* @var array |
*/ |
var $_colinfo; |
/** |
* Array containing the selected area for the worksheet |
* @var array |
*/ |
var $_selection; |
/** |
* Array containing the panes for the worksheet |
* @var array |
*/ |
var $_panes; |
/** |
* The active pane for the worksheet |
* @var integer |
*/ |
var $_active_pane; |
/** |
* Bit specifying if panes are frozen |
* @var integer |
*/ |
var $_frozen; |
/** |
* Bit specifying if the worksheet is selected |
* @var integer |
*/ |
var $selected; |
/** |
* The paper size (for printing) (DOCUMENT!!!) |
* @var integer |
*/ |
var $_paper_size; |
/** |
* Bit specifying paper orientation (for printing). 0 => landscape, 1 => portrait |
* @var integer |
*/ |
var $_orientation; |
/** |
* The page header caption |
* @var string |
*/ |
var $_header; |
/** |
* The page footer caption |
* @var string |
*/ |
var $_footer; |
/** |
* The horizontal centering value for the page |
* @var integer |
*/ |
var $_hcenter; |
/** |
* The vertical centering value for the page |
* @var integer |
*/ |
var $_vcenter; |
/** |
* The margin for the header |
* @var float |
*/ |
var $_margin_head; |
/** |
* The margin for the footer |
* @var float |
*/ |
var $_margin_foot; |
/** |
* The left margin for the worksheet in inches |
* @var float |
*/ |
var $_margin_left; |
/** |
* The right margin for the worksheet in inches |
* @var float |
*/ |
var $_margin_right; |
/** |
* The top margin for the worksheet in inches |
* @var float |
*/ |
var $_margin_top; |
/** |
* The bottom margin for the worksheet in inches |
* @var float |
*/ |
var $_margin_bottom; |
/** |
* First row to reapeat on each printed page |
* @var integer |
*/ |
var $title_rowmin; |
/** |
* Last row to reapeat on each printed page |
* @var integer |
*/ |
var $title_rowmax; |
/** |
* First column to reapeat on each printed page |
* @var integer |
*/ |
var $title_colmin; |
/** |
* First row of the area to print |
* @var integer |
*/ |
var $print_rowmin; |
/** |
* Last row to of the area to print |
* @var integer |
*/ |
var $print_rowmax; |
/** |
* First column of the area to print |
* @var integer |
*/ |
var $print_colmin; |
/** |
* Last column of the area to print |
* @var integer |
*/ |
var $print_colmax; |
/** |
* Constructor |
* |
* @param string $name The name of the new worksheet |
* @param integer $index The index of the new worksheet |
* @param mixed &$activesheet The current activesheet of the workbook we belong to |
* @param mixed &$firstsheet The first worksheet in the workbook we belong to |
* @param mixed &$url_format The default format for hyperlinks |
* @param mixed &$parser The formula parser created for the Workbook |
*/ |
function Spreadsheet_Excel_Writer_Worksheet($name, $index, &$activesheet, |
&$firstsheet, &$url_format, |
&$parser) |
{ |
// It needs to call its parent's constructor explicitly |
$this->Spreadsheet_Excel_Writer_BIFFwriter(); |
$rowmax = 65536; // 16384 in Excel 5 |
$colmax = 256; |
$this->name = $name; |
$this->index = $index; |
$this->activesheet = &$activesheet; |
$this->firstsheet = &$firstsheet; |
$this->_url_format = &$url_format; |
$this->_parser = &$parser; |
//$this->ext_sheets = array(); |
$this->_filehandle = ""; |
$this->_using_tmpfile = true; |
//$this->fileclosed = 0; |
//$this->offset = 0; |
$this->_xls_rowmax = $rowmax; |
$this->_xls_colmax = $colmax; |
$this->_xls_strmax = 255; |
$this->_dim_rowmin = $rowmax + 1; |
$this->_dim_rowmax = 0; |
$this->_dim_colmin = $colmax + 1; |
$this->_dim_colmax = 0; |
$this->_colinfo = array(); |
$this->_selection = array(0,0,0,0); |
$this->_panes = array(); |
$this->_active_pane = 3; |
$this->_frozen = 0; |
$this->selected = 0; |
$this->_paper_size = 0x0; |
$this->_orientation = 0x1; |
$this->_header = ''; |
$this->_footer = ''; |
$this->_hcenter = 0; |
$this->_vcenter = 0; |
$this->_margin_head = 0.50; |
$this->_margin_foot = 0.50; |
$this->_margin_left = 0.75; |
$this->_margin_right = 0.75; |
$this->_margin_top = 1.00; |
$this->_margin_bottom = 1.00; |
$this->title_rowmin = NULL; |
$this->title_rowmax = NULL; |
$this->title_colmin = NULL; |
$this->title_colmax = NULL; |
$this->print_rowmin = NULL; |
$this->print_rowmax = NULL; |
$this->print_colmin = NULL; |
$this->print_colmax = NULL; |
$this->_print_gridlines = 1; |
$this->_print_headers = 0; |
$this->_fit_page = 0; |
$this->_fit_width = 0; |
$this->_fit_height = 0; |
$this->_hbreaks = array(); |
$this->_vbreaks = array(); |
$this->_protect = 0; |
$this->_password = NULL; |
$this->col_sizes = array(); |
$this->row_sizes = array(); |
$this->_zoom = 100; |
$this->_print_scale = 100; |
$this->_initialize(); |
} |
/** |
* Open a tmp file to store the majority of the Worksheet data. If this fails, |
* for example due to write permissions, store the data in memory. This can be |
* slow for large files. |
* |
* @access private |
*/ |
function _initialize() |
{ |
// Open tmp file for storing Worksheet data |
$fh = tmpfile(); |
if ( $fh) { |
// Store filehandle |
$this->_filehandle = $fh; |
} |
else { |
// If tmpfile() fails store data in memory |
$this->_using_tmpfile = false; |
} |
} |
/** |
* Add data to the beginning of the workbook (note the reverse order) |
* and to the end of the workbook. |
* |
* @access public |
* @see Spreadsheet_Excel_Writer_Workbook::storeWorkbook() |
* @param array $sheetnames The array of sheetnames from the Workbook this |
* worksheet belongs to |
*/ |
function close($sheetnames) |
{ |
$num_sheets = count($sheetnames); |
/*********************************************** |
* Prepend in reverse order!! |
*/ |
// Prepend the sheet dimensions |
$this->storeDimensions(); |
// Prepend the sheet password |
$this->_storePassword(); |
// Prepend the sheet protection |
$this->_storeProtect(); |
// Prepend the page setup |
$this->_storeSetup(); |
// Prepend the bottom margin |
$this->_storeMarginBottom(); |
// Prepend the top margin |
$this->_storeMarginTop(); |
// Prepend the right margin |
$this->_storeMarginRight(); |
// Prepend the left margin |
$this->_storeMarginLeft(); |
// Prepend the page vertical centering |
$this->_storeVcenter(); |
// Prepend the page horizontal centering |
$this->_storeHcenter(); |
// Prepend the page footer |
$this->_storeFooter(); |
// Prepend the page header |
$this->_storeHeader(); |
// Prepend the vertical page breaks |
$this->_storeVbreak(); |
// Prepend the horizontal page breaks |
$this->_storeHbreak(); |
// Prepend WSBOOL |
$this->_storeWsbool(); |
// Prepend GRIDSET |
$this->_storeGridset(); |
// Prepend PRINTGRIDLINES |
$this->_storePrintGridlines(); |
// Prepend PRINTHEADERS |
$this->_storePrintHeaders(); |
// Prepend EXTERNSHEET references |
for ($i = $num_sheets; $i > 0; $i--) |
{ |
$sheetname = $sheetnames[$i-1]; |
$this->_storeExternsheet($sheetname); |
} |
// Prepend the EXTERNCOUNT of external references. |
$this->_storeExterncount($num_sheets); |
// Prepend the COLINFO records if they exist |
if (!empty($this->_colinfo)) |
{ |
for($i=0; $i < count($this->_colinfo); $i++) { |
$this->_storeColinfo($this->_colinfo[$i]); |
} |
$this->_storeDefcol(); |
} |
// Prepend the BOF record |
$this->_storeBof(0x0010); |
/* |
* End of prepend. Read upwards from here. |
***********************************************/ |
// Append |
$this->_storeWindow2(); |
$this->_storeZoom(); |
if (!empty($this->_panes)) { |
$this->_storePanes($this->_panes); |
} |
$this->_storeSelection($this->_selection); |
$this->_storeEof(); |
} |
/** |
* Retrieve the worksheet name. |
* This is usefull when creating worksheets without a name. |
* |
* @access public |
* @return string The worksheet's name |
*/ |
function getName() |
{ |
return $this->name; |
} |
/** |
* Retrieves data from memory in one chunk, or from disk in $buffer |
* sized chunks. |
* |
* @return string The data |
*/ |
function getData() |
{ |
$buffer = 4096; |
// Return data stored in memory |
if (isset($this->_data)) |
{ |
$tmp = $this->_data; |
unset($this->_data); |
$fh = $this->_filehandle; |
if ($this->_using_tmpfile) { |
fseek($fh, 0); |
} |
return($tmp); |
} |
// Return data stored on disk |
if ($this->_using_tmpfile) |
{ |
if ($tmp = fread($this->_filehandle, $buffer)) { |
return($tmp); |
} |
} |
// No data to return |
return(''); |
} |
/** |
* Set this worksheet as a selected worksheet, |
* i.e. the worksheet has its tab highlighted. |
* |
* @access public |
*/ |
function select() |
{ |
$this->selected = 1; |
} |
/** |
* Set this worksheet as the active worksheet, |
* i.e. the worksheet that is displayed when the workbook is opened. |
* Also set it as selected. |
* |
* @access public |
*/ |
function activate() |
{ |
$this->selected = 1; |
$this->activesheet = $this->index; |
} |
/** |
* Set this worksheet as the first visible sheet. |
* This is necessary when there are a large number of worksheets and the |
* activated worksheet is not visible on the screen. |
* |
* @access public |
*/ |
function setFirstSheet() |
{ |
$this->firstsheet = $this->index; |
} |
/** |
* Set the worksheet protection flag |
* to prevent accidental modification and to |
* hide formulas if the locked and hidden format properties have been set. |
* |
* @access public |
* @param string $password The password to use for protecting the sheet. |
*/ |
function protect($password) |
{ |
$this->_protect = 1; |
$this->_password = $this->_encodePassword($password); |
} |
/** |
* Set the width of a single column or a range of columns. |
* |
* @access public |
* @param integer $firstcol first column on the range |
* @param integer $lastcol last column on the range |
* @param integer $width width to set |
* @param mixed $format The optional XF format to apply to the columns |
* @param integer $hidden The optional hidden atribute |
*/ |
function setColumn($firstcol, $lastcol, $width, $format = 0, $hidden = 0) |
{ |
$this->_colinfo[] = array($firstcol, $lastcol, $width, &$format, $hidden); |
// Set width to zero if column is hidden |
$width = ($hidden) ? 0 : $width; |
for($col = $firstcol; $col <= $lastcol; $col++) { |
$this->col_sizes[$col] = $width; |
} |
} |
/** |
* Set which cell or cells are selected in a worksheet |
* |
* @access public |
* @param integer $first_row first row in the selected quadrant |
* @param integer $first_column first column in the selected quadrant |
* @param integer $last_row last row in the selected quadrant |
* @param integer $last_column last column in the selected quadrant |
*/ |
function setSelection($first_row,$first_column,$last_row,$last_column) |
{ |
$this->_selection = array($first_row,$first_column,$last_row,$last_column); |
} |
/** |
* Set panes and mark them as frozen. |
* |
* @access public |
* @param array $panes This is the only parameter received and is composed of the following: |
* 0 => Vertical split position, |
* 1 => Horizontal split position |
* 2 => Top row visible |
* 3 => Leftmost column visible |
* 4 => Active pane |
*/ |
function freezePanes($panes) |
{ |
$this->_frozen = 1; |
$this->_panes = $panes; |
} |
/** |
* Set panes and mark them as unfrozen. |
* |
* @access public |
* @param array $panes This is the only parameter received and is composed of the following: |
* 0 => Vertical split position, |
* 1 => Horizontal split position |
* 2 => Top row visible |
* 3 => Leftmost column visible |
* 4 => Active pane |
*/ |
function thawPanes($panes) |
{ |
$this->_frozen = 0; |
$this->_panes = $panes; |
} |
/** |
* Set the page orientation as portrait. |
* |
* @access public |
*/ |
function setPortrait() |
{ |
$this->_orientation = 1; |
} |
/** |
* Set the page orientation as landscape. |
* |
* @access public |
*/ |
function setLandscape() |
{ |
$this->_orientation = 0; |
} |
/** |
* Set the paper type. Ex. 1 = US Letter, 9 = A4 |
* |
* @access public |
* @param integer $size The type of paper size to use |
*/ |
function setPaper($size = 0) |
{ |
$this->_paper_size = $size; |
} |
/** |
* Set the page header caption and optional margin. |
* |
* @access public |
* @param string $string The header text |
* @param float $margin optional head margin in inches. |
*/ |
function setHeader($string,$margin = 0.50) |
{ |
if (strlen($string) >= 255) { |
//carp 'Header string must be less than 255 characters'; |
return; |
} |
$this->_header = $string; |
$this->_margin_head = $margin; |
} |
/** |
* Set the page footer caption and optional margin. |
* |
* @access public |
* @param string $string The footer text |
* @param float $margin optional foot margin in inches. |
*/ |
function setFooter($string,$margin = 0.50) |
{ |
if (strlen($string) >= 255) { |
//carp 'Footer string must be less than 255 characters'; |
return; |
} |
$this->_footer = $string; |
$this->_margin_foot = $margin; |
} |
/** |
* Center the page horinzontally. |
* |
* @access public |
* @param integer $center the optional value for centering. Defaults to 1 (center). |
*/ |
function centerHorizontally($center = 1) |
{ |
$this->_hcenter = $center; |
} |
/** |
* Center the page vertically. |
* |
* @access public |
* @param integer $center the optional value for centering. Defaults to 1 (center). |
*/ |
function centerVertically($center = 1) |
{ |
$this->_vcenter = $center; |
} |
/** |
* Set all the page margins to the same value in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMargins($margin) |
{ |
$this->setMarginLeft($margin); |
$this->setMarginRight($margin); |
$this->setMarginTop($margin); |
$this->setMarginBottom($margin); |
} |
/** |
* Set the left and right margins to the same value in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMargins_LR($margin) |
{ |
$this->setMarginLeft($margin); |
$this->setMarginRight($margin); |
} |
/** |
* Set the top and bottom margins to the same value in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMargins_TB($margin) |
{ |
$this->setMarginTop($margin); |
$this->setMarginBottom($margin); |
} |
/** |
* Set the left margin in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMarginLeft($margin = 0.75) |
{ |
$this->_margin_left = $margin; |
} |
/** |
* Set the right margin in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMarginRight($margin = 0.75) |
{ |
$this->_margin_right = $margin; |
} |
/** |
* Set the top margin in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMarginTop($margin = 1.00) |
{ |
$this->_margin_top = $margin; |
} |
/** |
* Set the bottom margin in inches. |
* |
* @access public |
* @param float $margin The margin to set in inches |
*/ |
function setMarginBottom($margin = 1.00) |
{ |
$this->_margin_bottom = $margin; |
} |
/** |
* Set the rows to repeat at the top of each printed page. |
* |
* @access public |
* @param integer $first_row First row to repeat |
* @param integer $last_row Last row to repeat. Optional. |
*/ |
function repeatRows($first_row, $last_row = NULL) |
{ |
$this->title_rowmin = $first_row; |
if (isset($last_row)) { //Second row is optional |
$this->title_rowmax = $last_row; |
} |
else { |
$this->title_rowmax = $first_row; |
} |
} |
/** |
* Set the columns to repeat at the left hand side of each printed page. |
* |
* @access public |
* @param integer $first_col First column to repeat |
* @param integer $last_col Last column to repeat. Optional. |
*/ |
function repeatColumns($first_col, $last_col = NULL) |
{ |
$this->title_colmin = $first_col; |
if (isset($last_col)) { // Second col is optional |
$this->title_colmax = $last_col; |
} |
else { |
$this->title_colmax = $first_col; |
} |
} |
/** |
* Set the area of each worksheet that will be printed. |
* |
* @access public |
* @param integer $first_row First row of the area to print |
* @param integer $first_col First column of the area to print |
* @param integer $last_row Last row of the area to print |
* @param integer $last_col Last column of the area to print |
*/ |
function printArea($first_row, $first_col, $last_row, $last_col) |
{ |
$this->print_rowmin = $first_row; |
$this->print_colmin = $first_col; |
$this->print_rowmax = $last_row; |
$this->print_colmax = $last_col; |
} |
/** |
* Set the option to hide gridlines on the printed page. |
* |
* @access public |
*/ |
function hideGridlines() |
{ |
$this->_print_gridlines = 0; |
} |
/** |
* Set the option to print the row and column headers on the printed page. |
* |
* @access public |
* @param integer $print Whether to print the headers or not. Defaults to 1 (print). |
*/ |
function printRowColHeaders($print = 1) |
{ |
$this->_print_headers = $print; |
} |
/** |
* Set the vertical and horizontal number of pages that will define the maximum area printed. |
* It doesn't seem to work with OpenOffice. |
* |
* @access public |
* @param integer $width Maximun width of printed area in pages |
* @param integer $height Maximun heigth of printed area in pages |
* @see setPrintScale() |
*/ |
function fitToPages($width, $height) |
{ |
$this->_fit_page = 1; |
$this->_fit_width = $width; |
$this->_fit_height = $height; |
} |
/** |
* Store the horizontal page breaks on a worksheet (for printing). |
* The breaks represent the row after which the break is inserted. |
* |
* @access public |
* @param array $breaks Array containing the horizontal page breaks |
*/ |
function setHPagebreaks($breaks) |
{ |
foreach($breaks as $break) { |
array_push($this->_hbreaks,$break); |
} |
} |
/** |
* Store the vertical page breaks on a worksheet (for printing). |
* The breaks represent the column after which the break is inserted. |
* |
* @access public |
* @param array $breaks Array containing the vertical page breaks |
*/ |
function setVPagebreaks($breaks) |
{ |
foreach($breaks as $break) { |
array_push($this->_vbreaks,$break); |
} |
} |
/** |
* Set the worksheet zoom factor. |
* |
* @access public |
* @param integer $scale The zoom factor |
*/ |
function setZoom($scale = 100) |
{ |
// Confine the scale to Excel's range |
if ($scale < 10 or $scale > 400) |
{ |
$this->raiseError("Zoom factor $scale outside range: 10 <= zoom <= 400"); |
$scale = 100; |
} |
$this->_zoom = floor($scale); |
} |
/** |
* Set the scale factor for the printed page. |
* It turns off the "fit to page" option |
* |
* @access public |
* @param integer $scale The optional scale factor. Defaults to 100 |
*/ |
function setPrintScale($scale = 100) |
{ |
// Confine the scale to Excel's range |
if ($scale < 10 or $scale > 400) |
{ |
$this->raiseError("Print scale $scale outside range: 10 <= zoom <= 400"); |
$scale = 100; |
} |
// Turn off "fit to page" option |
$this->_fit_page = 0; |
$this->_print_scale = floor($scale); |
} |
/** |
* Map to the appropriate write method acording to the token recieved. |
* |
* @access public |
* @param integer $row The row of the cell we are writing to |
* @param integer $col The column of the cell we are writing to |
* @param mixed $token What we are writing |
* @param mixed $format The optional format to apply to the cell |
*/ |
function write($row, $col, $token, $format = 0) |
{ |
// Check for a cell reference in A1 notation and substitute row and column |
/*if ($_[0] =~ /^\D/) { |
@_ = $this->_substituteCellref(@_); |
}*/ |
// Match number |
if (preg_match("/^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/",$token)) { |
return $this->writeNumber($row,$col,$token,$format); |
} |
// Match http or ftp URL |
elseif (preg_match("/^[fh]tt?p:\/\//",$token)) { |
return $this->writeUrl($row, $col, $token, $format); |
} |
// Match mailto: |
elseif (preg_match("/^mailto:/",$token)) { |
return $this->writeUrl($row, $col, $token, $format); |
} |
// Match internal or external sheet link |
elseif (preg_match("/^(?:in|ex)ternal:/",$token)) { |
return $this->writeUrl($row, $col, $token, $format); |
} |
// Match formula |
elseif (preg_match("/^=/",$token)) { |
return $this->writeFormula($row, $col, $token, $format); |
} |
// Match formula |
elseif (preg_match("/^@/",$token)) { |
return $this->writeFormula($row, $col, $token, $format); |
} |
// Match blank |
elseif ($token == '') { |
return $this->writeBlank($row,$col,$format); |
} |
// Default: match string |
else { |
return $this->writeString($row,$col,$token,$format); |
} |
} |
/** |
* Write an array of values as a row |
* |
* @access public |
* @param |
* @return |
*/ |
function writeRow($row, $col, $val, $format=0) |
{ |
if (is_array($val)) { |
foreach($val as $v) { |
if (is_array($v)) { |
$this->writeCol($row, $col, $v, $format); |
} else { |
$this->write($row, $col, $v, $format); |
} |
$col++; |
} |
} else { |
$retval = new PEAR_Error('$val needs to be an array'); |
} |
return($retval); |
} |
/** |
* Write an array of values as a column |
* |
* @access public |
* @param |
* @return |
*/ |
function writeCol($row, $col, $val, $format=0) |
{ |
if (is_array($val)) { |
foreach($val as $v) { |
$this->write($row, $col, $v, $format); |
$row++; |
} |
} else { |
$retval = new PEAR_Error('$val needs to be an array'); |
} |
return($retval); |
} |
/** |
* Returns an index to the XF record in the workbook |
* |
* @access private |
* @param mixed &$format The optional XF format |
* @return integer The XF record index |
*/ |
function _XF(&$format) |
{ |
if ($format != 0) { |
return($format->getXfIndex()); |
} |
else { |
return(0x0F); |
} |
} |
/****************************************************************************** |
******************************************************************************* |
* |
* Internal methods |
*/ |
/** |
* Store Worksheet data in memory using the parent's class append() or to a |
* temporary file, the default. |
* |
* @access private |
* @param string $data The binary data to append |
*/ |
function _append($data) |
{ |
if ($this->_using_tmpfile) |
{ |
// Add CONTINUE records if necessary |
if (strlen($data) > $this->_limit) { |
$data = $this->_addContinue($data); |
} |
fwrite($this->_filehandle,$data); |
$this->_datasize += strlen($data); |
} |
else { |
parent::_append($data); |
} |
} |
/** |
* Substitute an Excel cell reference in A1 notation for zero based row and |
* column values in an argument list. |
* |
* Ex: ("A4", "Hello") is converted to (3, 0, "Hello"). |
* |
* @access private |
* @param string $cell The cell reference. Or range of cells. |
* @return array |
*/ |
function _substituteCellref($cell) |
{ |
$cell = strtoupper($cell); |
// Convert a column range: 'A:A' or 'B:G' |
if (preg_match("/([A-I]?[A-Z]):([A-I]?[A-Z])/",$cell,$match)) { |
list($no_use, $col1) = $this->_cellToRowcol($match[1] .'1'); // Add a dummy row |
list($no_use, $col2) = $this->_cellToRowcol($match[2] .'1'); // Add a dummy row |
return(array($col1, $col2)); |
} |
// Convert a cell range: 'A1:B7' |
if (preg_match("/\$?([A-I]?[A-Z]\$?\d+):\$?([A-I]?[A-Z]\$?\d+)/",$cell,$match)) { |
list($row1, $col1) = $this->_cellToRowcol($match[1]); |
list($row2, $col2) = $this->_cellToRowcol($match[2]); |
return(array($row1, $col1, $row2, $col2)); |
} |
// Convert a cell reference: 'A1' or 'AD2000' |
if (preg_match("/\$?([A-I]?[A-Z]\$?\d+)/",$cell)) { |
list($row1, $col1) = $this->_cellToRowcol($match[1]); |
return(array($row1, $col1)); |
} |
// TODO use real error codes |
$this->raiseError("Unknown cell reference $cell", 0, PEAR_ERROR_DIE); |
} |
/** |
* Convert an Excel cell reference in A1 notation to a zero based row and column |
* reference; converts C1 to (0, 2). |
* |
* @access private |
* @param string $cell The cell reference. |
* @return array containing (row, column) |
*/ |
function _cellToRowcol($cell) |
{ |
preg_match("/\$?([A-I]?[A-Z])\$?(\d+)/",$cell,$match); |
$col = $match[1]; |
$row = $match[2]; |
// Convert base26 column string to number |
$chars = split('', $col); |
$expn = 0; |
$col = 0; |
while ($chars) { |
$char = array_pop($chars); // LS char first |
$col += (ord($char) -ord('A') +1) * pow(26,$expn); |
$expn++; |
} |
// Convert 1-index to zero-index |
$row--; |
$col--; |
return(array($row, $col)); |
} |
/** |
* Based on the algorithm provided by Daniel Rentz of OpenOffice. |
* |
* @access private |
* @param string $plaintext The password to be encoded in plaintext. |
* @return string The encoded password |
*/ |
function _encodePassword($plaintext) |
{ |
$password = 0x0000; |
$i = 1; // char position |
// split the plain text password in its component characters |
$chars = preg_split('//', $plaintext, -1, PREG_SPLIT_NO_EMPTY); |
foreach($chars as $char) |
{ |
$value = ord($char) << $i; // shifted ASCII value |
$rotated_bits = $value >> 15; // rotated bits beyond bit 15 |
$value &= 0x7fff; // first 15 bits |
$password ^= ($value | $rotated_bits); |
$i++; |
} |
$password ^= strlen($plaintext); |
$password ^= 0xCE4B; |
return($password); |
} |
/****************************************************************************** |
******************************************************************************* |
* |
* BIFF RECORDS |
*/ |
/** |
* Write a double to the specified row and column (zero indexed). |
* An integer can be written as a double. Excel will display an |
* integer. $format is optional. |
* |
* Returns 0 : normal termination |
* -2 : row or column out of range |
* |
* @access public |
* @param integer $row Zero indexed row |
* @param integer $col Zero indexed column |
* @param float $num The number to write |
* @param mixed $format The optional XF format |
* @return integer |
*/ |
function writeNumber($row, $col, $num, $format = 0) |
{ |
$record = 0x0203; // Record identifier |
$length = 0x000E; // Number of bytes to follow |
$xf = $this->_XF($format); // The cell format |
// Check that row and col are valid and store max and min values |
if ($row >= $this->_xls_rowmax) |
{ |
return(-2); |
} |
if ($col >= $this->_xls_colmax) |
{ |
return(-2); |
} |
if ($row < $this->_dim_rowmin) |
{ |
$this->_dim_rowmin = $row; |
} |
if ($row > $this->_dim_rowmax) |
{ |
$this->_dim_rowmax = $row; |
} |
if ($col < $this->_dim_colmin) |
{ |
$this->_dim_colmin = $col; |
} |
if ($col > $this->_dim_colmax) |
{ |
$this->_dim_colmax = $col; |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvv", $row, $col, $xf); |
$xl_double = pack("d", $num); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$xl_double = strrev($xl_double); |
} |
$this->_append($header.$data.$xl_double); |
return(0); |
} |
/** |
* Write a string to the specified row and column (zero indexed). |
* NOTE: there is an Excel 5 defined limit of 255 characters. |
* $format is optional. |
* Returns 0 : normal termination |
* -2 : row or column out of range |
* -3 : long string truncated to 255 chars |
* |
* @access public |
* @param integer $row Zero indexed row |
* @param integer $col Zero indexed column |
* @param string $str The string to write |
* @param mixed $format The XF format for the cell |
* @return integer |
*/ |
function writeString($row, $col, $str, $format = 0) |
{ |
$strlen = strlen($str); |
$record = 0x0204; // Record identifier |
$length = 0x0008 + $strlen; // Bytes to follow |
$xf = $this->_XF($format); // The cell format |
$str_error = 0; |
// Check that row and col are valid and store max and min values |
if ($row >= $this->_xls_rowmax) |
{ |
return(-2); |
} |
if ($col >= $this->_xls_colmax) |
{ |
return(-2); |
} |
if ($row < $this->_dim_rowmin) |
{ |
$this->_dim_rowmin = $row; |
} |
if ($row > $this->_dim_rowmax) |
{ |
$this->_dim_rowmax = $row; |
} |
if ($col < $this->_dim_colmin) |
{ |
$this->_dim_colmin = $col; |
} |
if ($col > $this->_dim_colmax) |
{ |
$this->_dim_colmax = $col; |
} |
if ($strlen > $this->_xls_strmax) // LABEL must be < 255 chars |
{ |
$str = substr($str, 0, $this->_xls_strmax); |
$length = 0x0008 + $this->_xls_strmax; |
$strlen = $this->_xls_strmax; |
$str_error = -3; |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvvv", $row, $col, $xf, $strlen); |
$this->_append($header.$data.$str); |
return($str_error); |
} |
/** |
* Writes a note associated with the cell given by the row and column. |
* NOTE records don't have a length limit. |
* |
* @access public |
* @param integer $row Zero indexed row |
* @param integer $col Zero indexed column |
* @param string $note The note to write |
*/ |
function writeNote($row, $col, $note) |
{ |
$note_length = strlen($note); |
$record = 0x001C; // Record identifier |
$max_length = 2048; // Maximun length for a NOTE record |
//$length = 0x0006 + $note_length; // Bytes to follow |
// Check that row and col are valid and store max and min values |
if ($row >= $this->_xls_rowmax) |
{ |
return(-2); |
} |
if ($col >= $this->_xls_colmax) |
{ |
return(-2); |
} |
if ($row < $this->_dim_rowmin) |
{ |
$this->_dim_rowmin = $row; |
} |
if ($row > $this->_dim_rowmax) |
{ |
$this->_dim_rowmax = $row; |
} |
if ($col < $this->_dim_colmin) |
{ |
$this->_dim_colmin = $col; |
} |
if ($col > $this->_dim_colmax) |
{ |
$this->_dim_colmax = $col; |
} |
// Length for this record is no more than 2048 + 6 |
$length = 0x0006 + min($note_length, 2048); |
$header = pack("vv", $record, $length); |
$data = pack("vvv", $row, $col, $note_length); |
$this->_append($header.$data.substr($note, 0, 2048)); |
for($i = $max_length; $i < $note_length; $i += $max_length) |
{ |
$chunk = substr($note, $i, $max_length); |
$length = 0x0006 + strlen($chunk); |
$header = pack("vv", $record, $length); |
$data = pack("vvv", -1, 0, strlen($chunk)); |
$this->_append($header.$data.$chunk); |
} |
return(0); |
} |
/** |
* Write a blank cell to the specified row and column (zero indexed). |
* A blank cell is used to specify formatting without adding a string |
* or a number. |
* |
* A blank cell without a format serves no purpose. Therefore, we don't write |
* a BLANK record unless a format is specified. |
* |
* Returns 0 : normal termination (including no format) |
* -1 : insufficient number of arguments |
* -2 : row or column out of range |
* |
* @access public |
* @param integer $row Zero indexed row |
* @param integer $col Zero indexed column |
* @param mixed $format The XF format |
*/ |
function writeBlank($row, $col, $format) |
{ |
// Don't write a blank cell unless it has a format |
if ($format == 0) |
{ |
return(0); |
} |
$record = 0x0201; // Record identifier |
$length = 0x0006; // Number of bytes to follow |
$xf = $this->_XF($format); // The cell format |
// Check that row and col are valid and store max and min values |
if ($row >= $this->_xls_rowmax) |
{ |
return(-2); |
} |
if ($col >= $this->_xls_colmax) |
{ |
return(-2); |
} |
if ($row < $this->_dim_rowmin) |
{ |
$this->_dim_rowmin = $row; |
} |
if ($row > $this->_dim_rowmax) |
{ |
$this->_dim_rowmax = $row; |
} |
if ($col < $this->_dim_colmin) |
{ |
$this->_dim_colmin = $col; |
} |
if ($col > $this->_dim_colmax) |
{ |
$this->_dim_colmax = $col; |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvv", $row, $col, $xf); |
$this->_append($header.$data); |
return 0; |
} |
/** |
* Write a formula to the specified row and column (zero indexed). |
* The textual representation of the formula is passed to the parser in |
* Parser.php which returns a packed binary string. |
* |
* Returns 0 : normal termination |
* -1 : formula errors (bad formula) |
* -2 : row or column out of range |
* |
* @access public |
* @param integer $row Zero indexed row |
* @param integer $col Zero indexed column |
* @param string $formula The formula text string |
* @param mixed $format The optional XF format |
* @return integer |
*/ |
function writeFormula($row, $col, $formula, $format = 0) |
{ |
$record = 0x0006; // Record identifier |
// Excel normally stores the last calculated value of the formula in $num. |
// Clearly we are not in a position to calculate this a priori. Instead |
// we set $num to zero and set the option flags in $grbit to ensure |
// automatic calculation of the formula when the file is opened. |
// |
$xf = $this->_XF($format); // The cell format |
$num = 0x00; // Current value of formula |
$grbit = 0x03; // Option flags |
$chn = 0x0000; // Must be zero |
// Check that row and col are valid and store max and min values |
if ($row >= $this->_xls_rowmax) |
{ |
return(-2); |
} |
if ($col >= $this->_xls_colmax) |
{ |
return(-2); |
} |
if ($row < $this->_dim_rowmin) |
{ |
$this->_dim_rowmin = $row; |
} |
if ($row > $this->_dim_rowmax) |
{ |
$this->_dim_rowmax = $row; |
} |
if ($col < $this->_dim_colmin) |
{ |
$this->_dim_colmin = $col; |
} |
if ($col > $this->_dim_colmax) |
{ |
$this->_dim_colmax = $col; |
} |
// Strip the '=' or '@' sign at the beginning of the formula string |
if (preg_match("/^=/",$formula)) { |
$formula = preg_replace("/(^=)/","",$formula); |
} |
elseif (preg_match("/^@/",$formula)) { |
$formula = preg_replace("/(^@)/","",$formula); |
} |
else |
{ |
// Error handling |
$this->writeString($row, $col, 'Unrecognised character for formula'); |
return -1; |
} |
// Parse the formula using the parser in Parser.php |
$error = $this->_parser->parse($formula); |
if ($this->isError($error)) |
{ |
$this->writeString($row, $col, $error->getMessage()); |
return -1; |
} |
$formula = $this->_parser->toReversePolish(); |
if ($this->isError($formula)) |
{ |
$this->writeString($row, $col, $formula->getMessage()); |
return -1; |
} |
$formlen = strlen($formula); // Length of the binary string |
$length = 0x16 + $formlen; // Length of the record data |
$header = pack("vv", $record, $length); |
$data = pack("vvvdvVv", $row, $col, $xf, $num, |
$grbit, $chn, $formlen); |
$this->_append($header.$data.$formula); |
return 0; |
} |
/** |
* Write a hyperlink. |
* This is comprised of two elements: the visible label and |
* the invisible link. The visible label is the same as the link unless an |
* alternative string is specified. The label is written using the |
* writeString() method. Therefore the 255 characters string limit applies. |
* $string and $format are optional. |
* |
* The hyperlink can be to a http, ftp, mail, internal sheet (not yet), or external |
* directory url. |
* |
* Returns 0 : normal termination |
* -2 : row or column out of range |
* -3 : long string truncated to 255 chars |
* |
* @access public |
* @param integer $row Row |
* @param integer $col Column |
* @param string $url URL string |
* @param string $string Alternative label |
* @param mixed $format The cell format |
* @return integer |
*/ |
function writeUrl($row, $col, $url, $string = '', $format = 0) |
{ |
// Add start row and col to arg list |
return($this->_writeUrl_range($row, $col, $row, $col, $url, $string, $format)); |
} |
/** |
* This is the more general form of writeUrl(). It allows a hyperlink to be |
* written to a range of cells. This function also decides the type of hyperlink |
* to be written. These are either, Web (http, ftp, mailto), Internal |
* (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1'). |
* |
* @access private |
* @see writeUrl() |
* @param integer $row1 Start row |
* @param integer $col1 Start column |
* @param integer $row2 End row |
* @param integer $col2 End column |
* @param string $url URL string |
* @param string $string Alternative label |
* @param mixed $format The cell format |
* @return integer |
*/ |
function _writeUrl_range($row1, $col1, $row2, $col2, $url, $string = '', $format = 0) |
{ |
// Check for internal/external sheet links or default to web link |
if (preg_match('[^internal:]', $url)) { |
return($this->_writeUrlInternal($row1, $col1, $row2, $col2, $url, $string, $format)); |
} |
if (preg_match('[^external:]', $url)) { |
return($this->_writeUrlExternal($row1, $col1, $row2, $col2, $url, $string, $format)); |
} |
return($this->_writeUrlWeb($row1, $col1, $row2, $col2, $url, $string, $format)); |
} |
/** |
* Used to write http, ftp and mailto hyperlinks. |
* The link type ($options) is 0x03 is the same as absolute dir ref without |
* sheet. However it is differentiated by the $unknown2 data stream. |
* |
* @access private |
* @see writeUrl() |
* @param integer $row1 Start row |
* @param integer $col1 Start column |
* @param integer $row2 End row |
* @param integer $col2 End column |
* @param string $url URL string |
* @param string $str Alternative label |
* @param mixed $format The cell format |
* @return integer |
*/ |
function _writeUrlWeb($row1, $col1, $row2, $col2, $url, $str, $format = 0) |
{ |
$record = 0x01B8; // Record identifier |
$length = 0x00000; // Bytes to follow |
if ($format == 0) { |
$format = $this->_url_format; |
} |
// Write the visible label using the writeString() method. |
if ($str == '') { |
$str = $url; |
} |
$str_error = $this->writeString($row1, $col1, $str, $format); |
if (($str_error == -2) or ($str_error == -3)) { |
return $str_error; |
} |
// Pack the undocumented parts of the hyperlink stream |
$unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000"); |
$unknown2 = pack("H*", "E0C9EA79F9BACE118C8200AA004BA90B"); |
// Pack the option flags |
$options = pack("V", 0x03); |
// Convert URL to a null terminated wchar string |
$url = join("\0", preg_split("''", $url, -1, PREG_SPLIT_NO_EMPTY)); |
$url = $url . "\0\0\0"; |
// Pack the length of the URL |
$url_len = pack("V", strlen($url)); |
// Calculate the data length |
$length = 0x34 + strlen($url); |
// Pack the header data |
$header = pack("vv", $record, $length); |
$data = pack("vvvv", $row1, $row2, $col1, $col2); |
// Write the packed data |
$this->_append( $header. $data. |
$unknown1. $options. |
$unknown2. $url_len. $url); |
return($str_error); |
} |
/** |
* Used to write internal reference hyperlinks such as "Sheet1!A1". |
* |
* @access private |
* @see writeUrl() |
* @param integer $row1 Start row |
* @param integer $col1 Start column |
* @param integer $row2 End row |
* @param integer $col2 End column |
* @param string $url URL string |
* @param string $str Alternative label |
* @param mixed $format The cell format |
* @return integer |
*/ |
function _writeUrlInternal($row1, $col1, $row2, $col2, $url, $str, $format = 0) |
{ |
$record = 0x01B8; // Record identifier |
$length = 0x00000; // Bytes to follow |
if ($format == 0) { |
$format = $this->_url_format; |
} |
// Strip URL type |
$url = preg_replace('s[^internal:]', '', $url); |
// Write the visible label |
if ($str == '') { |
$str = $url; |
} |
$str_error = $this->writeString($row1, $col1, $str, $format); |
if (($str_error == -2) or ($str_error == -3)) { |
return $str_error; |
} |
// Pack the undocumented parts of the hyperlink stream |
$unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000"); |
// Pack the option flags |
$options = pack("V", 0x08); |
// Convert the URL type and to a null terminated wchar string |
$url = join("\0", preg_split("''", $url, -1, PREG_SPLIT_NO_EMPTY)); |
$url = $url . "\0\0\0"; |
// Pack the length of the URL as chars (not wchars) |
$url_len = pack("V", floor(strlen($url)/2)); |
// Calculate the data length |
$length = 0x24 + strlen($url); |
// Pack the header data |
$header = pack("vv", $record, $length); |
$data = pack("vvvv", $row1, $row2, $col1, $col2); |
// Write the packed data |
$this->_append($header. $data. |
$unknown1. $options. |
$url_len. $url); |
return($str_error); |
} |
/** |
* Write links to external directory names such as 'c:\foo.xls', |
* c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'. |
* |
* Note: Excel writes some relative links with the $dir_long string. We ignore |
* these cases for the sake of simpler code. |
* |
* @access private |
* @see writeUrl() |
* @param integer $row1 Start row |
* @param integer $col1 Start column |
* @param integer $row2 End row |
* @param integer $col2 End column |
* @param string $url URL string |
* @param string $str Alternative label |
* @param mixed $format The cell format |
* @return integer |
*/ |
function _writeUrlExternal($row1, $col1, $row2, $col2, $url, $str, $format = 0) |
{ |
// Network drives are different. We will handle them separately |
// MS/Novell network drives and shares start with \\ |
if (preg_match('[^external:\\\\]', $url)) { |
return; //($this->_writeUrlExternal_net($row1, $col1, $row2, $col2, $url, $str, $format)); |
} |
$record = 0x01B8; // Record identifier |
$length = 0x00000; // Bytes to follow |
if ($format == 0) { |
$format = $this->_url_format; |
} |
// Strip URL type and change Unix dir separator to Dos style (if needed) |
// |
$url = preg_replace('[^external:]', '', $url); |
$url = preg_replace('[/]', "\\", $url); |
// Write the visible label |
if ($str == '') { |
$str = preg_replace('[\#]', ' - ', $url); |
} |
$str_error = $this->writeString($row1, $col1, $str, $format); |
if (($str_error == -2) or ($str_error == -3)) { |
return $str_error; |
} |
// Determine if the link is relative or absolute: |
// relative if link contains no dir separator, "somefile.xls" |
// relative if link starts with up-dir, "..\..\somefile.xls" |
// otherwise, absolute |
$absolute = 0x02; // Bit mask |
if (!preg_match('[\\]', $url)) { |
$absolute = 0x00; |
} |
if (preg_match('[^\.\.\\]', $url)) { |
$absolute = 0x00; |
} |
// Determine if the link contains a sheet reference and change some of the |
// parameters accordingly. |
// Split the dir name and sheet name (if it exists) |
list($dir_long , $sheet) = split('/\#/', $url); |
$link_type = 0x01 | $absolute; |
if (isset($sheet)) { |
$link_type |= 0x08; |
$sheet_len = pack("V", strlen($sheet) + 0x01); |
$sheet = join("\0", split('', $sheet)); |
$sheet .= "\0\0\0"; |
} |
else { |
$sheet_len = ''; |
$sheet = ''; |
} |
// Pack the link type |
$link_type = pack("V", $link_type); |
// Calculate the up-level dir count e.g.. (..\..\..\ == 3) |
$up_count = preg_match_all("/\.\.\\/", $dir_long, $useless); |
$up_count = pack("v", $up_count); |
// Store the short dos dir name (null terminated) |
$dir_short = preg_replace('/\.\.\\/', '', $dir_long) . "\0"; |
// Store the long dir name as a wchar string (non-null terminated) |
$dir_long = join("\0", split('', $dir_long)); |
$dir_long = $dir_long . "\0"; |
// Pack the lengths of the dir strings |
$dir_short_len = pack("V", strlen($dir_short) ); |
$dir_long_len = pack("V", strlen($dir_long) ); |
$stream_len = pack("V", strlen($dir_long) + 0x06); |
// Pack the undocumented parts of the hyperlink stream |
$unknown1 = pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000' ); |
$unknown2 = pack("H*",'0303000000000000C000000000000046' ); |
$unknown3 = pack("H*",'FFFFADDE000000000000000000000000000000000000000'); |
$unknown4 = pack("v", 0x03 ); |
// Pack the main data stream |
$data = pack("vvvv", $row1, $row2, $col1, $col2) . |
$unknown1 . |
$link_type . |
$unknown2 . |
$up_count . |
$dir_short_len. |
$dir_short . |
$unknown3 . |
$stream_len . |
$dir_long_len . |
$unknown4 . |
$dir_long . |
$sheet_len . |
$sheet ; |
// Pack the header data |
$length = strlen($data); |
$header = pack("vv", $record, $length); |
// Write the packed data |
$this->_append($header. $data); |
return($str_error); |
} |
/** |
* This method is used to set the height and format for a row. |
* |
* @access public |
* @param integer $row The row to set |
* @param integer $height Height we are giving to the row. |
* Use NULL to set XF without setting height |
* @param mixed $format XF format we are giving to the row |
*/ |
function setRow($row, $height, $format = 0) |
{ |
$record = 0x0208; // Record identifier |
$length = 0x0010; // Number of bytes to follow |
$colMic = 0x0000; // First defined column |
$colMac = 0x0000; // Last defined column |
$irwMac = 0x0000; // Used by Excel to optimise loading |
$reserved = 0x0000; // Reserved |
$grbit = 0x01C0; // Option flags. (monkey) see $1 do |
$ixfe = $this->_XF($format); // XF index |
// Use setRow($row, NULL, $XF) to set XF format without setting height |
if ($height != NULL) { |
$miyRw = $height * 20; // row height |
} |
else { |
$miyRw = 0xff; // default row height is 256 |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvvvvvvv", $row, $colMic, $colMac, $miyRw, |
$irwMac,$reserved, $grbit, $ixfe); |
$this->_append($header.$data); |
} |
/** |
* Writes Excel DIMENSIONS to define the area in which there is data. |
* |
* @access private |
*/ |
function storeDimensions() |
{ |
$record = 0x0000; // Record identifier |
$length = 0x000A; // Number of bytes to follow |
$row_min = $this->_dim_rowmin; // First row |
$row_max = $this->_dim_rowmax; // Last row plus 1 |
$col_min = $this->_dim_colmin; // First column |
$col_max = $this->_dim_colmax; // Last column plus 1 |
$reserved = 0x0000; // Reserved by Excel |
$header = pack("vv", $record, $length); |
$data = pack("vvvvv", $row_min, $row_max, |
$col_min, $col_max, $reserved); |
$this->_prepend($header.$data); |
} |
/** |
* Write BIFF record Window2. |
* |
* @access private |
*/ |
function _storeWindow2() |
{ |
$record = 0x023E; // Record identifier |
$length = 0x000A; // Number of bytes to follow |
$grbit = 0x00B6; // Option flags |
$rwTop = 0x0000; // Top row visible in window |
$colLeft = 0x0000; // Leftmost column visible in window |
$rgbHdr = 0x00000000; // Row/column heading and gridline color |
// The options flags that comprise $grbit |
$fDspFmla = 0; // 0 - bit |
$fDspGrid = 1; // 1 |
$fDspRwCol = 1; // 2 |
$fFrozen = $this->_frozen; // 3 |
$fDspZeros = 1; // 4 |
$fDefaultHdr = 1; // 5 |
$fArabic = 0; // 6 |
$fDspGuts = 1; // 7 |
$fFrozenNoSplit = 0; // 0 - bit |
$fSelected = $this->selected; // 1 |
$fPaged = 1; // 2 |
$grbit = $fDspFmla; |
$grbit |= $fDspGrid << 1; |
$grbit |= $fDspRwCol << 2; |
$grbit |= $fFrozen << 3; |
$grbit |= $fDspZeros << 4; |
$grbit |= $fDefaultHdr << 5; |
$grbit |= $fArabic << 6; |
$grbit |= $fDspGuts << 7; |
$grbit |= $fFrozenNoSplit << 8; |
$grbit |= $fSelected << 9; |
$grbit |= $fPaged << 10; |
$header = pack("vv", $record, $length); |
$data = pack("vvvV", $grbit, $rwTop, $colLeft, $rgbHdr); |
$this->_append($header.$data); |
} |
/** |
* Write BIFF record DEFCOLWIDTH if COLINFO records are in use. |
* |
* @access private |
*/ |
function _storeDefcol() |
{ |
$record = 0x0055; // Record identifier |
$length = 0x0002; // Number of bytes to follow |
$colwidth = 0x0008; // Default column width |
$header = pack("vv", $record, $length); |
$data = pack("v", $colwidth); |
$this->_prepend($header.$data); |
} |
/** |
* Write BIFF record COLINFO to define column widths |
* |
* Note: The SDK says the record length is 0x0B but Excel writes a 0x0C |
* length record. |
* |
* @access private |
* @param array $col_array This is the only parameter received and is composed of the following: |
* 0 => First formatted column, |
* 1 => Last formatted column, |
* 2 => Col width (8.43 is Excel default), |
* 3 => The optional XF format of the column, |
* 4 => Option flags. |
*/ |
function _storeColinfo($col_array) |
{ |
if (isset($col_array[0])) { |
$colFirst = $col_array[0]; |
} |
if (isset($col_array[1])) { |
$colLast = $col_array[1]; |
} |
if (isset($col_array[2])) { |
$coldx = $col_array[2]; |
} |
else { |
$coldx = 8.43; |
} |
if (isset($col_array[3])) { |
$format = $col_array[3]; |
} |
else { |
$format = 0; |
} |
if (isset($col_array[4])) { |
$grbit = $col_array[4]; |
} |
else { |
$grbit = 0; |
} |
$record = 0x007D; // Record identifier |
$length = 0x000B; // Number of bytes to follow |
$coldx += 0.72; // Fudge. Excel subtracts 0.72 !? |
$coldx *= 256; // Convert to units of 1/256 of a char |
$ixfe = $this->_XF($format); |
$reserved = 0x00; // Reserved |
$header = pack("vv", $record, $length); |
$data = pack("vvvvvC", $colFirst, $colLast, $coldx, |
$ixfe, $grbit, $reserved); |
$this->_prepend($header.$data); |
} |
/** |
* Write BIFF record SELECTION. |
* |
* @access private |
* @param array $array array containing ($rwFirst,$colFirst,$rwLast,$colLast) |
* @see setSelection() |
*/ |
function _storeSelection($array) |
{ |
list($rwFirst,$colFirst,$rwLast,$colLast) = $array; |
$record = 0x001D; // Record identifier |
$length = 0x000F; // Number of bytes to follow |
$pnn = $this->_active_pane; // Pane position |
$rwAct = $rwFirst; // Active row |
$colAct = $colFirst; // Active column |
$irefAct = 0; // Active cell ref |
$cref = 1; // Number of refs |
if (!isset($rwLast)) { |
$rwLast = $rwFirst; // Last row in reference |
} |
if (!isset($colLast)) { |
$colLast = $colFirst; // Last col in reference |
} |
// Swap last row/col for first row/col as necessary |
if ($rwFirst > $rwLast) |
{ |
list($rwFirst, $rwLast) = array($rwLast, $rwFirst); |
} |
if ($colFirst > $colLast) |
{ |
list($colFirst, $colLast) = array($colLast, $colFirst); |
} |
$header = pack("vv", $record, $length); |
$data = pack("CvvvvvvCC", $pnn, $rwAct, $colAct, |
$irefAct, $cref, |
$rwFirst, $rwLast, |
$colFirst, $colLast); |
$this->_append($header.$data); |
} |
/** |
* Write BIFF record EXTERNCOUNT to indicate the number of external sheet |
* references in a worksheet. |
* |
* Excel only stores references to external sheets that are used in formulas. |
* For simplicity we store references to all the sheets in the workbook |
* regardless of whether they are used or not. This reduces the overall |
* complexity and eliminates the need for a two way dialogue between the formula |
* parser the worksheet objects. |
* |
* @access private |
* @param integer $count The number of external sheet references in this worksheet |
*/ |
function _storeExterncount($count) |
{ |
$record = 0x0016; // Record identifier |
$length = 0x0002; // Number of bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("v", $count); |
$this->_prepend($header.$data); |
} |
/** |
* Writes the Excel BIFF EXTERNSHEET record. These references are used by |
* formulas. A formula references a sheet name via an index. Since we store a |
* reference to all of the external worksheets the EXTERNSHEET index is the same |
* as the worksheet index. |
* |
* @access private |
* @param string $sheetname The name of a external worksheet |
*/ |
function _storeExternsheet($sheetname) |
{ |
$record = 0x0017; // Record identifier |
// References to the current sheet are encoded differently to references to |
// external sheets. |
// |
if ($this->name == $sheetname) { |
$sheetname = ''; |
$length = 0x02; // The following 2 bytes |
$cch = 1; // The following byte |
$rgch = 0x02; // Self reference |
} |
else { |
$length = 0x02 + strlen($sheetname); |
$cch = strlen($sheetname); |
$rgch = 0x03; // Reference to a sheet in the current workbook |
} |
$header = pack("vv", $record, $length); |
$data = pack("CC", $cch, $rgch); |
$this->_prepend($header.$data.$sheetname); |
} |
/** |
* Writes the Excel BIFF PANE record. |
* The panes can either be frozen or thawed (unfrozen). |
* Frozen panes are specified in terms of an integer number of rows and columns. |
* Thawed panes are specified in terms of Excel's units for rows and columns. |
* |
* @access private |
* @param array $panes This is the only parameter received and is composed of the following: |
* 0 => Vertical split position, |
* 1 => Horizontal split position |
* 2 => Top row visible |
* 3 => Leftmost column visible |
* 4 => Active pane |
*/ |
function _storePanes($panes) |
{ |
$y = $panes[0]; |
$x = $panes[1]; |
$rwTop = $panes[2]; |
$colLeft = $panes[3]; |
if (count($panes) > 4) { // if Active pane was received |
$pnnAct = $panes[4]; |
} |
else { |
$pnnAct = NULL; |
} |
$record = 0x0041; // Record identifier |
$length = 0x000A; // Number of bytes to follow |
// Code specific to frozen or thawed panes. |
if ($this->_frozen) |
{ |
// Set default values for $rwTop and $colLeft |
if (!isset($rwTop)) { |
$rwTop = $y; |
} |
if (!isset($colLeft)) { |
$colLeft = $x; |
} |
} |
else |
{ |
// Set default values for $rwTop and $colLeft |
if (!isset($rwTop)) { |
$rwTop = 0; |
} |
if (!isset($colLeft)) { |
$colLeft = 0; |
} |
// Convert Excel's row and column units to the internal units. |
// The default row height is 12.75 |
// The default column width is 8.43 |
// The following slope and intersection values were interpolated. |
// |
$y = 20*$y + 255; |
$x = 113.879*$x + 390; |
} |
// Determine which pane should be active. There is also the undocumented |
// option to override this should it be necessary: may be removed later. |
// |
if (!isset($pnnAct)) |
{ |
if ($x != 0 and $y != 0) |
$pnnAct = 0; // Bottom right |
if ($x != 0 and $y == 0) |
$pnnAct = 1; // Top right |
if ($x == 0 and $y != 0) |
$pnnAct = 2; // Bottom left |
if ($x == 0 and $y == 0) |
$pnnAct = 3; // Top left |
} |
$this->_active_pane = $pnnAct; // Used in _storeSelection |
$header = pack("vv", $record, $length); |
$data = pack("vvvvv", $x, $y, $rwTop, $colLeft, $pnnAct); |
$this->_append($header.$data); |
} |
/** |
* Store the page setup SETUP BIFF record. |
* |
* @access private |
*/ |
function _storeSetup() |
{ |
$record = 0x00A1; // Record identifier |
$length = 0x0022; // Number of bytes to follow |
$iPaperSize = $this->_paper_size; // Paper size |
$iScale = $this->_print_scale; // Print scaling factor |
$iPageStart = 0x01; // Starting page number |
$iFitWidth = $this->_fit_width; // Fit to number of pages wide |
$iFitHeight = $this->_fit_height; // Fit to number of pages high |
$grbit = 0x00; // Option flags |
$iRes = 0x0258; // Print resolution |
$iVRes = 0x0258; // Vertical print resolution |
$numHdr = $this->_margin_head; // Header Margin |
$numFtr = $this->_margin_foot; // Footer Margin |
$iCopies = 0x01; // Number of copies |
$fLeftToRight = 0x0; // Print over then down |
$fLandscape = $this->_orientation; // Page orientation |
$fNoPls = 0x0; // Setup not read from printer |
$fNoColor = 0x0; // Print black and white |
$fDraft = 0x0; // Print draft quality |
$fNotes = 0x0; // Print notes |
$fNoOrient = 0x0; // Orientation not set |
$fUsePage = 0x0; // Use custom starting page |
$grbit = $fLeftToRight; |
$grbit |= $fLandscape << 1; |
$grbit |= $fNoPls << 2; |
$grbit |= $fNoColor << 3; |
$grbit |= $fDraft << 4; |
$grbit |= $fNotes << 5; |
$grbit |= $fNoOrient << 6; |
$grbit |= $fUsePage << 7; |
$numHdr = pack("d", $numHdr); |
$numFtr = pack("d", $numFtr); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$numHdr = strrev($numHdr); |
$numFtr = strrev($numFtr); |
} |
$header = pack("vv", $record, $length); |
$data1 = pack("vvvvvvvv", $iPaperSize, |
$iScale, |
$iPageStart, |
$iFitWidth, |
$iFitHeight, |
$grbit, |
$iRes, |
$iVRes); |
$data2 = $numHdr.$numFtr; |
$data3 = pack("v", $iCopies); |
$this->_prepend($header.$data1.$data2.$data3); |
} |
/** |
* Store the header caption BIFF record. |
* |
* @access private |
*/ |
function _storeHeader() |
{ |
$record = 0x0014; // Record identifier |
$str = $this->_header; // header string |
$cch = strlen($str); // Length of header string |
$length = 1 + $cch; // Bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("C", $cch); |
$this->_append($header.$data.$str); |
} |
/** |
* Store the footer caption BIFF record. |
* |
* @access private |
*/ |
function _storeFooter() |
{ |
$record = 0x0015; // Record identifier |
$str = $this->_footer; // Footer string |
$cch = strlen($str); // Length of footer string |
$length = 1 + $cch; // Bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("C", $cch); |
$this->_append($header.$data.$str); |
} |
/** |
* Store the horizontal centering HCENTER BIFF record. |
* |
* @access private |
*/ |
function _storeHcenter() |
{ |
$record = 0x0083; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fHCenter = $this->_hcenter; // Horizontal centering |
$header = pack("vv", $record, $length); |
$data = pack("v", $fHCenter); |
$this->_append($header.$data); |
} |
/** |
* Store the vertical centering VCENTER BIFF record. |
* |
* @access private |
*/ |
function _storeVcenter() |
{ |
$record = 0x0084; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fVCenter = $this->_vcenter; // Horizontal centering |
$header = pack("vv", $record, $length); |
$data = pack("v", $fVCenter); |
$this->_append($header.$data); |
} |
/** |
* Store the LEFTMARGIN BIFF record. |
* |
* @access private |
*/ |
function _storeMarginLeft() |
{ |
$record = 0x0026; // Record identifier |
$length = 0x0008; // Bytes to follow |
$margin = $this->_margin_left; // Margin in inches |
$header = pack("vv", $record, $length); |
$data = pack("d", $margin); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$data = strrev($data); |
} |
$this->_append($header.$data); |
} |
/** |
* Store the RIGHTMARGIN BIFF record. |
* |
* @access private |
*/ |
function _storeMarginRight() |
{ |
$record = 0x0027; // Record identifier |
$length = 0x0008; // Bytes to follow |
$margin = $this->_margin_right; // Margin in inches |
$header = pack("vv", $record, $length); |
$data = pack("d", $margin); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$data = strrev($data); |
} |
$this->_append($header.$data); |
} |
/** |
* Store the TOPMARGIN BIFF record. |
* |
* @access private |
*/ |
function _storeMarginTop() |
{ |
$record = 0x0028; // Record identifier |
$length = 0x0008; // Bytes to follow |
$margin = $this->_margin_top; // Margin in inches |
$header = pack("vv", $record, $length); |
$data = pack("d", $margin); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$data = strrev($data); |
} |
$this->_append($header.$data); |
} |
/** |
* Store the BOTTOMMARGIN BIFF record. |
* |
* @access private |
*/ |
function _storeMarginBottom() |
{ |
$record = 0x0029; // Record identifier |
$length = 0x0008; // Bytes to follow |
$margin = $this->_margin_bottom; // Margin in inches |
$header = pack("vv", $record, $length); |
$data = pack("d", $margin); |
if ($this->_byte_order) // if it's Big Endian |
{ |
$data = strrev($data); |
} |
$this->_append($header.$data); |
} |
/** |
* Merges the area given by its arguments. |
* This is an Excel97/2000 method. It is required to perform more complicated |
* merging than the normal setAlign('merge'). |
* |
* @access public |
* @param integer $first_row First row of the area to merge |
* @param integer $first_col First column of the area to merge |
* @param integer $last_row Last row of the area to merge |
* @param integer $last_col Last column of the area to merge |
*/ |
function mergeCells($first_row, $first_col, $last_row, $last_col) |
{ |
$record = 0x00E5; // Record identifier |
$length = 0x000A; // Bytes to follow |
$cref = 1; // Number of refs |
// Swap last row/col for first row/col as necessary |
if ($first_row > $last_row) { |
list($first_row, $last_row) = array($last_row, $first_row); |
} |
if ($first_col > $last_col) { |
list($first_col, $last_col) = array($last_col, $first_col); |
} |
$header = pack("vv", $record, $length); |
$data = pack("vvvvv", $cref, $first_row, $last_row, |
$first_col, $last_col); |
$this->_append($header.$data); |
} |
/** |
* Write the PRINTHEADERS BIFF record. |
* |
* @access private |
*/ |
function _storePrintHeaders() |
{ |
$record = 0x002a; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fPrintRwCol = $this->_print_headers; // Boolean flag |
$header = pack("vv", $record, $length); |
$data = pack("v", $fPrintRwCol); |
$this->_prepend($header.$data); |
} |
/** |
* Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the |
* GRIDSET record. |
* |
* @access private |
*/ |
function _storePrintGridlines() |
{ |
$record = 0x002b; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fPrintGrid = $this->_print_gridlines; // Boolean flag |
$header = pack("vv", $record, $length); |
$data = pack("v", $fPrintGrid); |
$this->_prepend($header.$data); |
} |
/** |
* Write the GRIDSET BIFF record. Must be used in conjunction with the |
* PRINTGRIDLINES record. |
* |
* @access private |
*/ |
function _storeGridset() |
{ |
$record = 0x0082; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fGridSet = !($this->_print_gridlines); // Boolean flag |
$header = pack("vv", $record, $length); |
$data = pack("v", $fGridSet); |
$this->_prepend($header.$data); |
} |
/** |
* Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction |
* with the SETUP record. |
* |
* @access private |
*/ |
function _storeWsbool() |
{ |
$record = 0x0081; // Record identifier |
$length = 0x0002; // Bytes to follow |
// The only option that is of interest is the flag for fit to page. So we |
// set all the options in one go. |
// |
if ($this->_fit_page) { |
$grbit = 0x05c1; |
} |
else { |
$grbit = 0x04c1; |
} |
$header = pack("vv", $record, $length); |
$data = pack("v", $grbit); |
$this->_prepend($header.$data); |
} |
/** |
* Write the HORIZONTALPAGEBREAKS BIFF record. |
* |
* @access private |
*/ |
function _storeHbreak() |
{ |
// Return if the user hasn't specified pagebreaks |
if (empty($this->_hbreaks)) { |
return; |
} |
// Sort and filter array of page breaks |
$breaks = $this->_hbreaks; |
sort($breaks,SORT_NUMERIC); |
if ($breaks[0] == 0) { // don't use first break if it's 0 |
array_shift($breaks); |
} |
$record = 0x001b; // Record identifier |
$cbrk = count($breaks); // Number of page breaks |
$length = ($cbrk + 1) * 2; // Bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("v", $cbrk); |
// Append each page break |
foreach($breaks as $break) { |
$data .= pack("v", $break); |
} |
$this->_prepend($header.$data); |
} |
/** |
* Write the VERTICALPAGEBREAKS BIFF record. |
* |
* @access private |
*/ |
function _storeVbreak() |
{ |
// Return if the user hasn't specified pagebreaks |
if (empty($this->_vbreaks)) { |
return; |
} |
// 1000 vertical pagebreaks appears to be an internal Excel 5 limit. |
// It is slightly higher in Excel 97/200, approx. 1026 |
$breaks = array_slice($this->_vbreaks,0,1000); |
// Sort and filter array of page breaks |
sort($breaks,SORT_NUMERIC); |
if ($breaks[0] == 0) { // don't use first break if it's 0 |
array_shift($breaks); |
} |
$record = 0x001a; // Record identifier |
$cbrk = count($breaks); // Number of page breaks |
$length = ($cbrk + 1) * 2; // Bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("v", $cbrk); |
// Append each page break |
foreach ($breaks as $break) { |
$data .= pack("v", $break); |
} |
$this->_prepend($header.$data); |
} |
/** |
* Set the Biff PROTECT record to indicate that the worksheet is protected. |
* |
* @access private |
*/ |
function _storeProtect() |
{ |
// Exit unless sheet protection has been specified |
if ($this->_protect == 0) { |
return; |
} |
$record = 0x0012; // Record identifier |
$length = 0x0002; // Bytes to follow |
$fLock = $this->_protect; // Worksheet is protected |
$header = pack("vv", $record, $length); |
$data = pack("v", $fLock); |
$this->_prepend($header.$data); |
} |
/** |
* Write the worksheet PASSWORD record. |
* |
* @access private |
*/ |
function _storePassword() |
{ |
// Exit unless sheet protection and password have been specified |
if (($this->_protect == 0) or (!isset($this->_password))) { |
return; |
} |
$record = 0x0013; // Record identifier |
$length = 0x0002; // Bytes to follow |
$wPassword = $this->_password; // Encoded password |
$header = pack("vv", $record, $length); |
$data = pack("v", $wPassword); |
$this->_prepend($header.$data); |
} |
/** |
* Insert a 24bit bitmap image in a worksheet. |
* |
* @access public |
* @param integer $row The row we are going to insert the bitmap into |
* @param integer $col The column we are going to insert the bitmap into |
* @param string $bitmap The bitmap filename |
* @param integer $x The horizontal position (offset) of the image inside the cell. |
* @param integer $y The vertical position (offset) of the image inside the cell. |
* @param integer $scale_x The horizontal scale |
* @param integer $scale_y The vertical scale |
*/ |
function insertBitmap($row, $col, $bitmap, $x = 0, $y = 0, $scale_x = 1, $scale_y = 1) |
{ |
$bitmap_array = $this->_processBitmap($bitmap); |
if ($this->isError($bitmap_array)) |
{ |
$this->writeString($row, $col, $bitmap_array->getMessage()); |
return; |
} |
list($width, $height, $size, $data) = $bitmap_array; //$this->_processBitmap($bitmap); |
// Scale the frame of the image. |
$width *= $scale_x; |
$height *= $scale_y; |
// Calculate the vertices of the image and write the OBJ record |
$this->_positionImage($col, $row, $x, $y, $width, $height); |
// Write the IMDATA record to store the bitmap data |
$record = 0x007f; |
$length = 8 + $size; |
$cf = 0x09; |
$env = 0x01; |
$lcb = $size; |
$header = pack("vvvvV", $record, $length, $cf, $env, $lcb); |
$this->_append($header.$data); |
} |
/** |
* Calculate the vertices that define the position of the image as required by |
* the OBJ record. |
* |
* +------------+------------+ |
* | A | B | |
* +-----+------------+------------+ |
* | |(x1,y1) | | |
* | 1 |(A1)._______|______ | |
* | | | | | |
* | | | | | |
* +-----+----| BITMAP |-----+ |
* | | | | | |
* | 2 | |______________. | |
* | | | (B2)| |
* | | | (x2,y2)| |
* +---- +------------+------------+ |
* |
* Example of a bitmap that covers some of the area from cell A1 to cell B2. |
* |
* Based on the width and height of the bitmap we need to calculate 8 vars: |
* $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2. |
* The width and height of the cells are also variable and have to be taken into |
* account. |
* The values of $col_start and $row_start are passed in from the calling |
* function. The values of $col_end and $row_end are calculated by subtracting |
* the width and height of the bitmap from the width and height of the |
* underlying cells. |
* The vertices are expressed as a percentage of the underlying cell width as |
* follows (rhs values are in pixels): |
* |
* x1 = X / W *1024 |
* y1 = Y / H *256 |
* x2 = (X-1) / W *1024 |
* y2 = (Y-1) / H *256 |
* |
* Where: X is distance from the left side of the underlying cell |
* Y is distance from the top of the underlying cell |
* W is the width of the cell |
* H is the height of the cell |
* |
* @access private |
* @note the SDK incorrectly states that the height should be expressed as a |
* percentage of 1024. |
* @param integer $col_start Col containing upper left corner of object |
* @param integer $row_start Row containing top left corner of object |
* @param integer $x1 Distance to left side of object |
* @param integer $y1 Distance to top of object |
* @param integer $width Width of image frame |
* @param integer $height Height of image frame |
*/ |
function _positionImage($col_start, $row_start, $x1, $y1, $width, $height) |
{ |
// Initialise end cell to the same as the start cell |
$col_end = $col_start; // Col containing lower right corner of object |
$row_end = $row_start; // Row containing bottom right corner of object |
// Zero the specified offset if greater than the cell dimensions |
if ($x1 >= $this->_sizeCol($col_start)) |
{ |
$x1 = 0; |
} |
if ($y1 >= $this->_sizeRow($row_start)) |
{ |
$y1 = 0; |
} |
$width = $width + $x1 -1; |
$height = $height + $y1 -1; |
// Subtract the underlying cell widths to find the end cell of the image |
while ($width >= $this->_sizeCol($col_end)) { |
$width -= $this->_sizeCol($col_end); |
$col_end++; |
} |
// Subtract the underlying cell heights to find the end cell of the image |
while ($height >= $this->_sizeRow($row_end)) { |
$height -= $this->_sizeRow($row_end); |
$row_end++; |
} |
// Bitmap isn't allowed to start or finish in a hidden cell, i.e. a cell |
// with zero eight or width. |
// |
if ($this->_sizeCol($col_start) == 0) |
return; |
if ($this->_sizeCol($col_end) == 0) |
return; |
if ($this->_sizeRow($row_start) == 0) |
return; |
if ($this->_sizeRow($row_end) == 0) |
return; |
// Convert the pixel values to the percentage value expected by Excel |
$x1 = $x1 / $this->_sizeCol($col_start) * 1024; |
$y1 = $y1 / $this->_sizeRow($row_start) * 256; |
$x2 = $width / $this->_sizeCol($col_end) * 1024; // Distance to right side of object |
$y2 = $height / $this->_sizeRow($row_end) * 256; // Distance to bottom of object |
$this->_storeObjPicture( $col_start, $x1, |
$row_start, $y1, |
$col_end, $x2, |
$row_end, $y2 |
); |
} |
/** |
* Convert the width of a cell from user's units to pixels. By interpolation |
* the relationship is: y = 7x +5. If the width hasn't been set by the user we |
* use the default value. If the col is hidden we use a value of zero. |
* |
* @access private |
* @param integer $col The column |
* @return integer The width in pixels |
*/ |
function _sizeCol($col) |
{ |
// Look up the cell value to see if it has been changed |
if (isset($this->col_sizes[$col])) { |
if ($this->col_sizes[$col] == 0) { |
return(0); |
} |
else { |
return(floor(7 * $this->col_sizes[$col] + 5)); |
} |
} |
else { |
return(64); |
} |
} |
/** |
* Convert the height of a cell from user's units to pixels. By interpolation |
* the relationship is: y = 4/3x. If the height hasn't been set by the user we |
* use the default value. If the row is hidden we use a value of zero. (Not |
* possible to hide row yet). |
* |
* @access private |
* @param integer $row The row |
* @return integer The width in pixels |
*/ |
function _sizeRow($row) |
{ |
// Look up the cell value to see if it has been changed |
if (isset($this->row_sizes[$row])) { |
if ($this->row_sizes[$row] == 0) { |
return(0); |
} |
else { |
return(floor(4/3 * $this->row_sizes[$row])); |
} |
} |
else { |
return(17); |
} |
} |
/** |
* Store the OBJ record that precedes an IMDATA record. This could be generalise |
* to support other Excel objects. |
* |
* @access private |
* @param integer $colL Column containing upper left corner of object |
* @param integer $dxL Distance from left side of cell |
* @param integer $rwT Row containing top left corner of object |
* @param integer $dyT Distance from top of cell |
* @param integer $colR Column containing lower right corner of object |
* @param integer $dxR Distance from right of cell |
* @param integer $rwB Row containing bottom right corner of object |
* @param integer $dyB Distance from bottom of cell |
*/ |
function _storeObjPicture($colL,$dxL,$rwT,$dyT,$colR,$dxR,$rwB,$dyB) |
{ |
$record = 0x005d; // Record identifier |
$length = 0x003c; // Bytes to follow |
$cObj = 0x0001; // Count of objects in file (set to 1) |
$OT = 0x0008; // Object type. 8 = Picture |
$id = 0x0001; // Object ID |
$grbit = 0x0614; // Option flags |
$cbMacro = 0x0000; // Length of FMLA structure |
$Reserved1 = 0x0000; // Reserved |
$Reserved2 = 0x0000; // Reserved |
$icvBack = 0x09; // Background colour |
$icvFore = 0x09; // Foreground colour |
$fls = 0x00; // Fill pattern |
$fAuto = 0x00; // Automatic fill |
$icv = 0x08; // Line colour |
$lns = 0xff; // Line style |
$lnw = 0x01; // Line weight |
$fAutoB = 0x00; // Automatic border |
$frs = 0x0000; // Frame style |
$cf = 0x0009; // Image format, 9 = bitmap |
$Reserved3 = 0x0000; // Reserved |
$cbPictFmla = 0x0000; // Length of FMLA structure |
$Reserved4 = 0x0000; // Reserved |
$grbit2 = 0x0001; // Option flags |
$Reserved5 = 0x0000; // Reserved |
$header = pack("vv", $record, $length); |
$data = pack("V", $cObj); |
$data .= pack("v", $OT); |
$data .= pack("v", $id); |
$data .= pack("v", $grbit); |
$data .= pack("v", $colL); |
$data .= pack("v", $dxL); |
$data .= pack("v", $rwT); |
$data .= pack("v", $dyT); |
$data .= pack("v", $colR); |
$data .= pack("v", $dxR); |
$data .= pack("v", $rwB); |
$data .= pack("v", $dyB); |
$data .= pack("v", $cbMacro); |
$data .= pack("V", $Reserved1); |
$data .= pack("v", $Reserved2); |
$data .= pack("C", $icvBack); |
$data .= pack("C", $icvFore); |
$data .= pack("C", $fls); |
$data .= pack("C", $fAuto); |
$data .= pack("C", $icv); |
$data .= pack("C", $lns); |
$data .= pack("C", $lnw); |
$data .= pack("C", $fAutoB); |
$data .= pack("v", $frs); |
$data .= pack("V", $cf); |
$data .= pack("v", $Reserved3); |
$data .= pack("v", $cbPictFmla); |
$data .= pack("v", $Reserved4); |
$data .= pack("v", $grbit2); |
$data .= pack("V", $Reserved5); |
$this->_append($header.$data); |
} |
/** |
* Convert a 24 bit bitmap into the modified internal format used by Windows. |
* This is described in BITMAPCOREHEADER and BITMAPCOREINFO structures in the |
* MSDN library. |
* |
* @access private |
* @param string $bitmap The bitmap to process |
* @return array Array with data and properties of the bitmap |
*/ |
function _processBitmap($bitmap) |
{ |
// Open file. |
$bmp_fd = @fopen($bitmap,"rb"); |
if (!$bmp_fd) { |
return($this->raiseError("Couldn't import $bitmap")); |
} |
// Slurp the file into a string. |
$data = fread($bmp_fd, filesize($bitmap)); |
// Check that the file is big enough to be a bitmap. |
if (strlen($data) <= 0x36) { |
return($this->raiseError("$bitmap doesn't contain enough data.\n")); |
} |
// The first 2 bytes are used to identify the bitmap. |
$identity = unpack("A2", $data); |
if ($identity[''] != "BM") { |
return($this->raiseError("$bitmap doesn't appear to be a valid bitmap image.\n")); |
} |
// Remove bitmap data: ID. |
$data = substr($data, 2); |
// Read and remove the bitmap size. This is more reliable than reading |
// the data size at offset 0x22. |
// |
$size_array = unpack("V", substr($data, 0, 4)); |
$size = $size_array['']; |
$data = substr($data, 4); |
$size -= 0x36; // Subtract size of bitmap header. |
$size += 0x0C; // Add size of BIFF header. |
// Remove bitmap data: reserved, offset, header length. |
$data = substr($data, 12); |
// Read and remove the bitmap width and height. Verify the sizes. |
$width_and_height = unpack("V2", substr($data, 0, 8)); |
$width = $width_and_height[1]; |
$height = $width_and_height[2]; |
$data = substr($data, 8); |
if ($width > 0xFFFF) { |
return($this->raiseError("$bitmap: largest image width supported is 65k.\n")); |
} |
if ($height > 0xFFFF) { |
return($this->raiseError("$bitmap: largest image height supported is 65k.\n")); |
} |
// Read and remove the bitmap planes and bpp data. Verify them. |
$planes_and_bitcount = unpack("v2", substr($data, 0, 4)); |
$data = substr($data, 4); |
if ($planes_and_bitcount[2] != 24) { // Bitcount |
return($this->raiseError("$bitmap isn't a 24bit true color bitmap.\n")); |
} |
if ($planes_and_bitcount[1] != 1) { |
return($this->raiseError("$bitmap: only 1 plane nupported in bitmap image.\n")); |
} |
// Read and remove the bitmap compression. Verify compression. |
$compression = unpack("V", substr($data, 0, 4)); |
$data = substr($data, 4); |
//$compression = 0; |
if ($compression[""] != 0) { |
return($this->raiseError("$bitmap: compression not supported in bitmap image.\n")); |
} |
// Remove bitmap data: data size, hres, vres, colours, imp. colours. |
$data = substr($data, 20); |
// Add the BITMAPCOREHEADER data |
$header = pack("Vvvvv", 0x000c, $width, $height, 0x01, 0x18); |
$data = $header . $data; |
return (array($width, $height, $size, $data)); |
} |
/** |
* Store the window zoom factor. This should be a reduced fraction but for |
* simplicity we will store all fractions with a numerator of 100. |
* |
* @access private |
*/ |
function _storeZoom() |
{ |
// If scale is 100 we don't need to write a record |
if ($this->_zoom == 100) { |
return; |
} |
$record = 0x00A0; // Record identifier |
$length = 0x0004; // Bytes to follow |
$header = pack("vv", $record, $length); |
$data = pack("vv", $this->_zoom, 100); |
$this->_append($header.$data); |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer/OLEwriter.php |
---|
New file |
0,0 → 1,428 |
<?php |
/* |
* Module written/ported by Xavier Noguer <xnoguer@rezebra.com> |
* |
* The majority of this is _NOT_ my code. I simply ported it from the |
* PERL Spreadsheet::WriteExcel module. |
* |
* The author of the Spreadsheet::WriteExcel module is John McNamara |
* <jmcnamara@cpan.org> |
* |
* I _DO_ maintain this code, and John McNamara has nothing to do with the |
* porting of this code to PHP. Any questions directly related to this |
* class library should be directed to me. |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
require_once('PEAR.php'); |
/** |
* Class for creating OLE streams for Excel Spreadsheets |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer_OLEwriter extends PEAR |
{ |
/** |
* Filename for the OLE stream |
* @var string |
* @see _initialize() |
*/ |
var $_OLEfilename; |
/** |
* Filehandle for the OLE stream |
* @var resource |
*/ |
var $_filehandle; |
/** |
* Name of the temporal file in case OLE stream goes to stdout |
* @var string |
*/ |
var $_tmp_filename; |
/** |
* Variable for preventing closing two times |
* @var integer |
*/ |
var $_fileclosed; |
/** |
* Size of the data to be written to the OLE stream |
* @var integer |
*/ |
var $_biffsize; |
/** |
* Real data size to be written to the OLE stream |
* @var integer |
*/ |
var $_booksize; |
/** |
* Number of big blocks in the OLE stream |
* @var integer |
*/ |
var $_big_blocks; |
/** |
* Number of list blocks in the OLE stream |
* @var integer |
*/ |
var $_list_blocks; |
/** |
* Number of big blocks in the OLE stream |
* @var integer |
*/ |
var $_root_start; |
/** |
* Constructor for the OLEwriter class |
* |
* @param string $OLEfilename the name of the file for the OLE stream |
*/ |
function Spreadsheet_Excel_Writer_OLEwriter($OLEfilename) |
{ |
$this->_OLEfilename = $OLEfilename; |
$this->_filehandle = ""; |
$this->_tmp_filename = ""; |
$this->_fileclosed = 0; |
$this->_biff_only = 0; |
//$this->_size_allowed = 0; |
$this->_biffsize = 0; |
$this->_booksize = 0; |
$this->_big_blocks = 0; |
$this->_list_blocks = 0; |
$this->_root_start = 0; |
//$this->_block_count = 4; |
$this->_initialize(); |
} |
/** |
* Check for a valid filename and store the filehandle. |
* Filehandle "-" writes to STDOUT |
* |
* @access private |
*/ |
function _initialize() |
{ |
$OLEfile = $this->_OLEfilename; |
if(($OLEfile == '-') or ($OLEfile == '')) |
{ |
$this->_tmp_filename = tempnam("/tmp", "OLEwriter"); |
$fh = fopen($this->_tmp_filename,"wb"); |
if ($fh == false) { |
$this->raiseError("Can't create temporary file."); |
} |
} |
else |
{ |
// Create a new file, open for writing (in binmode) |
$fh = fopen($OLEfile,"wb"); |
if ($fh == false) { |
$this->raiseError("Can't open $OLEfile. It may be in use or protected."); |
} |
} |
// Store filehandle |
$this->_filehandle = $fh; |
} |
/** |
* Set the size of the data to be written to the OLE stream. |
* The maximun size comes from this: |
* $big_blocks = (109 depot block x (128 -1 marker word) |
* - (1 x end words)) = 13842 |
* $maxsize = $big_blocks * 512 bytes = 7087104 |
* |
* @access public |
* @see Spreadsheet_Excel_Writer_Workbook::store_OLE_file() |
* @param integer $biffsize The size of the data to be written to the OLE stream |
* @return integer 1 for success |
*/ |
function setSize($biffsize) |
{ |
$maxsize = 7087104; // TODO: extend max size |
if ($biffsize > $maxsize) { |
$this->raiseError("Maximum file size, $maxsize, exceeded."); |
} |
$this->_biffsize = $biffsize; |
// Set the min file size to 4k to avoid having to use small blocks |
if ($biffsize > 4096) { |
$this->_booksize = $biffsize; |
} |
else { |
$this->_booksize = 4096; |
} |
//$this->_size_allowed = 1; |
return(1); |
} |
/** |
* Calculate various sizes needed for the OLE stream |
* |
* @access private |
*/ |
function _calculateSizes() |
{ |
$datasize = $this->_booksize; |
if ($datasize % 512 == 0) { |
$this->_big_blocks = $datasize/512; |
} |
else { |
$this->_big_blocks = floor($datasize/512) + 1; |
} |
// There are 127 list blocks and 1 marker blocks for each big block |
// depot + 1 end of chain block |
$this->_list_blocks = floor(($this->_big_blocks)/127) + 1; |
$this->_root_start = $this->_big_blocks; |
} |
/** |
* Write root entry, big block list and close the filehandle. |
* This routine is used to explicitly close the open filehandle without |
* having to wait for DESTROY. |
* |
* @access public |
* @see Spreadsheet_Excel_Writer_Workbook::store_OLE_file() |
*/ |
function close() |
{ |
//return if not $this->{_size_allowed}; |
$this->_writePadding(); |
$this->_writePropertyStorage(); |
$this->_writeBigBlockDepot(); |
// Close the filehandle |
fclose($this->_filehandle); |
if(($this->_OLEfilename == '-') or ($this->_OLEfilename == '')) |
{ |
$fh = fopen($this->_tmp_filename, "rb"); |
if ($fh == false) { |
$this->raiseError("Can't read temporary file."); |
} |
fpassthru($fh); |
@unlink($this->_tmp_filename); |
} |
$this->_fileclosed = 1; |
} |
/** |
* Write BIFF data to OLE file. |
* |
* @param string $data string of bytes to be written |
*/ |
function write($data) |
{ |
fwrite($this->_filehandle,$data,strlen($data)); |
} |
/** |
* Write OLE header block. |
*/ |
function writeHeader() |
{ |
$this->_calculateSizes(); |
$root_start = $this->_root_start; |
$num_lists = $this->_list_blocks; |
$id = pack("nnnn", 0xD0CF, 0x11E0, 0xA1B1, 0x1AE1); |
$unknown1 = pack("VVVV", 0x00, 0x00, 0x00, 0x00); |
$unknown2 = pack("vv", 0x3E, 0x03); |
$unknown3 = pack("v", -2); |
$unknown4 = pack("v", 0x09); |
$unknown5 = pack("VVV", 0x06, 0x00, 0x00); |
$num_bbd_blocks = pack("V", $num_lists); |
$root_startblock = pack("V", $root_start); |
$unknown6 = pack("VV", 0x00, 0x1000); |
$sbd_startblock = pack("V", -2); |
$unknown7 = pack("VVV", 0x00, -2 ,0x00); |
$unused = pack("V", -1); |
fwrite($this->_filehandle,$id); |
fwrite($this->_filehandle,$unknown1); |
fwrite($this->_filehandle,$unknown2); |
fwrite($this->_filehandle,$unknown3); |
fwrite($this->_filehandle,$unknown4); |
fwrite($this->_filehandle,$unknown5); |
fwrite($this->_filehandle,$num_bbd_blocks); |
fwrite($this->_filehandle,$root_startblock); |
fwrite($this->_filehandle,$unknown6); |
fwrite($this->_filehandle,$sbd_startblock); |
fwrite($this->_filehandle,$unknown7); |
for($i=1; $i <= $num_lists; $i++) |
{ |
$root_start++; |
fwrite($this->_filehandle,pack("V",$root_start)); |
} |
for($i = $num_lists; $i <=108; $i++) |
{ |
fwrite($this->_filehandle,$unused); |
} |
} |
/** |
* Write big block depot. |
* |
* @access private |
*/ |
function _writeBigBlockDepot() |
{ |
$num_blocks = $this->_big_blocks; |
$num_lists = $this->_list_blocks; |
$total_blocks = $num_lists *128; |
$used_blocks = $num_blocks + $num_lists +2; |
$marker = pack("V", -3); |
$end_of_chain = pack("V", -2); |
$unused = pack("V", -1); |
for($i=1; $i < $num_blocks; $i++) |
{ |
fwrite($this->_filehandle,pack("V",$i)); |
} |
fwrite($this->_filehandle,$end_of_chain); |
fwrite($this->_filehandle,$end_of_chain); |
for($i=0; $i < $num_lists; $i++) |
{ |
fwrite($this->_filehandle,$marker); |
} |
for($i=$used_blocks; $i <= $total_blocks; $i++) |
{ |
fwrite($this->_filehandle,$unused); |
} |
} |
/** |
* Write property storage. TODO: add summary sheets |
* |
* @access private |
*/ |
function _writePropertyStorage() |
{ |
//$rootsize = -2; |
/*************** name type dir start size */ |
$this->_writePps("Root Entry", 0x05, 1, -2, 0x00); |
$this->_writePps("Book", 0x02, -1, 0x00, $this->_booksize); |
$this->_writePps('', 0x00, -1, 0x00, 0x0000); |
$this->_writePps('', 0x00, -1, 0x00, 0x0000); |
} |
/** |
* Write property sheet in property storage |
* |
* @param string $name name of the property storage. |
* @param integer $type type of the property storage. |
* @param integer $dir dir of the property storage. |
* @param integer $start start of the property storage. |
* @param integer $size size of the property storage. |
* @access private |
*/ |
function _writePps($name,$type,$dir,$start,$size) |
{ |
$length = 0; |
$rawname = ''; |
if ($name != '') |
{ |
$name = $name . "\0"; |
for($i=0;$i<strlen($name);$i++) |
{ |
// Simulate a Unicode string |
$rawname .= pack("H*",dechex(ord($name{$i}))).pack("C",0); |
} |
$length = strlen($name) * 2; |
} |
$zero = pack("C", 0); |
$pps_sizeofname = pack("v", $length); // 0x40 |
$pps_type = pack("v", $type); // 0x42 |
$pps_prev = pack("V", -1); // 0x44 |
$pps_next = pack("V", -1); // 0x48 |
$pps_dir = pack("V", $dir); // 0x4c |
$unknown1 = pack("V", 0); |
$pps_ts1s = pack("V", 0); // 0x64 |
$pps_ts1d = pack("V", 0); // 0x68 |
$pps_ts2s = pack("V", 0); // 0x6c |
$pps_ts2d = pack("V", 0); // 0x70 |
$pps_sb = pack("V", $start); // 0x74 |
$pps_size = pack("V", $size); // 0x78 |
fwrite($this->_filehandle,$rawname); |
for($i=0; $i < (64 -$length); $i++) { |
fwrite($this->_filehandle,$zero); |
} |
fwrite($this->_filehandle,$pps_sizeofname); |
fwrite($this->_filehandle,$pps_type); |
fwrite($this->_filehandle,$pps_prev); |
fwrite($this->_filehandle,$pps_next); |
fwrite($this->_filehandle,$pps_dir); |
for($i=0; $i < 5; $i++) { |
fwrite($this->_filehandle,$unknown1); |
} |
fwrite($this->_filehandle,$pps_ts1s); |
fwrite($this->_filehandle,$pps_ts1d); |
fwrite($this->_filehandle,$pps_ts2d); |
fwrite($this->_filehandle,$pps_ts2d); |
fwrite($this->_filehandle,$pps_sb); |
fwrite($this->_filehandle,$pps_size); |
fwrite($this->_filehandle,$unknown1); |
} |
/** |
* Pad the end of the file |
* |
* @access private |
*/ |
function _writePadding() |
{ |
$biffsize = $this->_biffsize; |
if ($biffsize < 4096) { |
$min_size = 4096; |
} |
else { |
$min_size = 512; |
} |
if ($biffsize % $min_size != 0) |
{ |
$padding = $min_size - ($biffsize % $min_size); |
for($i=0; $i < $padding; $i++) { |
fwrite($this->_filehandle,"\0"); |
} |
} |
} |
} |
?> |
/trunk/applications/jrest/lib/Spreadsheet/Excel/Writer/Parser.php |
---|
New file |
0,0 → 1,1551 |
<?php |
/** |
* Class for parsing Excel formulas |
* |
* License Information: |
* |
* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets |
* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com |
* |
* This library is free software; you can redistribute it and/or |
* modify it under the terms of the GNU Lesser General Public |
* License as published by the Free Software Foundation; either |
* version 2.1 of the License, or (at your option) any later version. |
* |
* This library is distributed in the hope that it will be useful, |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
* Lesser General Public License for more details. |
* |
* You should have received a copy of the GNU Lesser General Public |
* License along with this library; if not, write to the Free Software |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
*/ |
/** |
* @const SPREADSHEET_EXCEL_WRITER_ADD token identifier for character "+" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_ADD',"+"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_SUB token identifier for character "-" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_SUB',"-"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_MUL token identifier for character "*" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_MUL',"*"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_DIV token identifier for character "/" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_DIV',"/"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_OPEN token identifier for character "(" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_OPEN',"("); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_CLOSE token identifier for character ")" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_CLOSE',")"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_COMA token identifier for character "," |
*/ |
define('SPREADSHEET_EXCEL_WRITER_COMA',","); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_GT token identifier for character ">" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_GT',">"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_LT token identifier for character "<" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_LT',"<"); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_LE token identifier for character "<=" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_LE',"<="); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_GE token identifier for character ">=" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_GE',">="); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_EQ token identifier for character "=" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_EQ',"="); |
/** |
* @const SPREADSHEET_EXCEL_WRITER_NE token identifier for character "<>" |
*/ |
define('SPREADSHEET_EXCEL_WRITER_NE',"<>"); |
require_once('PEAR.php'); |
/** |
* Class for parsing Excel formulas |
* |
* @author Xavier Noguer <xnoguer@rezebra.com> |
* @category FileFormats |
* @package Spreadsheet_Excel_Writer |
*/ |
class Spreadsheet_Excel_Writer_Parser extends PEAR |
{ |
/** |
* The index of the character we are currently looking at |
* @var integer |
*/ |
var $_current_char; |
/** |
* The token we are working on. |
* @var string |
*/ |
var $_current_token; |
/** |
* The formula to parse |
* @var string |
*/ |
var $_formula; |
/** |
* The character ahead of the current char |
* @var string |
*/ |
var $_lookahead; |
/** |
* The parse tree to be generated |
* @var string |
*/ |
var $_parse_tree; |
/** |
* The byte order. 1 => big endian, 0 => little endian. |
* @var integer |
*/ |
var $_byte_order; |
/** |
* Number of arguments for the current function |
* @var integer |
*/ |
var $_func_args; |
/** |
* Array of external sheets |
* @var array |
*/ |
var $_ext_sheets; |
/** |
* The class constructor |
* |
* @param integer $byte_order The byte order (Little endian or Big endian) of the architecture |
(optional). 1 => big endian, 0 (default) => little endian. |
*/ |
function Spreadsheet_Excel_Writer_Parser($byte_order = 0) |
{ |
$this->_current_char = 0; |
$this->_current_token = ''; // The token we are working on. |
$this->_formula = ""; // The formula to parse. |
$this->_lookahead = ''; // The character ahead of the current char. |
$this->_parse_tree = ''; // The parse tree to be generated. |
$this->_initializeHashes(); // Initialize the hashes: ptg's and function's ptg's |
$this->_byte_order = $byte_order; // Little Endian or Big Endian |
$this->_func_args = 0; // Number of arguments for the current function |
$this->_ext_sheets = array(); |
} |
/** |
* Initialize the ptg and function hashes. |
* |
* @access private |
*/ |
function _initializeHashes() |
{ |
// The Excel ptg indices |
$this->ptg = array( |
'ptgExp' => 0x01, |
'ptgTbl' => 0x02, |
'ptgAdd' => 0x03, |
'ptgSub' => 0x04, |
'ptgMul' => 0x05, |
'ptgDiv' => 0x06, |
'ptgPower' => 0x07, |
'ptgConcat' => 0x08, |
'ptgLT' => 0x09, |
'ptgLE' => 0x0A, |
'ptgEQ' => 0x0B, |
'ptgGE' => 0x0C, |
'ptgGT' => 0x0D, |
'ptgNE' => 0x0E, |
'ptgIsect' => 0x0F, |
'ptgUnion' => 0x10, |
'ptgRange' => 0x11, |
'ptgUplus' => 0x12, |
'ptgUminus' => 0x13, |
'ptgPercent' => 0x14, |
'ptgParen' => 0x15, |
'ptgMissArg' => 0x16, |
'ptgStr' => 0x17, |
'ptgAttr' => 0x19, |
'ptgSheet' => 0x1A, |
'ptgEndSheet' => 0x1B, |
'ptgErr' => 0x1C, |
'ptgBool' => 0x1D, |
'ptgInt' => 0x1E, |
'ptgNum' => 0x1F, |
'ptgArray' => 0x20, |
'ptgFunc' => 0x21, |
'ptgFuncVar' => 0x22, |
'ptgName' => 0x23, |
'ptgRef' => 0x24, |
'ptgArea' => 0x25, |
'ptgMemArea' => 0x26, |
'ptgMemErr' => 0x27, |
'ptgMemNoMem' => 0x28, |
'ptgMemFunc' => 0x29, |
'ptgRefErr' => 0x2A, |
'ptgAreaErr' => 0x2B, |
'ptgRefN' => 0x2C, |
'ptgAreaN' => 0x2D, |
'ptgMemAreaN' => 0x2E, |
'ptgMemNoMemN' => 0x2F, |
'ptgNameX' => 0x39, |
'ptgRef3d' => 0x3A, |
'ptgArea3d' => 0x3B, |
'ptgRefErr3d' => 0x3C, |
'ptgAreaErr3d' => 0x3D, |
'ptgArrayV' => 0x40, |
'ptgFuncV' => 0x41, |
'ptgFuncVarV' => 0x42, |
'ptgNameV' => 0x43, |
'ptgRefV' => 0x44, |
'ptgAreaV' => 0x45, |
'ptgMemAreaV' => 0x46, |
'ptgMemErrV' => 0x47, |
'ptgMemNoMemV' => 0x48, |
'ptgMemFuncV' => 0x49, |
'ptgRefErrV' => 0x4A, |
'ptgAreaErrV' => 0x4B, |
'ptgRefNV' => 0x4C, |
'ptgAreaNV' => 0x4D, |
'ptgMemAreaNV' => 0x4E, |
'ptgMemNoMemN' => 0x4F, |
'ptgFuncCEV' => 0x58, |
'ptgNameXV' => 0x59, |
'ptgRef3dV' => 0x5A, |
'ptgArea3dV' => 0x5B, |
'ptgRefErr3dV' => 0x5C, |
'ptgAreaErr3d' => 0x5D, |
'ptgArrayA' => 0x60, |
'ptgFuncA' => 0x61, |
'ptgFuncVarA' => 0x62, |
'ptgNameA' => 0x63, |
'ptgRefA' => 0x64, |
'ptgAreaA' => 0x65, |
'ptgMemAreaA' => 0x66, |
'ptgMemErrA' => 0x67, |
'ptgMemNoMemA' => 0x68, |
'ptgMemFuncA' => 0x69, |
'ptgRefErrA' => 0x6A, |
'ptgAreaErrA' => 0x6B, |
'ptgRefNA' => 0x6C, |
'ptgAreaNA' => 0x6D, |
'ptgMemAreaNA' => 0x6E, |
'ptgMemNoMemN' => 0x6F, |
'ptgFuncCEA' => 0x78, |
'ptgNameXA' => 0x79, |
'ptgRef3dA' => 0x7A, |
'ptgArea3dA' => 0x7B, |
'ptgRefErr3dA' => 0x7C, |
'ptgAreaErr3d' => 0x7D |
); |
// Thanks to Michael Meeks and Gnumeric for the initial arg values. |
// |
// The following hash was generated by "function_locale.pl" in the distro. |
// Refer to function_locale.pl for non-English function names. |
// |
// The array elements are as follow: |
// ptg: The Excel function ptg code. |
// args: The number of arguments that the function takes: |
// >=0 is a fixed number of arguments. |
// -1 is a variable number of arguments. |
// class: The reference, value or array class of the function args. |
// vol: The function is volatile. |
// |
$this->_functions = array( |
// function ptg args class vol |
'COUNT' => array( 0, -1, 0, 0 ), |
'IF' => array( 1, -1, 1, 0 ), |
'ISNA' => array( 2, 1, 1, 0 ), |
'ISERROR' => array( 3, 1, 1, 0 ), |
'SUM' => array( 4, -1, 0, 0 ), |
'AVERAGE' => array( 5, -1, 0, 0 ), |
'MIN' => array( 6, -1, 0, 0 ), |
'MAX' => array( 7, -1, 0, 0 ), |
'ROW' => array( 8, -1, 0, 0 ), |
'COLUMN' => array( 9, -1, 0, 0 ), |
'NA' => array( 10, 0, 0, 0 ), |
'NPV' => array( 11, -1, 1, 0 ), |
'STDEV' => array( 12, -1, 0, 0 ), |
'DOLLAR' => array( 13, -1, 1, 0 ), |
'FIXED' => array( 14, -1, 1, 0 ), |
'SIN' => array( 15, 1, 1, 0 ), |
'COS' => array( 16, 1, 1, 0 ), |
'TAN' => array( 17, 1, 1, 0 ), |
'ATAN' => array( 18, 1, 1, 0 ), |
'PI' => array( 19, 0, 1, 0 ), |
'SQRT' => array( 20, 1, 1, 0 ), |
'EXP' => array( 21, 1, 1, 0 ), |
'LN' => array( 22, 1, 1, 0 ), |
'LOG10' => array( 23, 1, 1, 0 ), |
'ABS' => array( 24, 1, 1, 0 ), |
'INT' => array( 25, 1, 1, 0 ), |
'SIGN' => array( 26, 1, 1, 0 ), |
'ROUND' => array( 27, 2, 1, 0 ), |
'LOOKUP' => array( 28, -1, 0, 0 ), |
'INDEX' => array( 29, -1, 0, 1 ), |
'REPT' => array( 30, 2, 1, 0 ), |
'MID' => array( 31, 3, 1, 0 ), |
'LEN' => array( 32, 1, 1, 0 ), |
'VALUE' => array( 33, 1, 1, 0 ), |
'TRUE' => array( 34, 0, 1, 0 ), |
'FALSE' => array( 35, 0, 1, 0 ), |
'AND' => array( 36, -1, 0, 0 ), |
'OR' => array( 37, -1, 0, 0 ), |
'NOT' => array( 38, 1, 1, 0 ), |
'MOD' => array( 39, 2, 1, 0 ), |
'DCOUNT' => array( 40, 3, 0, 0 ), |
'DSUM' => array( 41, 3, 0, 0 ), |
'DAVERAGE' => array( 42, 3, 0, 0 ), |
'DMIN' => array( 43, 3, 0, 0 ), |
'DMAX' => array( 44, 3, 0, 0 ), |
'DSTDEV' => array( 45, 3, 0, 0 ), |
'VAR' => array( 46, -1, 0, 0 ), |
'DVAR' => array( 47, 3, 0, 0 ), |
'TEXT' => array( 48, 2, 1, 0 ), |
'LINEST' => array( 49, -1, 0, 0 ), |
'TREND' => array( 50, -1, 0, 0 ), |
'LOGEST' => array( 51, -1, 0, 0 ), |
'GROWTH' => array( 52, -1, 0, 0 ), |
'PV' => array( 56, -1, 1, 0 ), |
'FV' => array( 57, -1, 1, 0 ), |
'NPER' => array( 58, -1, 1, 0 ), |
'PMT' => array( 59, -1, 1, 0 ), |
'RATE' => array( 60, -1, 1, 0 ), |
'MIRR' => array( 61, 3, 0, 0 ), |
'IRR' => array( 62, -1, 0, 0 ), |
'RAND' => array( 63, 0, 1, 1 ), |
'MATCH' => array( 64, -1, 0, 0 ), |
'DATE' => array( 65, 3, 1, 0 ), |
'TIME' => array( 66, 3, 1, 0 ), |
'DAY' => array( 67, 1, 1, 0 ), |
'MONTH' => array( 68, 1, 1, 0 ), |
'YEAR' => array( 69, 1, 1, 0 ), |
'WEEKDAY' => array( 70, -1, 1, 0 ), |
'HOUR' => array( 71, 1, 1, 0 ), |
'MINUTE' => array( 72, 1, 1, 0 ), |
'SECOND' => array( 73, 1, 1, 0 ), |
'NOW' => array( 74, 0, 1, 1 ), |
'AREAS' => array( 75, 1, 0, 1 ), |
'ROWS' => array( 76, 1, 0, 1 ), |
'COLUMNS' => array( 77, 1, 0, 1 ), |
'OFFSET' => array( 78, -1, 0, 1 ), |
'SEARCH' => array( 82, -1, 1, 0 ), |
'TRANSPOSE' => array( 83, 1, 1, 0 ), |
'TYPE' => array( 86, 1, 1, 0 ), |
'ATAN2' => array( 97, 2, 1, 0 ), |
'ASIN' => array( 98, 1, 1, 0 ), |
'ACOS' => array( 99, 1, 1, 0 ), |
'CHOOSE' => array( 100, -1, 1, 0 ), |
'HLOOKUP' => array( 101, -1, 0, 0 ), |
'VLOOKUP' => array( 102, -1, 0, 0 ), |
'ISREF' => array( 105, 1, 0, 0 ), |
'LOG' => array( 109, -1, 1, 0 ), |
'CHAR' => array( 111, 1, 1, 0 ), |
'LOWER' => array( 112, 1, 1, 0 ), |
'UPPER' => array( 113, 1, 1, 0 ), |
'PROPER' => array( 114, 1, 1, 0 ), |
'LEFT' => array( 115, -1, 1, 0 ), |
'RIGHT' => array( 116, -1, 1, 0 ), |
'EXACT' => array( 117, 2, 1, 0 ), |
'TRIM' => array( 118, 1, 1, 0 ), |
'REPLACE' => array( 119, 4, 1, 0 ), |
'SUBSTITUTE' => array( 120, -1, 1, 0 ), |
'CODE' => array( 121, 1, 1, 0 ), |
'FIND' => array( 124, -1, 1, 0 ), |
'CELL' => array( 125, -1, 0, 1 ), |
'ISERR' => array( 126, 1, 1, 0 ), |
'ISTEXT' => array( 127, 1, 1, 0 ), |
'ISNUMBER' => array( 128, 1, 1, 0 ), |
'ISBLANK' => array( 129, 1, 1, 0 ), |
'T' => array( 130, 1, 0, 0 ), |
'N' => array( 131, 1, 0, 0 ), |
'DATEVALUE' => array( 140, 1, 1, 0 ), |
'TIMEVALUE' => array( 141, 1, 1, 0 ), |
'SLN' => array( 142, 3, 1, 0 ), |
'SYD' => array( 143, 4, 1, 0 ), |
'DDB' => array( 144, -1, 1, 0 ), |
'INDIRECT' => array( 148, -1, 1, 1 ), |
'CALL' => array( 150, -1, 1, 0 ), |
'CLEAN' => array( 162, 1, 1, 0 ), |
'MDETERM' => array( 163, 1, 2, 0 ), |
'MINVERSE' => array( 164, 1, 2, 0 ), |
'MMULT' => array( 165, 2, 2, 0 ), |
'IPMT' => array( 167, -1, 1, 0 ), |
'PPMT' => array( 168, -1, 1, 0 ), |
'COUNTA' => array( 169, -1, 0, 0 ), |
'PRODUCT' => array( 183, -1, 0, 0 ), |
'FACT' => array( 184, 1, 1, 0 ), |
'DPRODUCT' => array( 189, 3, 0, 0 ), |
'ISNONTEXT' => array( 190, 1, 1, 0 ), |
'STDEVP' => array( 193, -1, 0, 0 ), |
'VARP' => array( 194, -1, 0, 0 ), |
'DSTDEVP' => array( 195, 3, 0, 0 ), |
'DVARP' => array( 196, 3, 0, 0 ), |
'TRUNC' => array( 197, -1, 1, 0 ), |
'ISLOGICAL' => array( 198, 1, 1, 0 ), |
'DCOUNTA' => array( 199, 3, 0, 0 ), |
'ROUNDUP' => array( 212, 2, 1, 0 ), |
'ROUNDDOWN' => array( 213, 2, 1, 0 ), |
'RANK' => array( 216, -1, 0, 0 ), |
'ADDRESS' => array( 219, -1, 1, 0 ), |
'DAYS360' => array( 220, -1, 1, 0 ), |
'TODAY' => array( 221, 0, 1, 1 ), |
'VDB' => array( 222, -1, 1, 0 ), |
'MEDIAN' => array( 227, -1, 0, 0 ), |
'SUMPRODUCT' => array( 228, -1, 2, 0 ), |
'SINH' => array( 229, 1, 1, 0 ), |
'COSH' => array( 230, 1, 1, 0 ), |
'TANH' => array( 231, 1, 1, 0 ), |
'ASINH' => array( 232, 1, 1, 0 ), |
'ACOSH' => array( 233, 1, 1, 0 ), |
'ATANH' => array( 234, 1, 1, 0 ), |
'DGET' => array( 235, 3, 0, 0 ), |
'INFO' => array( 244, 1, 1, 1 ), |
'DB' => array( 247, -1, 1, 0 ), |
'FREQUENCY' => array( 252, 2, 0, 0 ), |
'ERROR.TYPE' => array( 261, 1, 1, 0 ), |
'REGISTER.ID' => array( 267, -1, 1, 0 ), |
'AVEDEV' => array( 269, -1, 0, 0 ), |
'BETADIST' => array( 270, -1, 1, 0 ), |
'GAMMALN' => array( 271, 1, 1, 0 ), |
'BETAINV' => array( 272, -1, 1, 0 ), |
'BINOMDIST' => array( 273, 4, 1, 0 ), |
'CHIDIST' => array( 274, 2, 1, 0 ), |
'CHIINV' => array( 275, 2, 1, 0 ), |
'COMBIN' => array( 276, 2, 1, 0 ), |
'CONFIDENCE' => array( 277, 3, 1, 0 ), |
'CRITBINOM' => array( 278, 3, 1, 0 ), |
'EVEN' => array( 279, 1, 1, 0 ), |
'EXPONDIST' => array( 280, 3, 1, 0 ), |
'FDIST' => array( 281, 3, 1, 0 ), |
'FINV' => array( 282, 3, 1, 0 ), |
'FISHER' => array( 283, 1, 1, 0 ), |
'FISHERINV' => array( 284, 1, 1, 0 ), |
'FLOOR' => array( 285, 2, 1, 0 ), |
'GAMMADIST' => array( 286, 4, 1, 0 ), |
'GAMMAINV' => array( 287, 3, 1, 0 ), |
'CEILING' => array( 288, 2, 1, 0 ), |
'HYPGEOMDIST' => array( 289, 4, 1, 0 ), |
'LOGNORMDIST' => array( 290, 3, 1, 0 ), |
'LOGINV' => array( 291, 3, 1, 0 ), |
'NEGBINOMDIST' => array( 292, 3, 1, 0 ), |
'NORMDIST' => array( 293, 4, 1, 0 ), |
'NORMSDIST' => array( 294, 1, 1, 0 ), |
'NORMINV' => array( 295, 3, 1, 0 ), |
'NORMSINV' => array( 296, 1, 1, 0 ), |
'STANDARDIZE' => array( 297, 3, 1, 0 ), |
'ODD' => array( 298, 1, 1, 0 ), |
'PERMUT' => array( 299, 2, 1, 0 ), |
'POISSON' => array( 300, 3, 1, 0 ), |
'TDIST' => array( 301, 3, 1, 0 ), |
'WEIBULL' => array( 302, 4, 1, 0 ), |
'SUMXMY2' => array( 303, 2, 2, 0 ), |
'SUMX2MY2' => array( 304, 2, 2, 0 ), |
'SUMX2PY2' => array( 305, 2, 2, 0 ), |
'CHITEST' => array( 306, 2, 2, 0 ), |
'CORREL' => array( 307, 2, 2, 0 ), |
'COVAR' => array( 308, 2, 2, 0 ), |
'FORECAST' => array( 309, 3, 2, 0 ), |
'FTEST' => array( 310, 2, 2, 0 ), |
'INTERCEPT' => array( 311, 2, 2, 0 ), |
'PEARSON' => array( 312, 2, 2, 0 ), |
'RSQ' => array( 313, 2, 2, 0 ), |
'STEYX' => array( 314, 2, 2, 0 ), |
'SLOPE' => array( 315, 2, 2, 0 ), |
'TTEST' => array( 316, 4, 2, 0 ), |
'PROB' => array( 317, -1, 2, 0 ), |
'DEVSQ' => array( 318, -1, 0, 0 ), |
'GEOMEAN' => array( 319, -1, 0, 0 ), |
'HARMEAN' => array( 320, -1, 0, 0 ), |
'SUMSQ' => array( 321, -1, 0, 0 ), |
'KURT' => array( 322, -1, 0, 0 ), |
'SKEW' => array( 323, -1, 0, 0 ), |
'ZTEST' => array( 324, -1, 0, 0 ), |
'LARGE' => array( 325, 2, 0, 0 ), |
'SMALL' => array( 326, 2, 0, 0 ), |
'QUARTILE' => array( 327, 2, 0, 0 ), |
'PERCENTILE' => array( 328, 2, 0, 0 ), |
'PERCENTRANK' => array( 329, -1, 0, 0 ), |
'MODE' => array( 330, -1, 2, 0 ), |
'TRIMMEAN' => array( 331, 2, 0, 0 ), |
'TINV' => array( 332, 2, 1, 0 ), |
'CONCATENATE' => array( 336, -1, 1, 0 ), |
'POWER' => array( 337, 2, 1, 0 ), |
'RADIANS' => array( 342, 1, 1, 0 ), |
'DEGREES' => array( 343, 1, 1, 0 ), |
'SUBTOTAL' => array( 344, -1, 0, 0 ), |
'SUMIF' => array( 345, -1, 0, 0 ), |
'COUNTIF' => array( 346, 2, 0, 0 ), |
'COUNTBLANK' => array( 347, 1, 0, 0 ), |
'ROMAN' => array( 354, -1, 1, 0 ) |
); |
} |
/** |
* Convert a token to the proper ptg value. |
* |
* @access private |
* @param mixed $token The token to convert. |
*/ |
function _convert($token) |
{ |
if (preg_match("/^\"[^\"]{0,255}\"$/", $token)) |
{ |
return $this->_convertString($token); |
} |
elseif (is_numeric($token)) |
{ |
return $this->_convertNumber($token); |
} |
// match references like A1 or $A$1 |
elseif(preg_match('/^\$?([A-I]?[A-Z])\$?(\d+)$/',$token)) |
{ |
return($this->_convertRef2d($token)); |
} |
// match external references like Sheet1:Sheet2!A1 |
elseif (preg_match("/^[A-Za-z0-9_]+(\:[A-Za-z0-9_]+)?\![A-I]?[A-Z](\d+)$/",$token)) |
{ |
return $this->_convertRef3d($token); |
} |
// match ranges like A1:B2 |
elseif(preg_match("/^(\$)?[A-I]?[A-Z](\$)?(\d+)\:(\$)?[A-I]?[A-Z](\$)?(\d+)$/",$token)) |
{ |
return($this->_convertRange2d($token)); |
} |
// match ranges like A1..B2 |
elseif(preg_match("/^(\$)?[A-I]?[A-Z](\$)?(\d+)\.\.(\$)?[A-I]?[A-Z](\$)?(\d+)$/",$token)) |
{ |
return($this->_convertRange2d($token)); |
} |
// match external ranges like Sheet1:Sheet2!A1:B2 |
elseif (preg_match("/^[A-Za-z0-9_]+(\:[A-Za-z0-9_]+)?\!([A-I]?[A-Z])?(\d+)\:([A-I]?[A-Z])?(\d+)$/",$token)) |
{ |
return $this->_convertRange3d($token); |
} |
elseif(isset($this->ptg[$token])) // operators (including parentheses) |
{ |
return(pack("C", $this->ptg[$token])); |
} |
elseif(preg_match("/[A-Z0-9\xc0-\xdc\.]+/",$token)) |
{ |
return($this->_convertFunction($token,$this->_func_args)); |
} |
// if it's an argument, ignore the token (the argument remains) |
elseif($token == 'arg') |
{ |
$this->_func_args++; |
return(''); |
} |
// TODO: use real error codes |
$this->raiseError("Unknown token $token", 0, PEAR_ERROR_DIE); |
} |
/** |
* Convert a number token to ptgInt or ptgNum |
* |
* @access private |
* @param mixed $num an integer or double for conversion to its ptg value |
*/ |
function _convertNumber($num) |
{ |
// Integer in the range 0..2**16-1 |
if ((preg_match("/^\d+$/",$num)) and ($num <= 65535)) { |
return(pack("Cv", $this->ptg['ptgInt'], $num)); |
} |
else // A float |
{ |
if($this->_byte_order) // if it's Big Endian |
{ |
$num = strrev($num); |
} |
return(pack("Cd", $this->ptg['ptgNum'], $num)); |
} |
} |
/** |
* Convert a string token to ptgStr |
* |
* @access private |
* @param string $string A string for conversion to its ptg value |
*/ |
function _convertString($string) |
{ |
// chop away beggining and ending quotes |
$string = substr($string, 1, strlen($string) - 2); |
return pack("CC", $this->ptg['ptgStr'], strlen($string)).$string; |
} |
/** |
* Convert a function to a ptgFunc or ptgFuncVarV depending on the number of |
* args that it takes. |
* |
* @access private |
* @param string $token The name of the function for convertion to ptg value. |
* @param integer $num_args The number of arguments the function recieves. |
*/ |
function _convertFunction($token, $num_args) |
{ |
$this->_func_args = 0; // re initialize the number of arguments |
$args = $this->_functions[$token][1]; |
$volatile = $this->_functions[$token][3]; |
// Fixed number of args eg. TIME($i,$j,$k). |
if ($args >= 0) { |
return(pack("Cv", $this->ptg['ptgFuncV'], $this->_functions[$token][0])); |
} |
// Variable number of args eg. SUM($i,$j,$k, ..). |
if ($args == -1) { |
return(pack("CCv", $this->ptg['ptgFuncVarV'], $num_args, $this->_functions[$token][0])); |
} |
} |
/** |
* Convert an Excel range such as A1:D4 to a ptgRefV. |
* |
* @access private |
* @param string $range An Excel range in the A1:A2 or A1..A2 format. |
*/ |
function _convertRange2d($range) |
{ |
$class = 2; // as far as I know, this is magick. |
// Split the range into 2 cell refs |
if(preg_match("/^([A-I]?[A-Z])(\d+)\:([A-I]?[A-Z])(\d+)$/",$range)) { |
list($cell1, $cell2) = split(':', $range); |
} |
elseif(preg_match("/^([A-I]?[A-Z])(\d+)\.\.([A-I]?[A-Z])(\d+)$/",$range)) { |
list($cell1, $cell2) = split('\.\.', $range); |
} |
else { |
// TODO: use real error codes |
$this->raiseError("Unknown range separator", 0, PEAR_ERROR_DIE); |
} |
// Convert the cell references |
$cell_array1 = $this->_cellToPackedRowcol($cell1); |
if($this->isError($cell_array1)) { |
return($cell_array1); |
} |
list($row1, $col1) = $cell_array1; //$this->_cellToPackedRowcol($cell1); |
$cell_array2 = $this->_cellToPackedRowcol($cell2); |
if($this->isError($cell_array2)) { |
return($cell_array2); |
} |
list($row2, $col2) = $cell_array2; //$this->_cellToPackedRowcol($cell2); |
// The ptg value depends on the class of the ptg. |
if ($class == 0) { |
$ptgArea = pack("C", $this->ptg['ptgArea']); |
} |
elseif ($class == 1) { |
$ptgArea = pack("C", $this->ptg['ptgAreaV']); |
} |
elseif ($class == 2) { |
$ptgArea = pack("C", $this->ptg['ptgAreaA']); |
} |
else { |
// TODO: use real error codes |
$this->raiseError("Unknown class $class", 0, PEAR_ERROR_DIE); |
} |
return($ptgArea . $row1 . $row2 . $col1. $col2); |
} |
/** |
* Convert an Excel 3d range such as "Sheet1!A1:D4" or "Sheet1:Sheet2!A1:D4" to |
* a ptgArea3dV. |
* |
* @access private |
* @param string $token An Excel range in the Sheet1!A1:A2 format. |
*/ |
function _convertRange3d($token) |
{ |
$class = 2; // as far as I know, this is magick. |
// Split the ref at the ! symbol |
list($ext_ref, $range) = split('!', $token); |
// Convert the external reference part |
$ext_ref = $this->_packExtRef($ext_ref); |
if ($this->isError($ext_ref)) { |
return $ext_ref; |
} |
// Split the range into 2 cell refs |
list($cell1, $cell2) = split(':', $range); |
// Convert the cell references |
if (preg_match("/^(\$)?[A-I]?[A-Z](\$)?(\d+)$/", $cell1)) |
{ |
$cell_array1 = $this->_cellToPackedRowcol($cell1); |
if (PEAR::isError($cell_array1)) { |
return $cell_array1; |
} |
list($row1, $col1) = $cell_array1; |
$cell_array2 = $this->_cellToPackedRowcol($cell2); |
if (PEAR::isError($cell_array2)) { |
return $cell_array2; |
} |
list($row2, $col2) = $cell_array2; |
} |
else { // It's a columns range (like 26:27) |
$cells_array = $this->_rangeToPackedRange($cell1.':'.$cell2); |
if (PEAR::isError($cells_array)) { |
return $cells_array; |
} |
list($row1, $col1, $row2, $col2) = $cells_array; |
} |
// The ptg value depends on the class of the ptg. |
if ($class == 0) { |
$ptgArea = pack("C", $this->ptg['ptgArea3d']); |
} |
elseif ($class == 1) { |
$ptgArea = pack("C", $this->ptg['ptgArea3dV']); |
} |
elseif ($class == 2) { |
$ptgArea = pack("C", $this->ptg['ptgArea3dA']); |
} |
else { |
$this->raiseError("Unknown class $class", 0, PEAR_ERROR_DIE); |
} |
return $ptgArea . $ext_ref . $row1 . $row2 . $col1. $col2; |
} |
/** |
* Convert an Excel reference such as A1, $B2, C$3 or $D$4 to a ptgRefV. |
* |
* @access private |
* @param string $cell An Excel cell reference |
* @return string The cell in packed() format with the corresponding ptg |
*/ |
function _convertRef2d($cell) |
{ |
$class = 2; // as far as I know, this is magick. |
// Convert the cell reference |
$cell_array = $this->_cellToPackedRowcol($cell); |
if($this->isError($cell_array)) { |
return($cell_array); |
} |
list($row, $col) = $cell_array; |
// The ptg value depends on the class of the ptg. |
if ($class == 0) { |
$ptgRef = pack("C", $this->ptg['ptgRef']); |
} |
elseif ($class == 1) { |
$ptgRef = pack("C", $this->ptg['ptgRefV']); |
} |
elseif ($class == 2) { |
$ptgRef = pack("C", $this->ptg['ptgRefA']); |
} |
else { |
// TODO: use real error codes |
$this->raiseError("Unknown class $class", 0, PEAR_ERROR_DIE); |
} |
return($ptgRef.$row.$col); |
} |
/** |
* Convert an Excel 3d reference such as "Sheet1!A1" or "Sheet1:Sheet2!A1" to a |
* ptgRef3dV. |
* |
* @access private |
* @param string $cell An Excel cell reference |
* @return string The cell in packed() format with the corresponding ptg |
*/ |
function _convertRef3d($cell) |
{ |
$class = 2; // as far as I know, this is magick. |
// Split the ref at the ! symbol |
list($ext_ref, $cell) = split('!', $cell); |
// Convert the external reference part |
$ext_ref = $this->_packExtRef($ext_ref); |
if ($this->isError($ext_ref)) { |
return $ext_ref; |
} |
// Convert the cell reference part |
list($row, $col) = $this->_cellToPackedRowcol($cell); |
// The ptg value depends on the class of the ptg. |
if ($class == 0) { |
$ptgRef = pack("C", $this->ptg['ptgRef3d']); |
} |
elseif ($class == 1) { |
$ptgRef = pack("C", $this->ptg['ptgRef3dV']); |
} |
elseif ($class == 2) { |
$ptgRef = pack("C", $this->ptg['ptgRef3dA']); |
} |
else { |
$this->raiseError("Unknown class $class", 0, PEAR_ERROR_DIE); |
} |
return $ptgRef . $ext_ref. $row . $col; |
} |
/** |
* Convert the sheet name part of an external reference, for example "Sheet1" or |
* "Sheet1:Sheet2", to a packed structure. |
* |
* @access private |
* @param string $ext_ref The name of the external reference |
* @return string The reference index in packed() format |
*/ |
function _packExtRef($ext_ref) |
{ |
$ext_ref = preg_replace("/^'/", '', $ext_ref); // Remove leading ' if any. |
$ext_ref = preg_replace("/'$/", '', $ext_ref); // Remove trailing ' if any. |
// Check if there is a sheet range eg., Sheet1:Sheet2. |
if (preg_match("/:/", $ext_ref)) |
{ |
list($sheet_name1, $sheet_name2) = split(':', $ext_ref); |
$sheet1 = $this->_getSheetIndex($sheet_name1); |
if ($sheet1 == -1) { |
return $this->raiseError("Unknown sheet name $sheet_name1 in formula"); |
} |
$sheet2 = $this->_getSheetIndex($sheet_name2); |
if ($sheet2 == -1) { |
return $this->raiseError("Unknown sheet name $sheet_name2 in formula"); |
} |
// Reverse max and min sheet numbers if necessary |
if ($sheet1 > $sheet2) { |
list($sheet1, $sheet2) = array($sheet2, $sh |