Mage_Install_WizardController Class Reference

Inheritance diagram for Mage_Install_WizardController:

List of all members.

Public Member Functions
	preDispatch ()
	indexAction ()
	beginAction ()
	beginPostAction ()
	localeAction ()
	localeChangeAction ()
	localePostAction ()
	downloadAction ()
	downloadPostAction ()
	downloadAutoAction ()
	installAction ()
	installSuccessCallback ()
	installFailureCallback ()
	downloadManualAction ()
	configAction ()
	configPostAction ()
	installDbAction ()
	administratorAction ()
	administratorPostAction ()
	endAction ()
	checkHostAction ()
	checkSecureHostAction ()
Protected Member Functions
	_getInstaller ()
	_getWizard ()
	_prepareLayout ()
	_checkIfInstalled ()

---

Detailed Description

Installation wizard controller

Definition at line 30 of file WizardController.php.

---

Member Function Documentation

_checkIfInstalled

(

)

[protected]

Checking installation status

Returns:

unknown

Definition at line 81 of file WizardController.php.

    {
        if ($this->_getInstaller()->isApplicationInstalled()) {
            $this->getResponse()->setRedirect(Mage::getBaseUrl())->sendResponse();
            exit;
        }
        return true;
    }

_getInstaller

(

)

[protected]

Retrieve installer object

Returns:

Mage_Install_Model_Installer

Definition at line 43 of file WizardController.php.

    {
        return Mage::getSingleton('install/installer');
    }

_getWizard

(

)

[protected]

Retrieve wizard

Returns:

Mage_Install_Model_Wizard

Definition at line 53 of file WizardController.php.

    {
        return Mage::getSingleton('install/wizard');
    }

_prepareLayout

(

)

[protected]

Prepare layout

Returns:

unknown

Definition at line 63 of file WizardController.php.

    {
        $this->loadLayout('install_wizard');
        $step = $this->_getWizard()->getStepByRequest($this->getRequest());
        if ($step) {
            $step->setActive(true);
        }

        $leftBlock = $this->getLayout()->createBlock('install/state', 'install.state');
        $this->getLayout()->getBlock('left')->append($leftBlock);
        return $this;
    }

administratorAction

(

)

Install admininstrator account

Definition at line 363 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');

        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/admin', 'install.administrator')
        );
        $this->renderLayout();
    }

administratorPostAction

(

)

Process administrator instalation POST data

Definition at line 379 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $step = Mage::getSingleton('install/wizard')->getStepByName('administrator');
        $adminData      = $this->getRequest()->getPost('admin');
        $encryptionKey  = $this->getRequest()->getPost('encryption_key');

        try {
            $this->_getInstaller()->createAdministrator($adminData)
                ->installEnryptionKey($encryptionKey);
        }
        catch (Exception $e){
            Mage::getSingleton('install/session')
                ->setAdminData($adminData)
                ->addError($e->getMessage());
            $this->getResponse()->setRedirect($step->getUrl());
            return false;
        }
        $this->getResponse()->setRedirect($step->getNextUrl());
    }

beginAction

(

)

Begin installation action

Definition at line 101 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $this->setFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT, true);
        $this->setFlag('', self::FLAG_NO_POST_DISPATCH, true);

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');

        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/begin', 'install.begin')
        );

        $this->renderLayout();
    }

beginPostAction

(

)

Process begin step POST data

Definition at line 121 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $agree = $this->getRequest()->getPost('agree');
        if ($agree && $step = $this->_getWizard()->getStepByName('begin')) {
            $this->getResponse()->setRedirect($step->getNextUrl());
        }
        else {
            $this->_redirect('install');
        }
    }

checkHostAction

(

)

Host validation response

Definition at line 429 of file WizardController.php.

    {
        $this->getResponse()->setHeader('Transfer-encoding', '', true);
        $this->getResponse()->setBody(Mage_Install_Model_Installer::INSTALLER_HOST_RESPONSE);
    }

