gios-asu/nectary

View on GitHub
documentation/api/html/classes/Nectary_Configuration.xhtml

Summary

Maintainability
Test Coverage
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <title>phpDox - Nectary\Configuration</title>
    <link rel="stylesheet" type="text/css" href="../css/style.css" media="screen"/>
    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  </head>
  <body>
    <nav class="topnav">
      <ul>
        <li>
          <div class="logo"><span>/**</span>phpDox</div>
        </li>
        <li class="separator">
          <a href="../index.xhtml">Overview</a>
        </li>
        <li class="separator">
          <a href="../namespaces.xhtml">Namespaces</a>
        </li>
        <li>
          <a href="../interfaces.xhtml">Interfaces</a>
        </li>
        <li>
          <a href="../classes.xhtml">Classes</a>
        </li>
        <li>
          <a href="../traits.xhtml">Traits</a>
        </li>
        <li class="separator">
          <a href="../source/index.xhtml">Source</a>
        </li>
      </ul>
    </nav>
    <div id="mainstage">
      <div class="box">
        <ul class="breadcrumb">
          <li>
            <a href="../index.xhtml">Overview</a>
          </li>
          <li class="separator">
            <a href="../classes.xhtml">Classes</a>
          </li>
          <li class="separator">
            <a href="../classes.xhtml#Nectary">Nectary</a>
          </li>
          <li class="separator">Configuration</li>
        </ul>
      </div>
      <nav class="box">
        <ul>
          <li>
            <a href="#introduction">Introduction</a>
          </li>
          <li>
            <a href="#synopsis">Synopsis</a>
          </li>
          <li>
            <a href="#hierarchy">Hierarchy</a>
          </li>
          <li>
            <a href="#members">Members</a>
          </li>
          <li>
            <a href="#methods">Methods</a>
          </li>
          <li>
            <a href="../source/configuration/configuration.php.xhtml#line18">Source</a>
          </li>
        </ul>
      </nav>
      <section>
        <h1 id="introduction"><small>Nectary\</small>Configuration</h1>
        <h4>Configuration Singleton</h4>
        <p>House global configuration settings here. The Configuration<br/>object can load in a configuration .env file, or have<br/>attributes added to it programmatically.</p>
        <ul/>
        <h2 id="synopsis">Synopsis</h2>
        <div class="synopsis">class Configuration
                extends <a title="Nectary\Singleton" href="../classes/Nectary_Singleton.xhtml">Singleton</a>
            {<br/><ul class="none"><li>// members</li><li>public  <a href="#members">$attributes</a>;
                    </li></ul><ul class="none"><li>// Inherited members from <span title="Nectary\Singleton">Singleton</span></li><li>protected static array <a href="#members">$instances</a>;
                        </li></ul><ul class="none"><li>// methods</li><li>public static void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/set_configuration_path.xhtml">set_configuration_path</a>()
                    </li><li>public static void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/reset.xhtml">reset</a>()
                    </li><li>public void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/get.xhtml">get</a>()
                    </li><li>public void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/set.xhtml">set</a>()
                    </li><li>public void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/add.xhtml">add</a>()
                    </li><li>protected void <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/__construct.xhtml">__construct</a>()
                    </li></ul><ul class="none"><li>// Inherited methods from <span title="Nectary\Singleton">Singleton</span></li><li>protected void <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/__construct.xhtml">__construct</a>()
                        </li><li>protected void <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/__clone.xhtml">__clone</a>()
                        </li><li>public static mixed <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/get_instance.xhtml">get_instance</a>()
                        </li><li>public static void <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/set_instance.xhtml">set_instance</a>()
                        </li></ul>

            }<br/></div>
        <h2 id="hierarchy">Hierarchy</h2>
        <div class="styled">
          <h4>Extends</h4>
          <ul>
            <li>
              <a title="Nectary\Singleton" href="../classes/Nectary_Singleton.xhtml">Nectary\Singleton</a>
            </li>
          </ul>
        </div>
        <h2 id="members">Members</h2>
        <div class="styled members">
          <h4>protected</h4>
          <ul class="members">
            <li id="instances">
              <strong>$instances</strong>
            </li>
          </ul>
          <h4>public</h4>
          <ul class="members">
            <li id="attributes">
              <strong>$attributes</strong>
            </li>
          </ul>
        </div>
        <h2 id="methods">Methods</h2>
        <div class="styled">
          <h4>public</h4>
          <ul>
            <li id="add"><a title="Nectary\Configuration" href="../classes/Nectary_Configuration/add.xhtml">add()</a>
                — Add to an new or existing value.</li>
            <li id="get">
              <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/get.xhtml">get()</a>
            </li>
            <li id="reset">
              <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/reset.xhtml">reset()</a>
            </li>
            <li id="set">
              <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/set.xhtml">set()</a>
            </li>
            <li id="set_configuration_path">
              <a title="Nectary\Configuration" href="../classes/Nectary_Configuration/set_configuration_path.xhtml">set_configuration_path()</a>
            </li>
          </ul>
          <h3>Inherited from <a title="Nectary\Singleton" href="../classes/Nectary_Singleton.xhtml">Nectary\Singleton</a></h3>
          <h4>protected</h4>
          <ul>
            <li id="__clone">
              <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/__clone.xhtml">__clone()</a>
            </li>
          </ul>
          <h4>public</h4>
          <ul>
            <li id="get_instance">
              <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/get_instance.xhtml">get_instance()</a>
            </li>
            <li id="set_instance">
              <a title="Nectary\Singleton" href="../classes/Nectary_Singleton/set_instance.xhtml">set_instance()</a>
            </li>
          </ul>
        </div>
      </section>
    </div>
    <footer>
      <span>Generated using phpDox 0.8.2-dev - Copyright (C) 2010 - 2017 by Arne Blankerts</span>
    </footer>
  </body>
</html>