Zend_Config_Writer_FileAbstract Class Reference

Inheritance diagram for Zend_Config_Writer_FileAbstract:

Public Member Functions
	setFilename ($filename)
	setExclusiveLock ($exclusiveLock)
	write ($filename=null, Zend_Config $config=null, $exclusiveLock=null)
	render ()
Public Member Functions inherited from Zend_Config_Writer
	__construct (array $options=null)
	setConfig (Zend_Config $config)
	setOptions (array $options)
	write ()

Protected Attributes
	$_filename = null
	$_exclusiveLock = false
Protected Attributes inherited from Zend_Config_Writer
	$_skipOptions
	$_config = null

Detailed Description

Definition at line 33 of file FileAbstract.php.

Member Function Documentation

render()

render

(

)

Render a Zend_Config into a config file string.

Since

1.10

Todo:

For 2.0 this should be redone into an abstract method.

Returns

string

Definition at line 130 of file FileAbstract.php.

    {
        return "";
    }

setExclusiveLock()

setExclusiveLock

(

$exclusiveLock

)

Set wether to exclusively lock the file or not

Parameters

boolean

$exclusiveLock

Returns

Zend_Config_Writer_Array

Definition at line 68 of file FileAbstract.php.

    {
        $this->_exclusiveLock = $exclusiveLock;

        return $this;
    }

setFilename()

setFilename

(

$filename

)

Set the target filename

Parameters

string

$filename

Returns

Zend_Config_Writer_Array

Definition at line 55 of file FileAbstract.php.

    {
        $this->_filename = $filename;

        return $this;
    }

write()

write	(		$filename = null,
		Zend_Config	$config = null,
			$exclusiveLock = null
	)

Write configuration to file.

Parameters

string	$filename
Zend_Config	$config
bool	$exclusiveLock

Returns

void

Definition at line 83 of file FileAbstract.php.

    {
        if ($filename !== null) {
            $this->setFilename($filename);
        }

        if ($config !== null) {
            $this->setConfig($config);
        }

        if ($exclusiveLock !== null) {
            $this->setExclusiveLock($exclusiveLock);
        }

        if ($this->_filename === null) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('No filename was set');
        }

        if ($this->_config === null) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('No config was set');
        }

        $configString = $this->render();

        $flags = 0;

        if ($this->_exclusiveLock) {
            $flags |= LOCK_EX;
        }

        $result = @file_put_contents($this->_filename, $configString, $flags);

        if ($result === false) {
            #require_once 'Zend/Config/Exception.php';
            throw new Zend_Config_Exception('Could not write to file "' . $this->_filename . '"');
        }
    }

Field Documentation

$_exclusiveLock

$_exclusiveLock = false

protected

Definition at line 47 of file FileAbstract.php.

$_filename

$_filename = null

protected

Definition at line 40 of file FileAbstract.php.

---

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

• vendor/magento/zendframework1/library/Zend/Config/Writer/FileAbstract.php