Config/Writer/Json.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Config
- Version
- $Id: Json.php 23293 2010-11-04 23:40:23Z ramon $
\Zend_Config_Writer_Json
Package: Zend\Config




Parameters







Abstract File Writer
- Parent(s)
- \Zend_Config_Writer_FileAbstract < \Zend_Config_Writer
- Category
- Zend
- Copyright
- Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id: FileAbstract.php 24593 2012-01-05 20:35:02Z matthew $
Properties


\Zend_Config $_config = null
inherited
Config object to write
Inherited from:
\Zend_Config_Writer::$$_config\Zend_Config_Writer_FileAbstract::$$_configDefault value
null
Details- Type
- \Zend_Config
- Inherited_from
- \Zend_Config_Writer::$$_config
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_config


boolean $_exclusiveLock = false
inherited
Wether to exclusively lock the file or not
Inherited from:
\Zend_Config_Writer_FileAbstract::$$_exclusiveLockDefault value
false
Details- Type
- boolean
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_exclusiveLock


string $_filename = null
Default value
null
Details- Type
- string
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_filename


boolean $_prettyPrint = false
If we need to pretty-print JSON data
Default value
false
Details- Type
- boolean


array $_skipOptions = array('options')
inherited
Option keys to skip when calling setOptions()
Inherited from:
\Zend_Config_Writer::$$_skipOptions\Zend_Config_Writer_FileAbstract::$$_skipOptionsDefault value
array('options')
Details- Type
- array
- Inherited_from
- \Zend_Config_Writer::$$_skipOptions
- Inherited_from
- \Zend_Config_Writer_FileAbstract::$$_skipOptions
Methods


__construct(null | array $options = null) : void
inherited
Create a new adapter
Inherited from: \Zend_Config_Writer::__construct()\Zend_Config_Writer_FileAbstract::__construct()$options can only be passed as array or be omitted
Name | Type | Description |
---|---|---|
$options | null | array |


render() : string
Render a Zend_Config into a JSON config string.
Returns
Details
Type | Description |
---|---|
string |
- Since
- 1.10


setConfig(\Zend_Config $config) : \Zend_Config_Writer
inherited
Set options via a Zend_Config instance
Inherited from: \Zend_Config_Writer::setConfig()\Zend_Config_Writer_FileAbstract::setConfig()Parameters
Returns
Name | Type | Description |
---|---|---|
$config | \Zend_Config |
Type | Description |
---|---|
\Zend_Config_Writer |


setExclusiveLock(boolean $exclusiveLock) : \Zend_Config_Writer_Array
inherited
Set wether to exclusively lock the file or not
Inherited from: \Zend_Config_Writer_FileAbstract::setExclusiveLock()Parameters
Returns
Name | Type | Description |
---|---|---|
$exclusiveLock | boolean |
Type | Description |
---|---|
\Zend_Config_Writer_Array |


setFilename(string $filename) : \Zend_Config_Writer_Array
Parameters
Returns
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
\Zend_Config_Writer_Array |


setOptions(array $options) : \Zend_Config_Writer
inherited
Set options via an array
Inherited from: \Zend_Config_Writer::setOptions()\Zend_Config_Writer_FileAbstract::setOptions()Parameters
Returns
Name | Type | Description |
---|---|---|
$options | array |
Type | Description |
---|---|
\Zend_Config_Writer |


setPrettyPrint( $flag) : \Zend_Config_Writer_Json
Set prettyPrint flag
Parameters
Returns
Name | Type | Description |
---|---|---|
$flag |
Type | Description |
---|---|
\Zend_Config_Writer_Json |


write(string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null) : void
Parameters
Name | Type | Description |
---|---|---|
$filename | string | |
$config | \Zend_Config | |
$exclusiveLock | bool |