Mage_Install_Model_Installer_Console Class Reference

Inheritance diagram for Mage_Install_Model_Installer_Console:

List of all members.

Public Member Functions
	setArgs ($args=null)
	addError ($error)
	hasErrors ()
	getErrors ()
	getEncryptionKey ()
	init (Mage_Core_Model_App $app)
	install ()
	printOptions ()
	checkConsole ($url=null)
Protected Member Functions
	_getOptions ()
	_checkFlag ($value)
	_getDataModel ()
	_prepareData ()
Protected Attributes
	$_options
	$_args = array()
	$_dataModel
	$_app

---

Detailed Description

Definition at line 34 of file Console.php.

---

Member Function Documentation

_checkFlag

(

$

value

)

[protected]

Check flag value

Returns true for 'yes', 1, 'true' Case insensitive

Parameters:

string

$value

Returns:

boolean

Definition at line 216 of file Console.php.

    {
        $res = (1 == $value)
            || preg_match('/^(yes|y|true)$/i', $value);
        return $res;
    }

_getDataModel

(

)

[protected]

Get data model (used to store data between installation steps

Returns:

Mage_Install_Model_Installer_Data

Definition at line 228 of file Console.php.

    {
        if (is_null($this->_dataModel)) {
            $this->_dataModel = Mage::getModel('install/installer_data');
        }
        return $this->_dataModel;
    }

_getOptions

(

)

[protected]

Get available options list

Returns:

array

Definition at line 70 of file Console.php.

    {
        if (is_null($this->_options)) {
            $this->_options = array(
                'license_agreement_accepted'    => array('required' => true, 'comment' => ''),
                'locale'              => array('required' => true, 'comment' => ''),
                'timezone'            => array('required' => true, 'comment' => ''),
                'default_currency'    => array('required' => true, 'comment' => ''),
                'db_host'             => array('required' => true, 'comment' => ''),
                'db_name'             => array('required' => true, 'comment' => ''),
                'db_user'             => array('required' => true, 'comment' => ''),
                'db_pass'             => array('comment' => ''),
                'db_prefix'           => array('comment' => ''),
                'url'                 => array('required' => true, 'comment' => ''),
                'skip_url_validation' => array('comment' => ''),
                'use_rewrites'      => array('required' => true, 'comment' => ''),
                'use_secure'        => array('required' => true, 'comment' => ''),
                'secure_base_url'   => array('required' => true, 'comment' => ''),
                'use_secure_admin'  => array('required' => true, 'comment' => ''),
                'admin_lastname'    => array('required' => true, 'comment' => ''),
                'admin_firstname'   => array('required' => true, 'comment' => ''),
                'admin_email'       => array('required' => true, 'comment' => ''),
                'admin_username'    => array('required' => true, 'comment' => ''),
                'admin_password'    => array('required' => true, 'comment' => ''),
                'encryption_key'    => array('comment' => ''),
                'session_save'      => array('comment' => ''),
                'admin_frontname'   => array('comment' => ''),
            );
        }
        return $this->_options;
    }

_prepareData

(

)

[protected]

Prepare data ans save it in data model

Returns:

Mage_Install_Model_Installer_Console

Locale settings

Database and web config

Primary admin user

Definition at line 273 of file Console.php.

    {
        /**
         * Locale settings
         */
        $this->_getDataModel()->setLocaleData(array(
            'locale'            => $this->_args['locale'],
            'timezone'          => $this->_args['timezone'],
            'currency'          => $this->_args['default_currency'],
        ));

        /**
         * Database and web config
         */
        $this->_getDataModel()->setConfigData(array(
            'db_host'             => $this->_args['db_host'],
            'db_name'             => $this->_args['db_name'],
            'db_user'             => $this->_args['db_user'],
            'db_pass'             => $this->_args['db_pass'],
            'db_prefix'           => $this->_args['db_prefix'],
            'use_rewrites'        => $this->_checkFlag($this->_args['use_rewrites']),
            'use_secure'          => $this->_checkFlag($this->_args['use_secure']),
            'unsecure_base_url'   => $this->_args['url'],
            'secure_base_url'     => $this->_args['secure_base_url'],
            'use_secure_admin'    => $this->_checkFlag($this->_args['use_secure_admin']),
            'session_save'        => $this->_checkSessionSave($this->_args['session_save']),
            'admin_frontname'     => $this->_checkAdminFrontname($this->_args['admin_frontname']),
            'skip_url_validation' => $this->_checkFlag($this->_args['skip_url_validation']),
        ));

        /**
         * Primary admin user
         */
        $this->_getDataModel()->setAdminData(array(
            'firstname'         => $this->_args['admin_firstname'],
            'lastname'          => $this->_args['admin_lastname'],
            'email'             => $this->_args['admin_email'],
            'username'          => $this->_args['admin_username'],
            'password'          => $this->_args['admin_password'],
        ));

        return $this;
    }

addError

(

$

error

)

Add error

Parameters:

string

$error

Returns:

Mage_Install_Model_Installer_Console

Definition at line 181 of file Console.php.

    {
        $this->_getDataModel()->addError($error);
        return $this;
    }

checkConsole

(

$

url = null

)

Check if installer is run in shell, and redirect if run on web

Parameters:

string

$url fallback url to redirect to

Returns:

boolean

Definition at line 441 of file Console.php.

    {
        if (defined('STDIN') && defined('STDOUT') && (defined('STDERR'))) {
            return true;
        }
        if (is_null($url)) {
            $url = preg_replace('/install\.php/i', '', Mage::getBaseUrl());
            $url = preg_replace('/\/\/$/', '/', $url);
        }
        header('Location: ' . $url);
        return false;
    }

getEncryptionKey

(

)

Get encryption key from data model

Returns:

string

Definition at line 241 of file Console.php.

    {
        return $this->_getDataModel()->getEncryptionKey();
    }

getErrors

(

)

Get all errors

Returns:

array

Definition at line 202 of file Console.php.

    {
        return $this->_getDataModel()->getErrors();
    }

hasErrors

(

)

Check if there were any errors

Returns:

boolean

Definition at line 192 of file Console.php.

    {
        return (count($this->_getDataModel()->getErrors()) > 0);
    }

init

(

Mage_Core_Model_App $

app

)

Init installation

Parameters:

Mage_Core_Model_App

$app

Returns:

boolean

Check if already installed

Definition at line 252 of file Console.php.

    {
        $this->_app = $app;
        $this->_getInstaller()->setDataModel($this->_getDataModel());

        /**
         * Check if already installed
         */
        if (Mage::isInstalled()) {
            $this->addError('ERROR: Magento is already installed');
            return false;
        }

        return true;
    }

install

(

)

Install Magento

Returns:

boolean

Check if already installed

Skip URL validation, if set

Prepare data

Install configuration

Reinitialize configuration (to use new config data)

Install database

Create primary administrator user

Save encryption key or create if empty

Installation finish

Change directories mode to be writable by apache user

Definition at line 322 of file Console.php.

    {
        try {

            /**
             * Check if already installed
             */
            if (Mage::isInstalled()) {
                $this->addError('ERROR: Magento is already installed');
                return false;
            }

            /**
             * Skip URL validation, if set
             */
            $this->_getDataModel()->setSkipUrlValidation($this->_args['skip_url_validation']);
            $this->_getDataModel()->setSkipBaseUrlValidation($this->_args['skip_url_validation']);

            /**
             * Prepare data
             */
            $this->_prepareData();

            if ($this->hasErrors()) {
                return false;
            }

            $installer = $this->_getInstaller();

            /**
             * Install configuration
             */
            $installer->installConfig($this->_getDataModel()->getConfigData()); // TODO fix wizard and simplify this everythere

            if ($this->hasErrors()) {
                return false;
            }

            /**
             * Reinitialize configuration (to use new config data)
             */

            $this->_app->cleanCache();
            Mage::getConfig()->reinit();

            /**
             * Install database
             */
            $installer->installDb();

            if ($this->hasErrors()) {
                return false;
            }

            /**
             * Create primary administrator user
             */
            $installer->createAdministrator($this->_getDataModel()->getAdminData());

            if ($this->hasErrors()) {
                return false;
            }

            /**
             * Save encryption key or create if empty
             */
            $encryptionKey = empty($this->_args['encryption_key']) ? md5(time()) : $this->_args['encryption_key'];
            $this->_getDataModel()->setEncryptionKey($encryptionKey);
            $installer->installEnryptionKey($encryptionKey);

            if ($this->hasErrors()) {
                return false;
            }

            /**
             * Installation finish
             */
            $installer->finish();

            if ($this->hasErrors()) {
                return false;
            }

            /**
             * Change directories mode to be writable by apache user
             */
            @chmod('var/cache', 0777);
            @chmod('var/session', 0777);

        } catch (Exception $e) {
            $this->addError('ERROR: ' . $e->getMessage());
            return false;
        }

        return true;
    }

printOptions

(

)

Print available currency, locale and timezone options

Returns:

Mage_Install_Model_Installer_Console

Definition at line 424 of file Console.php.

    {
        $options = array(
            'locale'    => $this->_app->getLocale()->getOptionLocales(),
            'currency'  => $this->_app->getLocale()->getOptionCurrencies(),
            'timezone'  => $this->_app->getLocale()->getOptionTimezones(),
        );
        var_export($options);
        return $this;
    }

setArgs

(

$

args = null

)

Set and validate arguments

Parameters:

array

$args

Returns:

boolean

Parse arguments

Check required arguments

Validate license aggreement acceptance

Set args values

Definition at line 108 of file Console.php.

    {
        if (empty($args)) {
            // take server args
            $args = $_SERVER['argv'];
        }

        /**
         * Parse arguments
         */
        $currentArg = false;
        $match = false;
        foreach ($args as $arg) {
            if (preg_match('/^--(.*)$/', $arg, $match)) {
                // argument name
                $currentArg = $match[1];
                // in case if argument doen't need a value
                $args[$currentArg] = true;
            } else {
                // argument value
                if ($currentArg) {
                    $args[$currentArg] = $arg;
                }
                $currentArg = false;
            }
        }

        if (isset($args['get_options'])) {
            $this->printOptions();
            return false;
        }

        /**
         * Check required arguments
         */
        foreach ($this->_getOptions() as $name => $option) {
            if (isset($option['required']) && $option['required'] && !isset($args[$name])) {
                $error = 'ERROR: ' . 'You should provide the value for --' . $name .' parameter';
                if (!empty($option['comment'])) {
                    $error .= ': ' . $option['comment'];
                }
                $this->addError($error);
            }
        }

        if ($this->hasErrors()) {
            return false;
        }

        /**
         * Validate license aggreement acceptance
         */
        if (!$this->_checkFlag($args['license_agreement_accepted'])) {
            $this->addError('ERROR: You have to accept Magento license agreement terms and conditions to continue installation');
            return false;
        }

        /**
         * Set args values
         */
        foreach ($this->_getOptions() as $name => $option) {
            $this->_args[$name] = isset($args[$name]) ? $args[$name] : '';
        }

        return true;
    }

---

Member Data Documentation

$_app [protected]

Definition at line 63 of file Console.php.

$_args = array() [protected]

Definition at line 49 of file Console.php.

$_dataModel [protected]

Definition at line 56 of file Console.php.

$_options [protected]

Definition at line 42 of file Console.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Install/Model/Installer/Console.php