lib/dataformatlib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * dataformatlib.php - Contains core dataformat related functions.
  19  *
  20  * @package    core
  21  * @subpackage dataformat
  22  * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 /**
  27  * Sends a formated data file to the browser
  28  *
  29  * @package    core
  30  * @subpackage dataformat
  31  *
  32  * @param string $filename The base filename without an extension
  33  * @param string $dataformat A dataformat name
  34  * @param array $columns An ordered map of column keys and labels
  35  * @param Iterator $iterator An iterator over the records, usually a RecordSet
  36  * @param callable $callback An option function applied to each record before writing
  37  * @throws coding_exception
  38  *
  39  * @deprecated since Moodle 3.9 - MDL-68500 please use \core\dataformat::download_data
  40  */
  41 function download_as_dataformat($filename, $dataformat, $columns, $iterator, $callback = null) {
  42     debugging('download_as_dataformat() is deprecated, please use \core\dataformat::download_data() instead', DEBUG_DEVELOPER);
  43
  44     \core\dataformat::download_data($filename, $dataformat, $columns, $iterator, $callback);
  45 }