-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
163 changed files
with
35,929 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The documents in this directory were auto-generated. Do not edit these documents directly. |
261 changes: 261 additions & 0 deletions
261
dependencies/iu-redcap/phpcap/docs/api/classes/IU-PHPCap-ErrorHandler.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,261 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"> | ||
<head> | ||
<meta charset="utf-8"> | ||
<title>PHPCap API</title> | ||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
<base href="../"> | ||
<link rel="icon" href="images/favicon.ico"/> | ||
<link rel="stylesheet" href="css/normalize.css"> | ||
<link rel="stylesheet" href="css/base.css"> | ||
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet"> | ||
<link rel="stylesheet" href="css/template.css"> | ||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" /> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script> | ||
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script> | ||
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script> | ||
<script src="js/search.js"></script> | ||
<script defer src="js/searchIndex.js"></script> | ||
</head> | ||
<body id="top"> | ||
<header class="phpdocumentor-header phpdocumentor-section"> | ||
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHPCap API</a></h1> | ||
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" /> | ||
<label class="phpdocumentor-header__menu-icon" for="menu-button"> | ||
<i class="fas fa-bars"></i> | ||
</label> | ||
<section data-search-form class="phpdocumentor-search"> | ||
<label> | ||
<span class="visually-hidden">Search for</span> | ||
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http:https://www.w3.org/2000/svg"> | ||
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/> | ||
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/> | ||
</svg> | ||
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled /> | ||
</label> | ||
</section> | ||
|
||
<nav class="phpdocumentor-topnav"> | ||
<ul class="phpdocumentor-topnav__menu"> | ||
</ul> | ||
</nav> | ||
</header> | ||
|
||
<main class="phpdocumentor"> | ||
<div class="phpdocumentor-section"> | ||
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" /> | ||
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button"> | ||
Menu | ||
</label> | ||
<aside class="phpdocumentor-column -four phpdocumentor-sidebar"> | ||
|
||
<section class="phpdocumentor-sidebar__category"> | ||
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2> | ||
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/iu.html"><abbr title="\IU">IU</abbr></a></h4> | ||
<ul class="phpdocumentor-list"> | ||
<li><a href="namespaces/iu-phpcap.html"><abbr title="\IU\PHPCap">PHPCap</abbr></a></li> | ||
</ul> | ||
</section> | ||
|
||
|
||
<section class="phpdocumentor-sidebar__category"> | ||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2> | ||
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3> | ||
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3> | ||
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3> | ||
</section> | ||
|
||
<section class="phpdocumentor-sidebar__category"> | ||
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2> | ||
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3> | ||
</section> | ||
</aside> | ||
|
||
<div class="phpdocumentor-column -eight phpdocumentor-content"> | ||
<ul class="phpdocumentor-breadcrumbs"> | ||
<li class="phpdocumentor-breadcrumb"><a href="namespaces/iu.html">IU</a></li> | ||
<li class="phpdocumentor-breadcrumb"><a href="namespaces/iu-phpcap.html">PHPCap</a></li> | ||
</ul> | ||
|
||
<article class="phpdocumentor-element -class"> | ||
<h2 class="phpdocumentor-content__title"> | ||
ErrorHandler | ||
|
||
|
||
|
||
<span class="phpdocumentor-element__implements"> | ||
implements | ||
<a href="classes/IU-PHPCap-ErrorHandlerInterface.html"><abbr title="\IU\PHPCap\ErrorHandlerInterface">ErrorHandlerInterface</abbr></a> </span> | ||
|
||
</h2> | ||
|
||
<aside class="phpdocumentor-element-found-in"> | ||
<abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandler.php"><a href="files/src-errorhandler.html"><abbr title="src/ErrorHandler.php">ErrorHandler.php</abbr></a></abbr> | ||
: | ||
<span class="phpdocumentor-element-found-in__line">14</span> | ||
</aside> | ||
|
||
<p class="phpdocumentor-summary">Default error handler for PHPCap. PHPCap will call | ||
the throwException method of this class when | ||
an error occurs.</p> | ||
|
||
<section class="phpdocumentor-description"></section> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<h3 id="interfaces_class_traits"> | ||
Interfaces, Classes and Traits | ||
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a> | ||
</h3> | ||
|
||
<dl class="phpdocumentor-table-of-contents"> | ||
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/IU-PHPCap-ErrorHandlerInterface.html"><abbr title="\IU\PHPCap\ErrorHandlerInterface">ErrorHandlerInterface</abbr></a></dt> | ||
<dd>Interface for error handlers for PHPCap.</dd> | ||
|
||
|
||
</dl> | ||
|
||
|
||
<h3 id="toc"> | ||
Table of Contents | ||
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a> | ||
</h3> | ||
|
||
<dl class="phpdocumentor-table-of-contents"> | ||
<dt class="phpdocumentor-table-of-contents__entry -method -public"> | ||
<a href="classes/IU-PHPCap-ErrorHandler.html#method_throwException">throwException()</a> | ||
<span> | ||
: mixed </span> | ||
</dt> | ||
<dd>Throw an exception for the specified values.</dd> | ||
|
||
</dl> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<section class="phpdocumentor-methods"> | ||
<h3 class="phpdocumentor-elements__header" id="methods"> | ||
Methods | ||
<a href="classes/IU-PHPCap-ErrorHandler.html#methods" class="headerlink"><i class="fas fa-link"></i></a> | ||
</h3> | ||
<article | ||
class="phpdocumentor-element | ||
-method | ||
-public | ||
" | ||
> | ||
<h4 class="phpdocumentor-element__name" id="method_throwException"> | ||
throwException() | ||
<a href="classes/IU-PHPCap-ErrorHandler.html#method_throwException" class="headerlink"><i class="fas fa-link"></i></a> | ||
</h4> | ||
<aside class="phpdocumentor-element-found-in"> | ||
<abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandler.php"><a href="files/src-errorhandler.html"><abbr title="src/ErrorHandler.php">ErrorHandler.php</abbr></a></abbr> | ||
: | ||
<span class="phpdocumentor-element-found-in__line">22</span> | ||
</aside> | ||
|
||
<p class="phpdocumentor-summary">Throw an exception for the specified values.</p> | ||
|
||
<code class="phpdocumentor-code phpdocumentor-signature "> | ||
<span class="phpdocumentor-signature__visibility">public</span> | ||
<span class="phpdocumentor-signature__name">throwException</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$message</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$code</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$connectionErrorNumber</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$httpStatusCode</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$previousException</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> | ||
|
||
<section class="phpdocumentor-description"><p>See <a href="http:https://php.net/manual/en/function.debug-backtrace.php">debug_backtrace</a> | ||
for information on how to get a stack trace within this method.</p> | ||
</section> | ||
|
||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5> | ||
<dl class="phpdocumentor-argument-list"> | ||
<dt class="phpdocumentor-argument-list__entry"> | ||
<span class="phpdocumentor-signature__argument__name">$message</span> | ||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> | ||
</dt> | ||
<dd class="phpdocumentor-argument-list__definition"> | ||
<section class="phpdocumentor-description"><p>message describing the error that occurred.</p> | ||
</section> | ||
|
||
</dd> | ||
<dt class="phpdocumentor-argument-list__entry"> | ||
<span class="phpdocumentor-signature__argument__name">$code</span> | ||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> | ||
</dt> | ||
<dd class="phpdocumentor-argument-list__definition"> | ||
<section class="phpdocumentor-description"><p>the error code.</p> | ||
</section> | ||
|
||
</dd> | ||
<dt class="phpdocumentor-argument-list__entry"> | ||
<span class="phpdocumentor-signature__argument__name">$connectionErrorNumber</span> | ||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> | ||
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> | ||
<dd class="phpdocumentor-argument-list__definition"> | ||
<section class="phpdocumentor-description"><p>the error number from the underlying connection used, | ||
of null if no connection error occurred. | ||
For example, if cURL is being used (the default) this will be the cURL error number | ||
if a connection error occurs.</p> | ||
</section> | ||
|
||
</dd> | ||
<dt class="phpdocumentor-argument-list__entry"> | ||
<span class="phpdocumentor-signature__argument__name">$httpStatusCode</span> | ||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> | ||
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> | ||
<dd class="phpdocumentor-argument-list__definition"> | ||
<section class="phpdocumentor-description"><p>https status code, which would typcially be set if | ||
an error occurs with the http response from the REDCap API.</p> | ||
</section> | ||
|
||
</dd> | ||
<dt class="phpdocumentor-argument-list__entry"> | ||
<span class="phpdocumentor-signature__argument__name">$previousException</span> | ||
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> | ||
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt> | ||
<dd class="phpdocumentor-argument-list__definition"> | ||
<section class="phpdocumentor-description"><p>the previous exception that occurred that | ||
caused this exception, if any.</p> | ||
</section> | ||
|
||
</dd> | ||
</dl> | ||
|
||
|
||
|
||
<h5 class="phpdocumentor-return-value__heading">Return values</h5> | ||
<span class="phpdocumentor-signature__response_type">mixed</span> | ||
— | ||
<section class="phpdocumentor-description"></section> | ||
|
||
|
||
</article> | ||
</section> | ||
|
||
</article> | ||
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> | ||
<section class="phpdocumentor-search-results__dialog"> | ||
<header class="phpdocumentor-search-results__header"> | ||
<h2 class="phpdocumentor-search-results__title">Search results</h2> | ||
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button> | ||
</header> | ||
<section class="phpdocumentor-search-results__body"> | ||
<ul class="phpdocumentor-search-results__entries"></ul> | ||
</section> | ||
</section> | ||
</section> | ||
</div> | ||
</div> | ||
<a href="classes/IU-PHPCap-ErrorHandler.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> | ||
|
||
</main> | ||
|
||
<script> | ||
cssVars({}); | ||
</script> | ||
</body> | ||
</html> |
Oops, something went wrong.