ZF Class Reference

Public Member Functions
	bootstrap ()
	run ()

Static Public Member Functions
static	main ()

Protected Member Functions
	_detectMode ()
	_detectHomeDirectory ($mustExist=true, $returnMessages=true)
	_detectStorageDirectory ($mustExist=true, $returnMessages=true)
	_detectConfigFile ($mustExist=true, $returnMessages=true)
	_setupPHPRuntime ()
	_setupToolRuntime ()
	_tryClientLoad ()
	_runError ()
	_runInfo ()
	_runSetup ()
	_runSetupStorageDirectory ()
	_runSetupConfigFile ()
	_runSetupMoreInfo ()
	_runTool ()
	_logMessage ($message, $storeMessage=true)

Protected Attributes
	$_clientLoaded = false
	$_mode = 'runTool'
	$_messages = array()
	$_homeDirectory = null
	$_storageDirectory = null
	$_configFile = null

Detailed Description

Definition at line 32 of file zf.php.

Member Function Documentation

_detectConfigFile()

_detectConfigFile (   $mustExist = true,   $returnMessages = true  )

protected

_detectConfigFile() - Detect config file location from a variety of possibilities

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 258 of file zf.php.

    {
        $configFile = null;

        $configFile = getenv('ZF_CONFIG_FILE');
        if ($configFile) {
            $this->_logMessage('Config file found environment variable ZF_CONFIG_FILE at ' . $configFile, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($configFile))) {
                return $configFile;
            } else {
                $this->_logMessage('Config file does not exist at ' . $configFile, $returnMessages);
            }
        }

        $homeDirectory = ($this->_homeDirectory) ? $this->_homeDirectory : $this->_detectHomeDirectory(true, false);
        if ($homeDirectory) {
            $configFile = $homeDirectory . '/.zf.ini';
            $this->_logMessage('Config file assumed in home directory at location ' . $configFile, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($configFile))) {
                return $configFile;
            } else {
                $this->_logMessage('Config file does not exist at ' . $configFile, $returnMessages);
            }
        }

        $storageDirectory = ($this->_storageDirectory) ? $this->_storageDirectory : $this->_detectStorageDirectory(true, false);
        if ($storageDirectory) {
            $configFile = $storageDirectory . '/zf.ini';
            $this->_logMessage('Config file assumed in storage directory at location ' . $configFile, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($configFile))) {
                return $configFile;
            } else {
                $this->_logMessage('Config file does not exist at ' . $configFile, $returnMessages);
            }
        }

        return false;
    }

_detectHomeDirectory()

_detectHomeDirectory (   $mustExist = true,   $returnMessages = true  )

protected

_detectHomeDirectory() - detect the home directory in a variety of different places

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 164 of file zf.php.

    {
        $homeDirectory = null;

        $homeDirectory = getenv('ZF_HOME'); // check env var ZF_HOME
        if ($homeDirectory) {
            $this->_logMessage('Home directory found in environment variable ZF_HOME with value ' . $homeDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($homeDirectory))) {
                return $homeDirectory;
            } else {
                $this->_logMessage('Home directory does not exist at ' . $homeDirectory, $returnMessages);
            }
        }

        $homeDirectory = getenv('HOME'); // HOME environment variable

        if ($homeDirectory) {
            $this->_logMessage('Home directory found in environment variable HOME with value ' . $homeDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($homeDirectory))) {
                return $homeDirectory;
            } else {
                $this->_logMessage('Home directory does not exist at ' . $homeDirectory, $returnMessages);
            }

        }

        $homeDirectory = getenv('HOMEPATH');

        if ($homeDirectory) {
            $this->_logMessage('Home directory found in environment variable HOMEPATH with value ' . $homeDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($homeDirectory))) {
                return $homeDirectory;
            } else {
                $this->_logMessage('Home directory does not exist at ' . $homeDirectory, $returnMessages);
            }
        }

        $homeDirectory = getenv('USERPROFILE');

        if ($homeDirectory) {
            $this->_logMessage('Home directory found in environment variable USERPROFILE with value ' . $homeDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($homeDirectory))) {
                return $homeDirectory;
            } else {
                $this->_logMessage('Home directory does not exist at ' . $homeDirectory, $returnMessages);
            }
        }

        return false;
    }

_detectMode()

_detectMode ( )

protected

_detectMode()

Returns

ZF

