mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
432 lines
16 KiB
PHP
432 lines
16 KiB
PHP
<?php // $Id$
|
|
|
|
///////////////////////////////////////////////////////////////////////////
|
|
// //
|
|
// NOTICE OF COPYRIGHT //
|
|
// //
|
|
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
|
// http://moodle.com //
|
|
// //
|
|
// Copyright (C) 2001-3001 Martin Dougiamas http://dougiamas.com //
|
|
// (C) 2001-3001 Eloy Lafuente (stronk7) http://contiento.com //
|
|
// //
|
|
// This program is free software; you can redistribute it and/or modify //
|
|
// it under the terms of the GNU General Public License as published by //
|
|
// the Free Software Foundation; either version 2 of the License, or //
|
|
// (at your option) any later version. //
|
|
// //
|
|
// This program 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 General Public License for more details: //
|
|
// //
|
|
// http://www.gnu.org/copyleft/gpl.html //
|
|
// //
|
|
///////////////////////////////////////////////////////////////////////////
|
|
|
|
/// We need to add this to allow "our" PEAR package to work smoothly
|
|
/// without modifying one bit, putting it in the 1st place of the
|
|
/// include_path to be localised by Moodle without problems
|
|
ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
|
|
|
|
require_once 'Spreadsheet/Excel/Writer.php';
|
|
|
|
/**
|
|
* Define and operate over one Moodle Workbook.
|
|
*
|
|
* A big part of this class acts as a wrapper over the PEAR
|
|
* Spreadsheet_Excel_Writer_Workbook and OLE libraries
|
|
* maintaining Moodle functions isolated from underlying code.
|
|
*/
|
|
class MoodleExcelWorkbook {
|
|
|
|
var $pear_excel_workbook;
|
|
|
|
/* Constructs one Moodle Workbook.
|
|
* @param string $filename The name of the file
|
|
*/
|
|
function MoodleExcelWorkbook($filename) {
|
|
/// Internally, create one PEAR Spreadsheet_Excel_Writer_Workbook class
|
|
$this->pear_excel_workbook = new Spreadsheet_Excel_Writer($filename);
|
|
/// Prepare it to accept UTF-16LE data and to encode it properly
|
|
$this->pear_excel_workbook->setVersion(8);
|
|
}
|
|
|
|
/* Create one Moodle Worksheet
|
|
* @param string $name Name of the sheet
|
|
*/
|
|
function &add_worksheet($name = '') {
|
|
/// Create the Moodle Worksheet. Returns one pointer to it
|
|
$ws =& new MoodleExcelWorksheet ($name, $this->pear_excel_workbook);
|
|
return $ws;
|
|
}
|
|
|
|
/* Create one Moodle Format
|
|
* @param array $properties array of properties [name]=value;
|
|
* valid names are set_XXXX existing
|
|
* functions without the set_ part
|
|
* i.e: [bold]=1 for set_bold(1)...Optional!
|
|
*/
|
|
function &add_format($properties = array()) {
|
|
/// Create the Moodle Format. Returns one pointer to it
|
|
$ft =& new MoodleExcelFormat ($this->pear_excel_workbook, $properties);
|
|
return $ft;
|
|
}
|
|
|
|
/* Close the Moodle Workbook
|
|
*/
|
|
function close() {
|
|
$this->pear_excel_workbook->close();
|
|
}
|
|
|
|
/* Write the correct HTTP headers
|
|
* @param string $name Name of the downloaded file
|
|
*/
|
|
function send($filename) {
|
|
$this->pear_excel_workbook->send($filename);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Define and operate over one Worksheet.
|
|
*
|
|
* A big part of this class acts as a wrapper over the PEAR
|
|
* Spreadsheet_Excel_Writer_Workbook and OLE libraries
|
|
* maintaining Moodle functions isolated from underlying code.
|
|
*/
|
|
class MoodleExcelWorksheet {
|
|
|
|
var $pear_excel_worksheet;
|
|
|
|
/* Constructs one Moodle Worksheet.
|
|
* @param string $filename The name of the file
|
|
* @param object $workbook The internal PEAR Workbook onject we are creating
|
|
*/
|
|
function MoodleExcelWorksheet($name, &$workbook) {
|
|
/// Internally, add one sheet to the workbook
|
|
$this->pear_excel_worksheet =& $workbook->addWorksheet($name);
|
|
/// Set encoding to UTF-16LE
|
|
$this->pear_excel_worksheet->setInputEncoding('UTF-16LE');
|
|
}
|
|
|
|
/* Write one string somewhere in the worksheet
|
|
* @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
|
|
*/
|
|
function write_string($row, $col, $str, $format=0) {
|
|
/// Calculate the internal PEAR format
|
|
$format = $this->MoodleExcelFormat2PearExcelFormat($format);
|
|
/// Loading the textlib singleton instance. We are going to need it.
|
|
$textlib = textlib_get_instance();
|
|
/// Convert the text from its original encoding to UTF-16LE
|
|
$str = $textlib->convert($str, current_charset(), 'utf-16le');
|
|
/// Add the string safely to the PEAR Worksheet
|
|
$this->pear_excel_worksheet->writeString($row, $col, $str, $format);
|
|
}
|
|
|
|
/* Write one number somewhere in the worksheet
|
|
* @param integer $row Zero indexed row
|
|
* @param integer $col Zero indexed column
|
|
* @param float $num The number to write
|
|
* @param mixed $format The XF format for the cell
|
|
*/
|
|
function write_number($row, $col, $num, $format=0) {
|
|
/// Calculate the internal PEAR format
|
|
$format = $this->MoodleExcelFormat2PearExcelFormat($format);
|
|
/// Add the number safely to the PEAR Worksheet
|
|
$this->pear_excel_worksheet->writeNumber($row, $col, $num, $format);
|
|
}
|
|
|
|
/* Write one url somewhere in the worksheet
|
|
* @param integer $row Zero indexed row
|
|
* @param integer $col Zero indexed column
|
|
* @param string $url The url to write
|
|
* @param mixed $format The XF format for the cell
|
|
*/
|
|
function write_url($row, $col, $url, $format=0) {
|
|
/// Calculate the internal PEAR format
|
|
$format = $this->MoodleExcelFormat2PearExcelFormat($format);
|
|
/// Add the url safely to the PEAR Worksheet
|
|
$this->pear_excel_worksheet->writeUrl($row, $col, $url, $format);
|
|
}
|
|
|
|
/* Write one formula somewhere in the worksheet
|
|
* @param integer $row Zero indexed row
|
|
* @param integer $col Zero indexed column
|
|
* @param string $formula The formula to write
|
|
* @param mixed $format The XF format for the cell
|
|
*/
|
|
function write_formula($row, $col, $formula, $format=0) {
|
|
/// Calculate the internal PEAR format
|
|
$format = $this->MoodleExcelFormat2PearExcelFormat($format);
|
|
/// Add the formula safely to the PEAR Worksheet
|
|
$this->pear_excel_worksheet->writeFormula($row, $col, $formula, $format);
|
|
}
|
|
|
|
/* Write one blanck somewhere in the worksheet
|
|
* @param integer $row Zero indexed row
|
|
* @param integer $col Zero indexed column
|
|
* @param mixed $format The XF format for the cell
|
|
*/
|
|
function write_blank($row, $col, $format=0) {
|
|
/// Calculate the internal PEAR format
|
|
$format = $this->MoodleExcelFormat2PearExcelFormat($format);
|
|
/// Add the blank safely to the PEAR Worksheet
|
|
$this->pear_excel_worksheet->writeBlank($row, $col, $format);
|
|
}
|
|
|
|
/* Write anything somewhere in the worksheet
|
|
* Type will be automatically detected
|
|
* @param integer $row Zero indexed row
|
|
* @param integer $col Zero indexed column
|
|
* @param mixed $token What we are writing
|
|
* @param mixed $format The XF format for the cell
|
|
*/
|
|
function write($row, $col, $token, $format=0) {
|
|
|
|
/// Analyse what are we trying to send
|
|
if (preg_match("/^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/", $token)) {
|
|
/// Match number
|
|
return $this->write_number($row, $col, $token, $format);
|
|
} elseif (preg_match("/^[fh]tt?p:\/\//", $token)) {
|
|
/// Match http or ftp URL
|
|
return $this->write_url($row, $col, $token, '', $format);
|
|
} elseif (preg_match("/^mailto:/", $token)) {
|
|
/// Match mailto:
|
|
return $this->write_url($row, $col, $token, '', $format);
|
|
} elseif (preg_match("/^(?:in|ex)ternal:/", $token)) {
|
|
/// Match internal or external sheet link
|
|
return $this->write_url($row, $col, $token, '', $format);
|
|
} elseif (preg_match("/^=/", $token)) {
|
|
/// Match formula
|
|
return $this->write_formula($row, $col, $token, $format);
|
|
} elseif (preg_match("/^@/", $token)) {
|
|
/// Match formula
|
|
return $this->write_formula($row, $col, $token, $format);
|
|
} elseif ($token == '') {
|
|
/// Match blank
|
|
return $this->write_blank($row, $col, $format);
|
|
} else {
|
|
/// Default: match string
|
|
return $this->write_string($row, $col, $token, $format);
|
|
}
|
|
}
|
|
|
|
/* Returns the PEAR Excel Format for one Moodle Excel Format
|
|
* @param mixed MoodleExcelFormat object
|
|
* @return mixed PEAR Excel Format object
|
|
*/
|
|
function MoodleExcelFormat2PearExcelFormat($format) {
|
|
if ($format != 0) {
|
|
return $format->pear_excel_format;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Define and operate over one Format.
|
|
*
|
|
* A big part of this class acts as a wrapper over the PEAR
|
|
* Spreadsheet_Excel_Writer_Workbook and OLE libraries
|
|
* maintaining Moodle functions isolated from underlying code.
|
|
*/
|
|
class MoodleExcelFormat {
|
|
|
|
var $pear_excel_format;
|
|
|
|
/* Constructs one Moodle Format.
|
|
* @param object $workbook The internal PEAR Workbook onject we are creating
|
|
*/
|
|
function MoodleExcelFormat(&$workbook, $properties = array()) {
|
|
/// Internally, add one sheet to the workbook
|
|
$this->pear_excel_format =& $workbook->addFormat();
|
|
/// If we have something in the array of properties, compute them
|
|
foreach($properties as $property => $value) {
|
|
if(method_exists($this,"set_$property")) {
|
|
$aux = 'set_'.$property;
|
|
$this->$aux($value);
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Set weight of the format
|
|
* @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 set_bold($weight = 1) {
|
|
/// Set the bold safely to the PEAR Format
|
|
$this->pear_excel_format->setBold($weight);
|
|
}
|
|
|
|
/* Set underline of the format
|
|
* @param integer $underline The value for underline. Possible values are:
|
|
* 1 => underline, 2 => double underline
|
|
*/
|
|
function set_underline($underline) {
|
|
/// Set the underline safely to the PEAR Format
|
|
$this->pear_excel_format->setUnderline($underline);
|
|
}
|
|
|
|
/* Set italic of the format
|
|
*/
|
|
function set_italic() {
|
|
/// Set the italic safely to the PEAR Format
|
|
$this->pear_excel_format->setItalic();
|
|
}
|
|
|
|
/* Set strikeout of the format
|
|
*/
|
|
function set_strikeout() {
|
|
/// Set the strikeout safely to the PEAR Format
|
|
$this->pear_excel_format->setStrikeOut();
|
|
}
|
|
|
|
/* Set outlining of the format
|
|
*/
|
|
function set_outline() {
|
|
/// Set the outlining safely to the PEAR Format
|
|
$this->pear_excel_format->setOutLine();
|
|
}
|
|
|
|
/* Set shadow of the format
|
|
*/
|
|
function set_shadow() {
|
|
/// Set the shadow safely to the PEAR Format
|
|
$this->pear_excel_format->setShadow();
|
|
}
|
|
|
|
/* Set the script of the text
|
|
* @param integer $script The value for script type. Possible values are:
|
|
* 1 => superscript, 2 => subscript
|
|
*/
|
|
function set_script($script) {
|
|
/// Set the script safely to the PEAR Format
|
|
$this->pear_excel_format->setScript($script);
|
|
}
|
|
|
|
/* Set color of the format
|
|
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
|
|
*/
|
|
function set_color($color) {
|
|
/// Set the background color safely to the PEAR Format
|
|
$this->pear_excel_format->setColor($color);
|
|
}
|
|
|
|
/* Set foreground color of the format
|
|
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
|
|
*/
|
|
function set_fg_color($color) {
|
|
/// Set the foreground color safely to the PEAR Format
|
|
$this->pear_excel_format->setFgColor($color);
|
|
}
|
|
|
|
/* Set background color of the format
|
|
* @param mixed $color either a string (like 'blue'), or an integer (range is [8...63])
|
|
*/
|
|
function set_bg_color($color) {
|
|
/// Set the background color safely to the PEAR Format
|
|
$this->pear_excel_format->setBgColor($color);
|
|
}
|
|
|
|
/* Set the fill pattern of the format
|
|
* @param integer Optional. Defaults to 1. Meaningful values are: 0-18
|
|
* 0 meaning no background.
|
|
*/
|
|
function set_pattern($pattern=1) {
|
|
/// Set the fill pattern safely to the PEAR Format
|
|
$this->pear_excel_format->setPattern($pattern);
|
|
}
|
|
|
|
/* Set text wrap of the format
|
|
*/
|
|
function set_text_wrap() {
|
|
/// Set the shadow safely to the PEAR Format
|
|
$this->pear_excel_format->setTextWrap();
|
|
}
|
|
|
|
/* Set the cell alignment of the format
|
|
* @param string $location alignment for the cell ('left', 'right', etc...)
|
|
*/
|
|
function set_align($location) {
|
|
/// Set the alignment of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setAlign($location);
|
|
}
|
|
|
|
/* Set the cell horizontal alignment of the format
|
|
* @param string $location alignment for the cell ('left', 'right', etc...)
|
|
*/
|
|
function set_h_align($location) {
|
|
/// Set the alignment of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setHAlign($location);
|
|
}
|
|
|
|
/* Set the cell vertical alignment of the format
|
|
* @param string $location alignment for the cell ('top', 'vleft', etc...)
|
|
*/
|
|
function set_v_align($location) {
|
|
/// Set the alignment of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setVAlign($location);
|
|
}
|
|
|
|
/* Set the top border of the format
|
|
* @param integer $style style for the cell. 1 => thin, 2 => thick
|
|
*/
|
|
function set_top($style) {
|
|
/// Set the top border of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setTop($style);
|
|
}
|
|
|
|
/* Set the bottom border of the format
|
|
* @param integer $style style for the cell. 1 => thin, 2 => thick
|
|
*/
|
|
function set_bottom($style) {
|
|
/// Set the bottom border of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setBottom($style);
|
|
}
|
|
|
|
/* Set the left border of the format
|
|
* @param integer $style style for the cell. 1 => thin, 2 => thick
|
|
*/
|
|
function set_left($style) {
|
|
/// Set the left border of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setLeft($style);
|
|
}
|
|
|
|
/* Set the right border of the format
|
|
* @param integer $style style for the cell. 1 => thin, 2 => thick
|
|
*/
|
|
function set_right($style) {
|
|
/// Set the right border of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setRight($style);
|
|
}
|
|
|
|
/**
|
|
* Set cells borders to the same style
|
|
* @param integer $style style to apply for all cell borders. 1 => thin, 2 => thick.
|
|
*/
|
|
function set_border($style) {
|
|
/// Set all the borders of the cell safely to the PEAR Format
|
|
$this->pear_excel_format->setBorder($style);
|
|
}
|
|
|
|
/* Set the numerical format of the format
|
|
* It can be date, time, currency, etc...
|
|
/* Set the numerical format of the format
|
|
* It can be date, time, currency, etc...
|
|
* @param integer $num_format The numeric format
|
|
*/
|
|
function set_num_format($num_format) {
|
|
/// Set the numerical format safely to the PEAR Format
|
|
$this->pear_excel_format->setNumFormat($num_format);
|
|
}
|
|
|
|
}
|
|
|
|
?>
|