checkSecureHostAction

(

)

Host validation response

Definition at line 438 of file WizardController.php.

    {
        $this->getResponse()->setHeader('Transfer-encoding', '', true);
        $this->getResponse()->setBody(Mage_Install_Model_Installer::INSTALLER_HOST_RESPONSE);
    }

configAction

(

)

Configuration data installation

Definition at line 278 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $this->_getInstaller()->checkServer();

        $this->setFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT, true);
        $this->setFlag('', self::FLAG_NO_POST_DISPATCH, true);

        if ($data = $this->getRequest()->getQuery('config')) {
            Mage::getSingleton('install/session')->setLocaleData($data);
        }

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');
        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/config', 'install.config')
        );

        $this->renderLayout();
    }

configPostAction

(

)

Process configuration POST data

Definition at line 302 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $step = $this->_getWizard()->getStepByName('config');

        if ($data = $this->getRequest()->getPost('config')) {
            //make all table prefix to lower letter
            if ($data['db_prefix'] !='') {
               $data['db_prefix'] = strtolower($data['db_prefix']);
            }

            Mage::getSingleton('install/session')
                ->setConfigData($data)
                ->setSkipUrlValidation($this->getRequest()->getPost('skip_url_validation'))
                ->setSkipBaseUrlValidation($this->getRequest()->getPost('skip_base_url_validation'));
            try {
                if($data['db_prefix']!='') {
                    if(!preg_match('/^[a-z]+[a-z0-9_]*$/',$data['db_prefix'])) {
                        Mage::throwException(
                            Mage::helper('install')->__('Table prefix should contain only letters (a-z), numbers (0-9) or underscore(_), first character should be a letter'));
                    }
                }
                $this->_getInstaller()->installConfig($data);
                $this->_redirect('*/*/installDb');
                return $this;
            }
            catch (Exception $e){
                Mage::getSingleton('install/session')->addError($e->getMessage());
                $this->getResponse()->setRedirect($step->getUrl());
            }
        }
        $this->getResponse()->setRedirect($step->getUrl());
    }

downloadAction

(

)

Definition at line 186 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $this->setFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT, true);
        $this->setFlag('', self::FLAG_NO_POST_DISPATCH, true);

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');
        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/download', 'install.download')
        );

        $this->renderLayout();
    }

downloadAutoAction

(

)

Definition at line 223 of file WizardController.php.

    {
        $step = $this->_getWizard()->getStepByName('download');
        $this->getResponse()->setRedirect($step->getNextUrl());
    }

downloadManualAction

(

)

Definition at line 265 of file WizardController.php.

    {
        $step = $this->_getWizard()->getStepByName('download');
        #if (!$this->_getInstaller()->checkDownloads()) {
        #    $this->getResponse()->setRedirect($step->getUrl());
        #} else {
        $this->getResponse()->setRedirect($step->getNextUrl());
        #}
    }

downloadPostAction

(

)

Definition at line 201 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        switch ($this->getRequest()->getPost('continue')) {
            case 'auto':
                $this->_forward('downloadAuto');
                break;

            case 'manual':
                $this->_forward('downloadManual');
                break;

            case 'svn':
                $step = $this->_getWizard()->getStepByName('download');
                $this->getResponse()->setRedirect($step->getNextUrl());
                break;

            default:
                $this->_redirect('*/*/download');
        }
    }

endAction

(

)

End installation

Definition at line 404 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $date = (string)Mage::getConfig()->getNode('global/install/date');
        if ($date !== Mage_Install_Model_Installer_Config::TMP_INSTALL_DATE_VALUE) {
            $this->_redirect('*/*');
            return;
        }

        $this->_getInstaller()->finish();

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');

        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/end', 'install.end')
        );
        $this->renderLayout();
        Mage::getSingleton('install/session')->clear();
    }

indexAction

(

)

Index action

Definition at line 93 of file WizardController.php.

    {
        $this->_forward('begin');
    }

