<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Retrieve a item</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaconf.html">Yaconf</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaconf.has.html">Yaconf::has</a></div>
<div class="up"><a href="class.yaconf.html">Yaconf</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaconf.get" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaconf::get</h1>
<p class="verinfo">(PECL yaconf >= 1.0.0)</p><p class="refpurpose"><span class="refname">Yaconf::get</span> — <span class="dc-title">Retrieve a item</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaconf.get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Yaconf::get</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$default_value</code><span class="initializer"> = NULL</span></span>
] )</div>
<p class="para rdfs-comment">
</p>
</div>
<div class="refsect1 parameters" id="refsect1-yaconf.get-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">name</code></dt>
<dd>
<p class="para">
Configuration key, the key looks like "filename.key", or "filename.sectionName,key".
</p>
</dd>
<dt>
<code class="parameter">default_value</code></dt>
<dd>
<p class="para">
if the key doesn't exists, Yaconf::get will return this as result.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaconf.get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns configuration result(string or array) if the key exists,
return default_value if not.
</p>
</div>
<div class="refsect1 examples" id="refsect1-yaconf.get-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-5125">
<p><strong>Example #1 <span class="function"><strong>INI()</strong></span>example</strong></p>
<div class="example-contents">
<div class="inicode"><pre class="inicode">;filenmame foo.ini, placed in directory which is yaconf.directoy
[SectionA]
;key value pair
key=val
;hash[a]=val
hash.a=val
;arr[0]=val
arr.0=val
;or
arr[]=val
;SectionB inherits SectionA
[SectionB:SectionA]
;override configuration key in SectionA
key=new_val</pre>
</div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
php7 -r 'var_dump(Yaconf::get("foo.SectionA.key"));'
//string(3) "val"
php7 -r 'var_dump(Yaconf::get("foo.SectionB.key"));'
//string(7) "new_val"
php7 -r 'var_dump(Yaconf::get("foo")["SectionA"]["hash"]);'
//array(1)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaconf.html">Yaconf</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaconf.has.html">Yaconf::has</a></div>
<div class="up"><a href="class.yaconf.html">Yaconf</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
