requirements.php 4.26 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
<?php
/**
 * Application requirement checker script.
 *
 * In order to run this script use the following console command:
 * php requirements.php
 *
 * In order to run this script from the web, you should copy it to the web root.
 * If you are using Linux you can create a hard link instead, using the following command:
 * ln requirements.php ../requirements.php
 */

13
// you may need to adjust this path to the correct Yii framework path
14
$frameworkPath = dirname(__FILE__) . '/vendor/yiisoft/yii2';
15 16

if (!is_dir($frameworkPath)) {
17 18 19 20
    echo '<h1>Error</h1>';
    echo '<p><strong>The path to yii framework seems to be incorrect.</strong></p>';
    echo '<p>You need to install Yii framework via composer or adjust the framework path in file <abbr title="' . __FILE__ . '">' . basename(__FILE__) . '</abbr>.</p>';
    echo '<p>Please refer to the <abbr title="' . dirname(__FILE__) . '/README.md">README</abbr> on how to install Yii.</p>';
21
}
22 23

require_once($frameworkPath . '/requirements/YiiRequirementChecker.php');
24 25 26 27 28
$requirementsChecker = new YiiRequirementChecker();

/**
 * Adjust requirements according to your application specifics.
 */
29
$requirements = array(
30 31 32 33 34
    // Database :
    array(
        'name' => 'PDO extension',
        'mandatory' => true,
        'condition' => extension_loaded('pdo'),
35
        'by' => 'All DB-related classes',
36 37 38 39 40
    ),
    array(
        'name' => 'PDO SQLite extension',
        'mandatory' => false,
        'condition' => extension_loaded('pdo_sqlite'),
41
        'by' => 'All DB-related classes',
42 43 44 45 46 47
        'memo' => 'Required for SQLite database.',
    ),
    array(
        'name' => 'PDO MySQL extension',
        'mandatory' => false,
        'condition' => extension_loaded('pdo_mysql'),
48
        'by' => 'All DB-related classes',
49 50 51 52 53 54
        'memo' => 'Required for MySQL database.',
    ),
    array(
        'name' => 'PDO PostgreSQL extension',
        'mandatory' => false,
        'condition' => extension_loaded('pdo_pgsql'),
55
        'by' => 'All DB-related classes',
56 57 58 59 60 61 62
        'memo' => 'Required for PostgreSQL database.',
    ),
    // Cache :
    array(
        'name' => 'Memcache extension',
        'mandatory' => false,
        'condition' => extension_loaded('memcache') || extension_loaded('memcached'),
63 64
        'by' => '<a href="http://www.yiiframework.com/doc-2.0/yii-caching-memcache.html">MemCache</a>',
        'memo' => extension_loaded('memcached') ? 'To use memcached set <a href="http://www.yiiframework.com/doc-2.0/yii-caching-memcache.html#$useMemcached-detail">MemCache::useMemcached</a> to <code>true</code>.' : ''
65 66 67 68 69
    ),
    array(
        'name' => 'APC extension',
        'mandatory' => false,
        'condition' => extension_loaded('apc'),
70
        'by' => '<a href="http://www.yiiframework.com/doc-2.0/yii-caching-apccache.html">ApcCache</a>',
71 72 73 74 75 76
    ),
    // Additional PHP extensions :
    array(
        'name' => 'Mcrypt extension',
        'mandatory' => false,
        'condition' => extension_loaded('mcrypt'),
77
        'by' => '<a href="http://www.yiiframework.com/doc-2.0/yii-helpers-security.html">Security Helper</a>',
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
        'memo' => 'Required by encrypt and decrypt methods.'
    ),
    // PHP ini :
    'phpSafeMode' => array(
        'name' => 'PHP safe mode',
        'mandatory' => false,
        'condition' => $requirementsChecker->checkPhpIniOff("safe_mode"),
        'by' => 'File uploading and console command execution',
        'memo' => '"safe_mode" should be disabled at php.ini',
    ),
    'phpExposePhp' => array(
        'name' => 'Expose PHP',
        'mandatory' => false,
        'condition' => $requirementsChecker->checkPhpIniOff("expose_php"),
        'by' => 'Security reasons',
        'memo' => '"expose_php" should be disabled at php.ini',
    ),
    'phpAllowUrlInclude' => array(
        'name' => 'PHP allow url include',
        'mandatory' => false,
        'condition' => $requirementsChecker->checkPhpIniOff("allow_url_include"),
        'by' => 'Security reasons',
        'memo' => '"allow_url_include" should be disabled at php.ini',
    ),
    'phpSmtp' => array(
        'name' => 'PHP mail SMTP',
        'mandatory' => false,
        'condition' => strlen(ini_get('SMTP'))>0,
        'by' => 'Email sending',
        'memo' => 'PHP mail SMTP server required',
    ),
109
);
110
$requirementsChecker->checkYii()->check($requirements)->render();