Definition at line 129 of file zf.php.

    {
        $arguments = $_SERVER['argv'];

        $mode = 'runTool';

        if (!isset($arguments[0])) {
            return $mode;
        }

        if ($arguments[0] == $_SERVER['PHP_SELF']) {
            $this->_executable = array_shift($arguments);
        }

        if (!isset($arguments[0])) {
            return $mode;
        }

        if ($arguments[0] == '--setup') {
            $mode = 'runSetup';
        } elseif ($arguments[0] == '--info') {
            $mode = 'runInfo';
        }

        return $mode;
    }

_detectStorageDirectory()

_detectStorageDirectory (   $mustExist = true,   $returnMessages = true  )

protected

_detectStorageDirectory() - Detect where the storage directory is from a variaty of possiblities

Parameters

bool	$mustExist	Should the returned value already exist in the file system
bool	$returnMessages	Should it log messages for output later

Returns

string

Definition at line 222 of file zf.php.

    {
        $storageDirectory = false;

        $storageDirectory = getenv('ZF_STORAGE_DIR');
        if ($storageDirectory) {
            $this->_logMessage('Storage directory path found in environment variable ZF_STORAGE_DIR with value ' . $storageDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($storageDirectory))) {
                return $storageDirectory;
            } else {
                $this->_logMessage('Storage directory does not exist at ' . $storageDirectory, $returnMessages);
            }
        }

        $homeDirectory = ($this->_homeDirectory) ? $this->_homeDirectory : $this->_detectHomeDirectory(true, false);

        if ($homeDirectory) {
            $storageDirectory = $homeDirectory . '/.zf/';
            $this->_logMessage('Storage directory assumed in home directory at location ' . $storageDirectory, $returnMessages);
            if (!$mustExist || ($mustExist && file_exists($storageDirectory))) {
                return $storageDirectory;
            } else {
                $this->_logMessage('Storage directory does not exist at ' . $storageDirectory, $returnMessages);
            }
        }

        return false;
    }

_logMessage()

_logMessage (   $message,   $storeMessage = true  )

protected

_logMessage() - Internal method used to log setup and information messages.

Parameters

string	$message
bool	$storeMessage

Returns

void

Definition at line 610 of file zf.php.

    {
        if (!$storeMessage) {
            return;
        }

        $this->_messages[] = $message;
    }

_runError()

_runError ( )

protected

_runError() - Output the error screen that tells the user that the tool was not setup in a sane way

Returns

void

Definition at line 402 of file zf.php.

    {

        echo <<<EOS

***************************** ZF ERROR ********************************
In order to run the zf command, you need to ensure that Zend Framework
is inside your include_path.  There are a variety of ways that you can
ensure that this zf command line tool knows where the Zend Framework
library is on your system, but not all of them can be described here.

The easiest way to get the zf command running is to give it the include
path via an environment variable ZEND_TOOL_INCLUDE_PATH or
ZEND_TOOL_INCLUDE_PATH_PREPEND with the proper include path to use,
then run the command "zf --setup".  This command is designed to create
a storage location for your user, as well as create the zf.ini file
that the zf command will consult in order to run properly on your
system.

Example you would run:

$ ZEND_TOOL_INCLUDE_PATH=/path/to/library zf --setup

Your are encourged to read more in the link that follows.

EOS;

    }

_runInfo()

_runInfo ( )

protected

_runInfo() - this command will produce information about the setup of this script and Zend_Tool

Returns

void

Definition at line 437 of file zf.php.

    {
        echo 'Zend_Tool & CLI Setup Information' . PHP_EOL
           . '(available via the command line "zf --info")'
           . PHP_EOL;

        echo '   * ' . implode(PHP_EOL . '   * ', $this->_messages) . PHP_EOL;

        echo PHP_EOL;

        echo 'To change the setup of this tool, run: "zf --setup"';

        echo PHP_EOL;

    }

_runSetup()

_runSetup ( )

protected

_runSetup() - parse the request to see which setup command to run

Returns

void

Definition at line 458 of file zf.php.

    {
        $setupCommand = (isset($_SERVER['argv'][2])) ? $_SERVER['argv'][2] : null;

        switch ($setupCommand) {
            case 'storage-directory':
                $this->_runSetupStorageDirectory();
                break;
            case 'config-file':
                $this->_runSetupConfigFile();
                break;
            default:
                $this->_runSetupMoreInfo();
                break;
        }
    }

_runSetupConfigFile()

_runSetupConfigFile ( )

protected

_runSetupConfigFile()

Returns

void

