filestack/filestack-php

View on GitHub
docs/classes/Filestack_FilestackException.html

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 - Filestack\FilestackException</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.html">Overview</a>
        </li>
        <li class="separator">
          <a href="../namespaces.html">Namespaces</a>
        </li>
        <li>
          <a href="../classes.html">Classes</a>
        </li>
        <li>
          <a href="../traits.html">Traits</a>
        </li>
        <li class="separator">
          <a href="../source/index.html">Source</a>
        </li>
      </ul>
    </nav>
    <div id="mainstage">
      <div class="box">
        <ul class="breadcrumb">
          <li>
            <a href="../index.html">Overview</a>
          </li>
          <li class="separator">
            <a href="../classes.html">Classes</a>
          </li>
          <li class="separator">
            <a href="../classes.html#Filestack">Filestack</a>
          </li>
          <li class="separator">FilestackException</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="#history">History</a>
          </li>
          <li>
            <a href="../source/FilestackException.php.html#line7">Source</a>
          </li>
        </ul>
      </nav>
      <section>
        <h1 id="introduction"><small>Filestack\</small>FilestackException</h1>
        <h4>A Filestack Excepton</h4>
        <p/>
        <ul/>
        <h2 id="synopsis">Synopsis</h2>
        <div class="synopsis">class FilestackException
                extends <a title="Exception" href="../classes/Exception.html">Exception</a>
            {<br/><ul class="none"><li>// Inherited members from <span title="Exception">Exception</span></li><li>protected  <a href="#members">$message</a>;
                        </li><li>protected  <a href="#members">$code</a>;
                        </li><li>protected  <a href="#members">$file</a>;
                        </li><li>protected  <a href="#members">$line</a>;
                        </li></ul><ul class="none"><li>// methods</li><li>public void <a title="Filestack\FilestackException" href="../classes/Filestack_FilestackException/__construct.html">__construct</a>()
                    </li><li>public void <a title="Filestack\FilestackException" href="../classes/Filestack_FilestackException/__toString.html">__toString</a>()
                    </li></ul><ul class="none"><li>// Inherited methods from <span title="Exception">Exception</span></li><li>public void <a title="Exception" href="../classes/Exception/__construct.html">__construct</a>()
                        </li><li>public final string <a title="Exception" href="../classes/Exception/getMessage.html">getMessage</a>()
                        </li><li>public final Throwable <a title="Exception" href="../classes/Exception/getPrevious.html">getPrevious</a>()
                        </li><li>public final mixed <a title="Exception" href="../classes/Exception/getCode.html">getCode</a>()
                        </li><li>public final string <a title="Exception" href="../classes/Exception/getFile.html">getFile</a>()
                        </li><li>public final int <a title="Exception" href="../classes/Exception/getLine.html">getLine</a>()
                        </li><li>public final array <a title="Exception" href="../classes/Exception/getTrace.html">getTrace</a>()
                        </li><li>public final string <a title="Exception" href="../classes/Exception/getTraceAsString.html">getTraceAsString</a>()
                        </li><li>public string <a title="Exception" href="../classes/Exception/__toString.html">__toString</a>()
                        </li></ul>

            }<br/></div>
        <h2 id="hierarchy">Hierarchy</h2>
        <div class="styled">
          <h4>Extends</h4>
          <ul>
            <li>
              <a title="Exception" href="../classes/Exception.html">Exception</a>
            </li>
          </ul>
        </div>
        <h2 id="members">Members</h2>
        <div class="styled members">
          <h4>protected</h4>
          <ul class="members">
            <li id="code"><strong>$code</strong>
                —
                int<br/><span class="indent">The exception code</span></li>
            <li id="file"><strong>$file</strong>
                —
                string<br/><span class="indent">The filename where the exception was created</span></li>
            <li id="line"><strong>$line</strong>
                —
                int<br/><span class="indent">The line where the exception was created</span></li>
            <li id="message"><strong>$message</strong>
                —
                string<br/><span class="indent">The exception message</span></li>
          </ul>
        </div>
        <h2 id="methods">Methods</h2>
        <div class="styled">
          <h4>public</h4>
          <ul>
            <li id="__construct">
              <a title="Filestack\FilestackException" href="../classes/Filestack_FilestackException/__construct.html">__construct()</a>
            </li>
            <li id="__toString">
              <a title="Filestack\FilestackException" href="../classes/Filestack_FilestackException/__toString.html">__toString()</a>
            </li>
          </ul>
          <h3>Inherited from <a title="Exception" href="../classes/Exception.html">Exception</a></h3>
          <h4>public</h4>
          <ul>
            <li id="__toString"><a title="Exception" href="../classes/Exception/__toString.html">__toString()</a>
                — String representation of the exception</li>
            <li id="getCode"><a title="Exception" href="../classes/Exception/getCode.html">getCode()</a>
                — Gets the Exception code</li>
            <li id="getFile"><a title="Exception" href="../classes/Exception/getFile.html">getFile()</a>
                — Gets the file in which the exception was created</li>
            <li id="getLine"><a title="Exception" href="../classes/Exception/getLine.html">getLine()</a>
                — Gets the line in which the exception was created</li>
            <li id="getMessage"><a title="Exception" href="../classes/Exception/getMessage.html">getMessage()</a>
                — Gets the Exception message</li>
            <li id="getPrevious"><a title="Exception" href="../classes/Exception/getPrevious.html">getPrevious()</a>
                — Returns previous Exception</li>
            <li id="getTrace"><a title="Exception" href="../classes/Exception/getTrace.html">getTrace()</a>
                — Gets the stack trace</li>
            <li id="getTraceAsString"><a title="Exception" href="../classes/Exception/getTraceAsString.html">getTraceAsString()</a>
                — Gets the stack trace as a string</li>
          </ul>
        </div>
        <h2 id="history">History</h2>
        <ul class="styled history">
          <li>
            <h3>2017-05-18T21:54:39+00:00 (commit #<span title="74f4ec3c7285949d0d41a30d4f38bb724cf6b262">74f4ec3</span>)</h3>
            <div>
              <p>
                        Author: Huey Ly (huey@webmail.us) /
                        Commiter: Huey Ly (huey@webmail.us)
                    </p>
              <pre class="wrapped">switched to use phpmd for codeclimate</pre>
            </div>
          </li>
          <li>
            <h3>2017-05-02T17:11:33+00:00 (commit #<span title="5b565df0c7c118ced08385041461389e8f9c2e3b">5b565df</span>)</h3>
            <div>
              <p>
                        Author: Huey Ly (huey@webmail.us) /
                        Commiter: Huey Ly (huey@webmail.us)
                    </p>
              <pre class="wrapped">added empty line at end of files.  removed test method in filepickerclient</pre>
            </div>
          </li>
          <li>
            <h3>2017-05-01T22:13:47+00:00 (commit #<span title="61c4278e687f5ca0ca3938a05c67ae2c12e54ca1">61c4278</span>)</h3>
            <div>
              <p>
                        Author: Huey Ly (huey@webmail.us) /
                        Commiter: Huey Ly (huey@webmail.us)
                    </p>
              <pre class="wrapped">removed ds_store, updated example, updated test with mocks</pre>
            </div>
          </li>
        </ul>
      </section>
    </div>
    <footer>
      <span>Generated using phpDox 0.12.0 - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
    </footer>
  </body>
</html>