Merge branch 'MDL-41839-master' of git://github.com/sammarshallou/moodle
[moodle.git] / admin / tool / generator / cli / maketestsite.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/>.
17 /**
18  * CLI interface for creating a test site.
19  *
20  * @package tool_generator
21  * @copyright 2013 David MonllaĆ³
22  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 define('CLI_SCRIPT', true);
26 define('NO_OUTPUT_BUFFERING', true);
28 require(__DIR__ . '/../../../../config.php');
29 require_once($CFG->libdir. '/clilib.php');
31 // CLI options.
32 list($options, $unrecognized) = cli_get_params(
33     array(
34         'help' => false,
35         'size' => false,
36         'fixeddataset' => false,
37         'bypasscheck' => false,
38         'quiet' => false
39     ),
40     array(
41         'h' => 'help'
42     )
43 );
45 $sitesizes = '* ' . implode(PHP_EOL . '* ', tool_generator_site_backend::get_size_choices());
47 // Display help.
48 if (!empty($options['help']) || empty($options['size'])) {
49     echo "
50 Utility to generate a standard test site data set.
52 Not for use on live sites; only normally works if debugging is set to DEVELOPER
53 level.
55 Consider that, depending on the size you select, this CLI tool can really generate a lot of data, aproximated sizes:
57 $sitesizes
59 Options:
60 --size         Size of the generated site, this value affects the number of courses and their size. Accepted values: XS, S, M, L, XL, or XXL (required)
61 --fixeddataset Use a fixed data set instead of randomly generated data
62 --bypasscheck  Bypasses the developer-mode check (be careful!)
63 --quiet        Do not show any output
65 -h, --help     Print out this help
67 Example from Moodle root directory:
68 \$ php admin/tool/generator/cli/maketestsite.php --size=S
69 ";
70     // Exit with error unless we're showing this because they asked for it.
71     exit(empty($options['help']) ? 1 : 0);
72 }
74 // Check debugging is set to developer level.
75 if (empty($options['bypasscheck']) && !$CFG->debugdeveloper) {
76     cli_error(get_string('error_notdebugging', 'tool_generator'));
77 }
79 // Get options.
80 $sizename = $options['size'];
81 $fixeddataset = $options['fixeddataset'];
83 // Check size.
84 try {
85     $size = tool_generator_site_backend::size_for_name($sizename);
86 } catch (coding_exception $e) {
87     cli_error("Invalid size ($sizename). Use --help for help.");
88 }
90 // Switch to admin user account.
91 \core\session\manager::set_user(get_admin());
93 // Do backend code to generate site.
94 $backend = new tool_generator_site_backend($size, $options['bypasscheck'], $fixeddataset, empty($options['quiet']));
95 $backend->make();