installAction

(

)

Definition at line 229 of file WizardController.php.

    {
        $pear = Varien_Pear::getInstance();
        $params = array('comment'=>Mage::helper('install')->__("Downloading and installing Magento, please wait...")."\r\n\r\n");
        if ($this->getRequest()->getParam('do')) {
            if ($state = $this->getRequest()->getParam('state', 'beta')) {
                $result = $pear->runHtmlConsole(array(
                'comment'   => Mage::helper('install')->__("Setting preferred state to: %s", $state)."\r\n\r\n",
                'command'   => 'config-set',
                'params'    => array('preferred_state', $state)
                ));
                if ($result instanceof PEAR_Error) {
                    $this->installFailureCallback();
                    exit;
                }
            }
            $params['command'] = 'install';
            $params['options'] = array('onlyreqdeps'=>1);
            $params['params'] = Mage::getModel('install/installer_pear')->getPackages();
            $params['success_callback'] = array($this, 'installSuccessCallback');
            $params['failure_callback'] = array($this, 'installFailureCallback');
        }
        $pear->runHtmlConsole($params);
        Mage::app()->getFrontController()->getResponse()->clearAllHeaders();
    }

installDbAction

(

)

Install DB

Clear session config data

Definition at line 339 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $step = $this->_getWizard()->getStepByName('config');
        try {
            $this->_getInstaller()->installDb();
            /**
             * Clear session config data
             */
            Mage::getSingleton('install/session')->getConfigData(true);

            Mage::app()->getStore()->resetConfig();

            $this->getResponse()->setRedirect(Mage::getUrl($step->getNextUrlPath()));
        }
        catch (Exception $e){
            Mage::getSingleton('install/session')->addError($e->getMessage());
            $this->getResponse()->setRedirect($step->getUrl());
        }
    }

installFailureCallback

(

)

Definition at line 260 of file WizardController.php.

    {
        echo 'parent.installFailure()';
    }

installSuccessCallback

(

)

Definition at line 255 of file WizardController.php.

    {
        echo 'parent.installSuccess()';
    }

localeAction

(

)

Localization settings

Definition at line 137 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $this->setFlag('', self::FLAG_NO_DISPATCH_BLOCK_EVENT, true);
        $this->setFlag('', self::FLAG_NO_POST_DISPATCH, true);

        $this->_prepareLayout();
        $this->_initLayoutMessages('install/session');
        $this->getLayout()->getBlock('content')->append(
            $this->getLayout()->createBlock('install/locale', 'install.locale')
        );

        $this->renderLayout();
    }

localeChangeAction

(

)

Change current locale

Definition at line 155 of file WizardController.php.

    {
        $this->_checkIfInstalled();

        $locale = $this->getRequest()->getParam('locale');
        $timezone = $this->getRequest()->getParam('timezone');
        $currency = $this->getRequest()->getParam('currency');
        if ($locale) {
            Mage::getSingleton('install/session')->setLocale($locale);
            Mage::getSingleton('install/session')->setTimezone($timezone);
            Mage::getSingleton('install/session')->setCurrency($currency);
        }

        $this->_redirect('*/*/locale');
    }

localePostAction

(

)

Saving localization settings

Definition at line 174 of file WizardController.php.

    {
        $this->_checkIfInstalled();
        $step = $this->_getWizard()->getStepByName('locale');

        if ($data = $this->getRequest()->getPost('config')) {
            Mage::getSingleton('install/session')->setLocaleData($data);
        }

        $this->getResponse()->setRedirect($step->getNextUrl());
    }

preDispatch

(

)

Dispatches event before action

Reimplemented from Mage_Core_Controller_Varien_Action.

Definition at line 32 of file WizardController.php.

    {
        $this->setFlag('', self::FLAG_NO_CHECK_INSTALLATION, true);
        return parent::preDispatch();
    }

---

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

• app/code/core/Mage/Install/controllers/WizardController.php