docs/class-Baguette.Mastodon.Config.DotEnvStorage.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Baguette\Mastodon\Config\DotEnvStorage | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active">
<a href="namespace-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li class="active">
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="active main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li>
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-Baguette.Mastodon.Config.DotEnvStorage.html">DotEnvStorage</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-Baguette.Mastodon.Config.Storage.html">Storage</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-Baguette.Mastodon.Config.html" title="Summary of Baguette\Mastodon\Config"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class DotEnvStorage</h1>
<div class="description">
<p>Mastodon config storage using PHP dotenv</p>
<p>NOTICE: This class is designed for simple development use.
You should not use this for production environments or for batch processing.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
Dotenv\Loader
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by">
<b><span>Baguette\Mastodon\Config\DotEnvStorage</span></b>
implements
<a href="class-Baguette.Mastodon.Config.Storage.html"><span>Baguette\Mastodon\Config\Storage</span></a>
uses
<a href="class-Teto.Object.ReadOnly.html"><span>Teto\Object\ReadOnly</span></a>
</dd>
</dl>
<div class="info">
<b>Namespace:</b> <a href="namespace-Baguette.html">Baguette</a>\<a href="namespace-Baguette.Mastodon.html">Mastodon</a>\<a href="namespace-Baguette.Mastodon.Config.html">Config</a><br>
<b>Copyright:</b>
2017 Baguette HQ<br>
<b>License:</b>
<a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL-3.0</a><br>
<b>Author:</b>
USAMI Kenta <a href="mailto:tadsan@zonu.me">tadsan@zonu.me</a><br>
<b>See:</b>
https://github.com/vlucas/phpdotenv<br>
<b>Located at</b> <a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#10-298" title="Go to source code">Config/DotEnvStorage.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#46-68" title="Go to source code">__construct</a>( <span>string <var>$file_path</var></span>, <span>array <var>$options</var> = []</span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$file_path</var></dt>
<dd></dd>
<dt><var>$options</var></dt>
<dd></dd>
</dl></div>
<h4>Throws</h4>
<div class="list">
Dotenv\Exception\InvalidPathException
</div>
</div>
</div></td>
</tr>
<tr data-order="getAppName" id="_getAppName">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getAppName">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#70-82" title="Go to source code">getAppName</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
<tr data-order="setAppName" id="_setAppName">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setAppName">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#84-92" title="Go to source code">setAppName</a>( <span>string <var>$app_name</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$app_name</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getAuthorization" id="_getAuthorization">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getAuthorization">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#94-110" title="Go to source code">getAuthorization</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
<tr data-order="setAuthorization" id="_setAuthorization">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setAuthorization">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#112-125" title="Go to source code">setAuthorization</a>( <span>string <var>$access_token</var></span>, <span>string|string[]|<code><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></code> <var>$scope</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$created_at</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$access_token</var></dt>
<dd></dd>
<dt><var>$scope</var></dt>
<dd></dd>
<dt><var>$created_at</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="setAuthorizationFromObject" id="_setAuthorizationFromObject">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setAuthorizationFromObject">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#127-138" title="Go to source code">setAuthorizationFromObject</a>( <span><code><a href="class-Baguette.Mastodon.Service.Authorization.html">Baguette\Mastodon\Service\Authorization</a></code> <var>$authorization</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$authorization</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getClientIdAndSecret" id="_getClientIdAndSecret">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getClientIdAndSecret">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#140-154" title="Go to source code">getClientIdAndSecret</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
<tr data-order="setClientIdAndSecret" id="_setClientIdAndSecret">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setClientIdAndSecret">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#156-166" title="Go to source code">setClientIdAndSecret</a>( <span>string <var>$client_id</var></span>, <span>string <var>$client_secret</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$client_id</var></dt>
<dd></dd>
<dt><var>$client_secret</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getUsernameAndPassword" id="_getUsernameAndPassword">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getUsernameAndPassword">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#168-181" title="Go to source code">getUsernameAndPassword</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
<tr data-order="setUsernameAndPassword" id="_setUsernameAndPassword">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_setUsernameAndPassword">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#183-193" title="Go to source code">setUsernameAndPassword</a>( <span>string <var>$username</var></span>, <span>string <var>$password</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$username</var></dt>
<dd></dd>
<dt><var>$password</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="getValues" id="_getValues">
<td class="attributes"><code>
public
array
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getValues">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#195-212" title="Go to source code">getValues</a>( )</code>
<div class="description short">
<p>Returns all stored key-value pairs</p>
</div>
<div class="description detailed hidden">
<p>Returns all stored key-value pairs</p>
<h4>Returns</h4>
<div class="list">
array
</div>
</div>
</div></td>
</tr>
<tr data-order="getLines" id="_getLines">
<td class="attributes"><code>
public
string[]
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_getLines">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#214-229" title="Go to source code">getLines</a>( <span>resource <var>$fp</var> = <span class="php-keyword1">null</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$fp</var></dt>
<dd></dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
string[]
</div>
</div>
</div></td>
</tr>
<tr data-order="save" id="_save">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#231-287" title="Go to source code">save</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Implementation of</h4>
<div class="list"><code><a href="class-Baguette.Mastodon.Config.Storage.html#_save">Baguette\Mastodon\Config\Storage::save()</a></code></div>
</div>
</div></td>
</tr>
<tr data-order="quoteValue" id="_quoteValue">
<td class="attributes"><code>
public static
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_quoteValue">#</a>
<code><a href="source-class-Baguette.Mastodon.Config.DotEnvStorage.html#289-297" title="Go to source code">quoteValue</a>( <span>string <var>$value</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$value</var></dt>
<dd></dd>
</dl></div>
</div>
</div></td>
</tr>
</table>
<table class="summary used">
<caption>Methods used from <a href="class-Teto.Object.ReadOnly.html#methods">Teto\Object\ReadOnly</a></caption>
<tr>
<td><code>
<a href="class-Teto.Object.ReadOnly.html#___set">__set()</a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>