Definition at line 500 of file zf.php.

    {
        $configFile = $this->_detectConfigFile(false, false);

        if (file_exists($configFile)) {
            echo 'File already exists at ' . $configFile . PHP_EOL
               . 'Cannot write new config file.';
            return;
        }

        $includePath = get_include_path();

        $contents = 'php.include_path = "' . $includePath . '"';

        file_put_contents($configFile, $contents);

        $iniValues = ini_get_all();
        if ($iniValues['include_path']['global_value'] != $iniValues['include_path']['local_value']) {
            echo 'NOTE: the php include_path to be used with the tool has been written' . PHP_EOL
               . 'to the config file, using ZEND_TOOL_INCLUDE_PATH (or other include_path setters)' . PHP_EOL
               . 'is no longer necessary.' . PHP_EOL . PHP_EOL;
        }

        echo 'Config file written to ' . $configFile . PHP_EOL;
    }

_runSetupMoreInfo()

_runSetupMoreInfo ( )

protected

_runSetupMoreInfo() - return more information about what can be setup, and what is setup

Returns

void

Definition at line 531 of file zf.php.

    {
        $homeDirectory    = $this->_detectHomeDirectory(false, false);
        $storageDirectory = $this->_detectStorageDirectory(false, false);
        $configFile       = $this->_detectConfigFile(false, false);

        echo <<<EOS

ZF Command Line Tool - Setup
----------------------------

Current Paths (Existing or not):
    Home Directory: {$homeDirectory}
    Storage Directory: {$storageDirectory}
    Config File: {$configFile}

Important Environment Variables:
    ZF_HOME
        - the directory this tool will look for a home directory
        - directory must exist
    ZF_STORAGE_DIR
        - where this tool will look for a storage directory
        - directory must exist
    ZF_CONFIG_FILE
        - where this tool will look for a configuration file
    ZF_TOOL_INCLUDE_PATH
        - set the include_path for this tool to use this value
    ZF_TOOL_INCLUDE_PATH_PREPEND
        - prepend the current php.ini include_path with this value

Search Order:
    Home Directory:
        - ZF_HOME, then HOME (*nix), then HOMEPATH (windows)
    Storage Directory:
        - ZF_STORAGE_DIR, then {home}/.zf/
    Config File:
        - ZF_CONFIG_FILE, then {home}/.zf.ini, then {home}/zf.ini,
          then {storage}/zf.ini

Commands:
    zf --setup storage-directory
        - setup the storage directory, directory will be created
    zf --setup config-file
        - create the config file with some default values


EOS;
    }

_runSetupStorageDirectory()

_runSetupStorageDirectory ( )

protected

_runSetupStorageDirectory() - if the storage directory does not exist, create it

Returns

void

Definition at line 480 of file zf.php.

    {
        $storageDirectory = $this->_detectStorageDirectory(false, false);

        if (file_exists($storageDirectory)) {
            echo 'Directory already exists at ' . $storageDirectory . PHP_EOL
               . 'Cannot create storage directory.';
            return;
        }

        mkdir($storageDirectory);

        echo 'Storage directory created at ' . $storageDirectory . PHP_EOL;
    }

_runTool()

_runTool ( )

protected

_runTool() - This is where the magic happens, dispatch Zend_Tool

Returns

void

Definition at line 585 of file zf.php.

    {

        $configOptions = array();
        if (isset($this->_configFile) && $this->_configFile) {
            $configOptions['configOptions']['configFilepath'] = $this->_configFile;
        }
        if (isset($this->_storageDirectory) && $this->_storageDirectory) {
            $configOptions['storageOptions']['directory'] = $this->_storageDirectory;
        }

        // ensure that zf.php loads the Zend_Tool_Project features
        $configOptions['classesToLoad'] = 'Zend_Tool_Project_Provider_Manifest';

        $console = new Zend_Tool_Framework_Client_Console($configOptions);
        $console->dispatch();
    }

_setupPHPRuntime()

_setupPHPRuntime ( )

protected

_setupPHPRuntime() - parse the config file if it exists for php ini values to set

Returns

void

Definition at line 303 of file zf.php.

    {
        // set php runtime settings
        ini_set('display_errors', true);

        // support the changing of the current working directory, necessary for some providers
        $cwd = getenv('ZEND_TOOL_CURRENT_WORKING_DIRECTORY');
        if ($cwd != '' && realpath($cwd)) {
            chdir($cwd);
        }

        if (!$this->_configFile) {
            return;
        }
        $zfINISettings = parse_ini_file($this->_configFile);
        $phpINISettings = ini_get_all();
        foreach ($zfINISettings as $zfINIKey => $zfINIValue) {
            if (substr($zfINIKey, 0, 4) === 'php.') {
                $phpINIKey = substr($zfINIKey, 4);
                if (array_key_exists($phpINIKey, $phpINISettings)) {
                    ini_set($phpINIKey, $zfINIValue);
                }
            }
        }
    }

