Mage_Core_Model_Config_Options Class Reference

Inheritance diagram for Mage_Core_Model_Config_Options:

List of all members.

Public Member Functions
	getDir ($type)
	getAppDir ()
	getBaseDir ()
	getCodeDir ()
	getDesignDir ()
	getEtcDir ()
	getLibDir ()
	getLocaleDir ()
	getMediaDir ()
	getSkinDir ()
	getSysTmpDir ()
	getVarDir ()
	getTmpDir ()
	getCacheDir ()
	getLogDir ()
	getSessionDir ()
	getUploadDir ()
	getExportDir ()
	createDirIfNotExists ($dir)
Protected Member Functions
	_construct ()
Protected Attributes
	$_dirExists = array()

---

Detailed Description

Definition at line 34 of file Options.php.

---

Member Function Documentation

_construct

(

)

[protected]

Initialize default values of the options

Reimplemented from Varien_Object.

Definition at line 46 of file Options.php.

    {
        $appRoot= Mage::getRoot();
        $root   = dirname($appRoot);

        $this->_data['app_dir']     = $appRoot;
        $this->_data['base_dir']    = $root;
        $this->_data['code_dir']    = $appRoot.DS.'code';
        $this->_data['design_dir']  = $appRoot.DS.'design';
        $this->_data['etc_dir']     = $appRoot.DS.'etc';
        $this->_data['lib_dir']     = $root.DS.'lib';
        $this->_data['locale_dir']  = $appRoot.DS.'locale';
        $this->_data['media_dir']   = $root.DS.'media';
        $this->_data['skin_dir']    = $root.DS.'skin';
        $this->_data['var_dir']     = $this->getVarDir();
        $this->_data['tmp_dir']     = $this->_data['var_dir'].DS.'tmp';
        $this->_data['cache_dir']   = $this->_data['var_dir'].DS.'cache';
        $this->_data['log_dir']     = $this->_data['var_dir'].DS.'log';
        $this->_data['session_dir'] = $this->_data['var_dir'].DS.'session';
        $this->_data['upload_dir']  = $this->_data['media_dir'].DS.'upload';
        $this->_data['export_dir']  = $this->_data['var_dir'].DS.'export';
    }

createDirIfNotExists

(

$

dir

)

Definition at line 205 of file Options.php.

    {
        if (!empty($this->_dirExists[$dir])) {
            return true;
        }
        if (file_exists($dir)) {
            if (!is_dir($dir)) {
                return false;
            }
            if (!is_dir_writeable($dir)) {
                return false;
            }
        } else {
            if (!@mkdir($dir, 0777, true)) {
                return false;
            }
        }
        $this->_dirExists[$dir] = true;
        return true;
    }

getAppDir

(

)

Definition at line 80 of file Options.php.

    {
        //return $this->getDataSetDefault('app_dir', Mage::getRoot());
        return $this->_data['app_dir'];
    }

getBaseDir

(

)

Definition at line 86 of file Options.php.

    {
        //return $this->getDataSetDefault('base_dir', dirname($this->getAppDir()));
        return $this->_data['base_dir'];
    }

getCacheDir

(

)

Definition at line 165 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('cache_dir', $this->getVarDir().DS.'cache');
        $dir = $this->_data['cache_dir'];
        $this->createDirIfNotExists($dir);
        return $dir;
    }

getCodeDir

(

)

Definition at line 92 of file Options.php.

    {
        //return $this->getDataSetDefault('code_dir', $this->getAppDir().DS.'code');
        return $this->_data['code_dir'];
    }

getDesignDir

(

)

Definition at line 98 of file Options.php.

    {
        //return $this->getDataSetDefault('design_dir', $this->getAppDir().DS.'design');
        return $this->_data['design_dir'];
    }

getDir

(

$

type

)

Definition at line 69 of file Options.php.

    {
        $this->_construct();
        $method = 'get'.ucwords($type).'Dir';
        $dir = $this->$method();
        if (!$dir) {
            throw Mage::exception('Mage_Core', 'Invalid dir type requested: '.$type);
        }
        return $dir;
    }

getEtcDir

(

)

Definition at line 104 of file Options.php.

    {
        //return $this->getDataSetDefault('etc_dir', $this->getAppDir().DS.'etc');
        return $this->_data['etc_dir'];
    }

getExportDir

(

)

Definition at line 197 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('export_dir', $this->getVarDir().DS.'export');
        $dir = $this->_data['export_dir'];
        $this->createDirIfNotExists($dir);
        return $dir;
    }

getLibDir

(

)

Definition at line 110 of file Options.php.

    {
        //return $this->getDataSetDefault('lib_dir', $this->getBaseDir().DS.'lib');
        return $this->_data['lib_dir'];
    }

getLocaleDir

(

)

Definition at line 116 of file Options.php.

    {
        //return $this->getDataSetDefault('locale_dir', $this->getAppDir().DS.'locale');
        return $this->_data['locale_dir'];
    }

getLogDir

(

)

Definition at line 173 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('log_dir', $this->getVarDir().DS.'log');
        $dir = $this->_data['log_dir'];
        $this->createDirIfNotExists($dir);
        return $dir;
    }

getMediaDir

(

)

Definition at line 122 of file Options.php.

    {
        //return $this->getDataSetDefault('media_dir', $this->getBaseDir().DS.'media');
        return $this->_data['media_dir'];
    }

getSessionDir

(

)

Definition at line 181 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('session_dir', $this->getVarDir().DS.'session');
        $dir = $this->_data['session_dir'];
        $this->createDirIfNotExists($dir);
        return $dir;
    }

getSkinDir

(

)

Definition at line 128 of file Options.php.

    {
        //return $this->getDataSetDefault('skin_dir', $this->getBaseDir().DS.'skin');
        return $this->_data['skin_dir'];
    }

getSysTmpDir

(

)

Definition at line 134 of file Options.php.

    {
        return sys_get_temp_dir();
    }

getTmpDir

(

)

Definition at line 152 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('tmp_dir', $this->getVarDir().DS.'tmp');
        $dir = $this->_data['tmp_dir'];
        if (!$this->createDirIfNotExists($dir)) {
            $dir = $this->getSysTmpDir().DS.'magento'.DS.'tmp';
            if (!$this->createDirIfNotExists($dir)) {
                throw new Mage_Core_Exception('Unable to find writable tmp_dir');
            }
        }
        return $dir;
    }

getUploadDir

(

)

Definition at line 189 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('upload_dir', $this->getMediaDir().DS.'upload');
        $dir = $this->_data['upload_dir'];
        $this->createDirIfNotExists($dir);
        return $dir;
    }

getVarDir

(

)

Definition at line 139 of file Options.php.

    {
        //$dir = $this->getDataSetDefault('var_dir', $this->getBaseDir().DS.'var');
        $dir = isset($this->_data['var_dir']) ? $this->_data['var_dir'] : $this->_data['base_dir'].DS.'var';
        if (!$this->createDirIfNotExists($dir)) {
            $dir = $this->getSysTmpDir().DS.'magento'.DS.'var';
            if (!$this->createDirIfNotExists($dir)) {
                throw new Mage_Core_Exception('Unable to find writable var_dir');
            }
        }
        return $dir;
    }

---

Member Data Documentation

$_dirExists = array() [protected]

Definition at line 41 of file Options.php.

---

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

• app/code/core/Mage/Core/Model/Config/Options.php