Config/Writer/Yaml.php

Show:

inherited

Classes
- \Zend_Config_Writer_Yaml

Table of Contents

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 [email protected] 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: Yaml.php 23650 2011-01-21 21:32:57Z mikaelkael $

\Zend_Config_Writer_Yaml
jump to top

Package: Zend\Config

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::$$_config

Default valuenullDetails

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::$$_exclusiveLock

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Config_Writer_FileAbstract::$$_exclusiveLock

string $_filename = null

inherited

Filename to write to

Inherited from: \Zend_Config_Writer_FileAbstract::$$_filename

Default valuenullDetails

Type: string
Inherited_from: \Zend_Config_Writer_FileAbstract::$$_filename

array $_skipOptions = array('options')

inherited

Option keys to skip when calling setOptions()

Inherited from: \Zend_Config_Writer::$$_skipOptions \Zend_Config_Writer_FileAbstract::$$_skipOptions

Default valuearray('options')Details

Type: array
Inherited_from: \Zend_Config_Writer::$$_skipOptions
Inherited_from: \Zend_Config_Writer_FileAbstract::$$_skipOptions

\callable $_yamlEncoder = array('Zend_Config_Writer_Yaml', 'encode')

What to call when we need to decode some YAML?

Default valuearray('Zend_Config_Writer_Yaml', 'encode')Details

Type: \callable

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

Parameters

Name	Type	Description
$options	null \| array

_encodeYaml(int $indent, array $data) : string

static

Service function for encoding YAML

Parameters

Name	Type	Description
$indent	int	Current indent level
$data	array	Data to encode

Returns

Type	Description
string

encode(array $data) : string

static

Very dumb YAML encoder

Until we have Zend_Yaml...

Parameters

Name	Type	Description
$data	array	YAML data

Returns

Type	Description
string

getYamlEncoder() : \callable

Get callback for decoding YAML

Returns

Type	Description
\callable

render() : string

Render a Zend_Config into a YAML config string.

Returns

Type	Description
string

Details

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

Name	Type	Description
$config	\Zend_Config

Returns

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

Name	Type	Description
$exclusiveLock	boolean

Returns

Type	Description
\Zend_Config_Writer_Array

setFilename(string $filename) : \Zend_Config_Writer_Array

inherited

Set the target filename

Inherited from: \Zend_Config_Writer_FileAbstract::setFilename()

Parameters

Name	Type	Description
$filename	string

Returns

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

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Config_Writer

setYamlEncoder(\callable $yamlEncoder) : \Zend_Config_Yaml

Set callback for decoding YAML

Parameters

Name	Type	Description
$yamlEncoder	\callable	the decoder to set

Returns

Type	Description
\Zend_Config_Yaml

write(string $filename = null, \Zend_Config $config = null, bool $exclusiveLock = null) : void

inherited

Write configuration to file.

Inherited from: \Zend_Config_Writer_FileAbstract::write()

Parameters

Name	Type	Description
$filename	string
$config	\Zend_Config
$exclusiveLock	bool

Config/Writer/Yaml.php

\Zend_Config_Writer_Yamljump to top

Properties

Methods

\Zend_Config_Writer_Yaml
jump to top