_setupToolRuntime()

_setupToolRuntime ( )

protected

_setupToolRuntime() - setup the tools include_path and load the proper framwork parts that enable Zend_Tool to work.

Returns

void

Definition at line 335 of file zf.php.

    {

        $includePathPrepend = getenv('ZEND_TOOL_INCLUDE_PATH_PREPEND');
        $includePathFull = getenv('ZEND_TOOL_INCLUDE_PATH');

        // check if the user has not provided anything
        if (!($includePathPrepend || $includePathFull)) {
            if ($this->_tryClientLoad()) {
                return;
            }
        }

        // if ZF is not in the include_path, but relative to this file, put it in the include_path
        if ($includePathPrepend || $includePathFull) {
            if (isset($includePathPrepend) && ($includePathPrepend !== false)) {
                set_include_path($includePathPrepend . PATH_SEPARATOR . get_include_path());
            } elseif (isset($includePathFull) && ($includePathFull !== false)) {
                set_include_path($includePathFull);
            }
        }

        if ($this->_tryClientLoad()) {
            return;
        }

        $zfIncludePath['relativePath'] = dirname(__FILE__) . '/../library/';
        if (file_exists($zfIncludePath['relativePath'] . 'Zend/Tool/Framework/Client/Console.php')) {
            set_include_path(realpath($zfIncludePath['relativePath']) . PATH_SEPARATOR . get_include_path());
        }

        if (!$this->_tryClientLoad()) {
            $this->_mode = 'runError';
            return;
        }
    }

_tryClientLoad()

_tryClientLoad ( )

protected

_tryClientLoad() - Attempt to load the Zend_Tool_Framework_Client_Console to enable the tool to run.

This method will return false if its not loaded to allow the consumer to alter the environment in such a way that it can be called again to try loading the proper file/class.

Returns

bool if the client is actuall loaded or not

Definition at line 380 of file zf.php.

    {
        $this->_clientLoaded = false;
        $fh = @fopen('Zend/Tool/Framework/Client/Console.php', 'r', true);
        if (!$fh) {
            return $this->_clientLoaded; // false
        } else {
            fclose($fh);
            unset($fh);
            include 'Zend/Tool/Framework/Client/Console.php';
            $this->_clientLoaded = class_exists('Zend_Tool_Framework_Client_Console');
        }

        return $this->_clientLoaded;
    }

bootstrap()

bootstrap

(

)

bootstrap()

Returns

ZF

Definition at line 82 of file zf.php.

    {
        // detect settings
        $this->_mode             = $this->_detectMode();
        $this->_homeDirectory    = $this->_detectHomeDirectory();
        $this->_storageDirectory = $this->_detectStorageDirectory();
        $this->_configFile       = $this->_detectConfigFile();

        // setup
        $this->_setupPHPRuntime();
        $this->_setupToolRuntime();
    }

main()

static main ( )

static

main()

Returns

void

Definition at line 70 of file zf.php.

    {
        $zf = new self();
        $zf->bootstrap();
        $zf->run();
    }

run()

run

(

)

run()

Returns

ZF

Definition at line 100 of file zf.php.

    {
        switch ($this->_mode) {
            case 'runError':
                $this->_runError();
                $this->_runInfo();
                break;
            case 'runSetup':
                if ($this->_runSetup() === false) {
                    $this->_runInfo();
                }
                break;
            case 'runInfo':
                $this->_runInfo();
                break;
            case 'runTool':
            default:
                $this->_runTool();
                break;
        }

        return $this;
    }

Field Documentation

$_clientLoaded

$_clientLoaded = false

protected

Definition at line 38 of file zf.php.

$_configFile

$_configFile = null

protected

Definition at line 63 of file zf.php.

$_homeDirectory

$_homeDirectory = null

protected

Definition at line 53 of file zf.php.

$_messages

$_messages = array()

protected

Definition at line 48 of file zf.php.

$_mode

$_mode = 'runTool'

protected

Definition at line 43 of file zf.php.

$_storageDirectory

$_storageDirectory = null

protected

Definition at line 58 of file zf.php.

---

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

• vendor/magento/zendframework1/bin/zf.php