Skip to content

Commit d2841c0

Browse files
mullen2mullen2
committed
Updated generated documentation
1 parent 1a45ec8 commit d2841c0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+5347
-4328
lines changed

‎composer.lock

+185-187
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs-md/DeveloperGuide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Setup
2222
2. Get PHPCap:
2323

2424
```shell
25-
git clone https://github.com/aarenson/PHPCap
25+
git clone https://github.com/iuredcap/phpcap
2626
```
2727

2828
3. Get Composer. Composer is needed to download the development depedencies for PHPCap.
@@ -49,7 +49,7 @@ To set up PHPCap for development on Ubuntu 16, execute the following commands:
4949
sudo apt-get install php php-curl php-xml php-mbstring
5050
sudo apt-get install php-xdebug
5151
sudo apt-get install git
52-
git clone https://github.com/aarenson/PHPCap
52+
git clone https://github.com/iuredcap/phpcap
5353
sudo apt-get install composer
5454
cd PHPCap
5555
composer install

‎docs-md/UserGuide1.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ If you have [Composer](https://getcomposer.org/) installed, you can get PHPCap u
6262

6363
If you have [Git](https://git-scm.com/) installed, you can use the following:
6464

65-
git clone https://github.com/aarenson/PHPCap
65+
git clone https://github.com/iuredcap/phpcap
6666

6767
If you don't have Composer or Git installed, you can get a Zip file of PHPCap from GitHub by clicking on this link:
6868
69-
https://github.com/aarenson/PHPCap/archive/master.zip
69+
https://github.com/iuredcap/phpcap/archive/master.zip
7070
7171
Or go to this page and click on the "Clone or download" button, and then click on "Download ZIP":
7272
73-
https://github.com/aarenson/PHPCap/
73+
https://github.com/iuredcap/phpcap/
7474
7575
Then unzip the file to your project directory.
7676

‎docs-md/UserGuide2.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ The four main classes provided by PHPCap for users are:
1717
<tbody>
1818
<tr>
1919
<td>
20-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html">RedCapProject</a>
20+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html">RedCapProject</a>
2121
</td>
2222
<td>
2323
Used to retrieve data from, and modify, a project in REDCap.
2424
</td>
2525
</tr>
2626
<tr>
2727
<td>
28-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCap.html">RedCap</a>
28+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCap.html">RedCap</a>
2929
</td>
3030
<td>
3131
Represents a REDCap instance/site. This class is only required for creating new REDCap
@@ -36,7 +36,7 @@ The four main classes provided by PHPCap for users are:
3636
</tr>
3737
<tr>
3838
<td>
39-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.FileUtil.html">FileUtil</a>
39+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.FileUtil.html">FileUtil</a>
4040
</td>
4141
<td>
4242
Used to read from, and write to, files. FileUtil is
@@ -46,7 +46,7 @@ The four main classes provided by PHPCap for users are:
4646
</tr>
4747
<tr>
4848
<td>
49-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.PhpCapException.html">PhpCapException</a>
49+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.PhpCapException.html">PhpCapException</a>
5050
</td>
5151
<td>
5252
Exception class used by PHPCap when an error occurs.

‎docs-md/UserGuide3.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The exportRecords method is a standard PHP method that has 12 parameters that ca
2323
be set to modify the records that are exported and their format.
2424

2525
The complete documentation for this method can be found in the PHPCap API documentation:
26-
https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html
26+
https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html
2727

2828
Since this method corresponds very closely to the REDCap API Export Records method, the
2929
REDCap API documentation can also be checked for more information. And the REDCap

‎docs-md/UserGuide4.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ importRecords
1515
---------------------------
1616
Detailed documentation for the importRecords method can be found in
1717
the PHPCap API documentation:
18-
https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html
18+
https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html
1919

2020
Since this method corresponds very closely to the REDCap API Import Records method, the
2121
REDCap API documentation can also be checked for more information. And the REDCap
@@ -63,7 +63,7 @@ into an existing REDCap record.
6363

6464
Detailed documentation for the importRecords method can be found in
6565
the PHPCap API documentation:
66-
https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html
66+
https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html
6767

6868
Below is example code for importing a consent form file for a patient into the patient's record:
6969
```php

‎docs/CACertificateFile.html

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@
3232
<div id="right">
3333
<div id="rightInner">
3434
<div id="content">
35+
<!-- =================================================
36+
Copyright (C) 2019 The Trustees of Indiana University
37+
SPDX-License-Identifier: BSD-3-Clause
38+
================================================== -->
3539
<h1>CA Certificate File Info</h1>
3640
<p>The CA (Certificate Authority) certificate file is needed so that PHPCap can verify that
3741
the REDCap instance it is connecting to is actually the instance that

‎docs/DeveloperGuide.html

+12-7
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@
4343
<div id="right">
4444
<div id="rightInner">
4545
<div id="content">
46+
<!-- =================================================
47+
Copyright (C) 2019 The Trustees of Indiana University
48+
SPDX-License-Identifier: BSD-3-Clause
49+
================================================== -->
4650
<h1>Developer Guide</h1>
4751
<p>This guide is for people interested in developing PHPCap (i.e., actually making changes to the PHPCap code). If you just want to use PHPCap to access REDCap from PHP, please see the
4852
user guides.</p>
@@ -60,7 +64,7 @@ <h2 id="Setup">Setup</h2>
6064
See: <a href="https://git-scm.com/downloads">https://git-scm.com/downloads</a></li>
6165
<li>
6266
<p>Get PHPCap:</p>
63-
<div class="description"><pre><code class="language-shell">git clone https://github.com/aarenson/PHPCap</code></pre></div>
67+
<div class="description"><pre><code class="language-shell">git clone https://github.com/iuredcap/phpcap</code></pre></div>
6468
</li>
6569
<li>Get Composer. Composer is needed to download the development depedencies for PHPCap.
6670
See: <a href="https://getcomposer.org/download/">https://getcomposer.org/download/</a>.
@@ -83,7 +87,7 @@ <h3 id="Example Setup on Ubuntu 16">Example Setup on Ubuntu 16</h3>
8387
<div class="description"><pre><code class="language-shell">sudo apt-get install php php-curl php-xml php-mbstring
8488
sudo apt-get install php-xdebug
8589
sudo apt-get install git
86-
git clone https://github.com/aarenson/PHPCap
90+
git clone https://github.com/iuredcap/phpcap
8791
sudo apt-get install composer
8892
cd PHPCap
8993
composer install</code></pre></div>
@@ -238,13 +242,14 @@ <h3 id="Coding Standard Compliance">Coding Standard Compliance</h3>
238242
<li><a href="http://www.php-fig.org/psr/psr-2/">http://www.php-fig.org/psr/psr-2/</a></li>
239243
</ul>
240244
<p>To check for compliance for the PHPCap source code, execute the following command in the root directory of PHPCap:</p>
241-
<div class="description"><pre><code>./vendor/bin/phpcs --standard=PSR1,PSR2 src</code></pre></div>
245+
<div class="description"><pre><code>./vendor/bin/phpcs src</code></pre></div>
242246
<p>To check compliance for the automated tests, use:</p>
243-
<div class="description"><pre><code>./vendor/bin/phpcs --standard=PSR1,PSR2 tests/unit tests/integration</code></pre></div>
244-
<p>To check for compliance for the PHPCap source code and the tests, use:</p>
245-
<div class="description"><pre><code>./vendor/bin/phpcs --standard=PSR1,PSR2 src tests/unit tests/integration</code></pre></div>
247+
<div class="description"><pre><code>./vendor/bin/phpcs tests/unit tests/integration</code></pre></div>
248+
<p>To check for compliance for the PHPCap source code and the tests, use the default settings
249+
(defined in the top-level phpcs.xml file):</p>
250+
<div class="description"><pre><code>./vendor/bin/phpcs</code></pre></div>
246251
<p>You can check specific files for compliance by specifying the path to the file, for example:</p>
247-
<div class="description"><pre><code>./vendor/bin/phpcs --standard=PSR1,PSR2 src/RedCapProject.php </code></pre></div>
252+
<div class="description"><pre><code>./vendor/bin/phpcs src/RedCapProject.php </code></pre></div>
248253
<p>Note that if you are working on Windows and have the git property <strong>core.autocrlf</strong> set to true, you may see errors similar to the following:</p>
249254
<div class="description"><pre><code>----------------------------------------------------------------------
250255
FOUND 1 ERROR AFFECTING 1 LINE

‎docs/UserGuide1.html

+7-3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@
4040
<div id="right">
4141
<div id="rightInner">
4242
<div id="content">
43+
<!-- =================================================
44+
Copyright (C) 2019 The Trustees of Indiana University
45+
SPDX-License-Identifier: BSD-3-Clause
46+
================================================== -->
4347
<h1>User Guide 1 - Getting Started</h1>
4448
<h2 id="Prerequisites">Prerequisites</h2>
4549
<ul>
@@ -89,11 +93,11 @@ <h3 id="Get PHPCap">Get PHPCap</h3>
8993
<p>If you have <a href="https://getcomposer.org/">Composer</a> installed, you can get PHPCap using:</p>
9094
<div class="description"><pre><code>composer require phpcap/phpcap</code></pre></div>
9195
<p>If you have <a href="https://git-scm.com/">Git</a> installed, you can use the following:</p>
92-
<div class="description"><pre><code>git clone https://github.com/aarenson/PHPCap </code></pre></div>
96+
<div class="description"><pre><code>git clone https://github.com/iuredcap/phpcap </code></pre></div>
9397
<p>If you don't have Composer or Git installed, you can get a Zip file of PHPCap from GitHub by clicking on this link:</p>
94-
<p><a href="https://github.com/aarenson/PHPCap/archive/master.zip">https://github.com/aarenson/PHPCap/archive/master.zip</a></p>
98+
<p><a href="https://github.com/iuredcap/phpcap/archive/master.zip">https://github.com/iuredcap/phpcap/archive/master.zip</a></p>
9599
<p>Or go to this page and click on the &quot;Clone or download&quot; button, and then click on &quot;Download ZIP&quot;:</p>
96-
<p><a href="https://github.com/aarenson/PHPCap/">https://github.com/aarenson/PHPCap/</a></p>
100+
<p><a href="https://github.com/iuredcap/phpcap/">https://github.com/iuredcap/phpcap/</a></p>
97101
<p>Then unzip the file to your project directory.</p>
98102
<p>You should now have the following directory structure:</p>
99103
<table>

‎docs/UserGuide2.html

+8-4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@
2929
<div id="right">
3030
<div id="rightInner">
3131
<div id="content">
32+
<!-- =================================================
33+
Copyright (C) 2019 The Trustees of Indiana University
34+
SPDX-License-Identifier: BSD-3-Clause
35+
================================================== -->
3236
<h1>User Guide 2 - API Overview</h1>
3337
<p>The four main classes provided by PHPCap for users are:</p>
3438
<table>
@@ -40,15 +44,15 @@ <h1>User Guide 2 - API Overview</h1>
4044
<tbody>
4145
<tr>
4246
<td>
43-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html">RedCapProject</a>
47+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html">RedCapProject</a>
4448
</td>
4549
<td>
4650
Used to retrieve data from, and modify, a project in REDCap.
4751
</td>
4852
</tr>
4953
<tr>
5054
<td>
51-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCap.html">RedCap</a>
55+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCap.html">RedCap</a>
5256
</td>
5357
<td>
5458
Represents a REDCap instance/site. This class is only required for creating new REDCap
@@ -59,7 +63,7 @@ <h1>User Guide 2 - API Overview</h1>
5963
</tr>
6064
<tr>
6165
<td>
62-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.FileUtil.html">FileUtil</a>
66+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.FileUtil.html">FileUtil</a>
6367
</td>
6468
<td>
6569
Used to read from, and write to, files. FileUtil is
@@ -69,7 +73,7 @@ <h1>User Guide 2 - API Overview</h1>
6973
</tr>
7074
<tr>
7175
<td>
72-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.PhpCapException.html">PhpCapException</a>
76+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.PhpCapException.html">PhpCapException</a>
7377
</td>
7478
<td>
7579
Exception class used by PHPCap when an error occurs.

‎docs/UserGuide3.html

+5-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@
3535
<div id="right">
3636
<div id="rightInner">
3737
<div id="content">
38+
<!-- =================================================
39+
Copyright (C) 2019 The Trustees of Indiana University
40+
SPDX-License-Identifier: BSD-3-Clause
41+
================================================== -->
3842
<h1>User Guide 3 - Exporting Records</h1>
3943
<p>PHPCap's <strong>RedCapProject</strong> class provides the following 3 methods for exporting records:</p>
4044
<ol>
@@ -51,7 +55,7 @@ <h2 id="exportRecords">exportRecords</h2>
5155
<p>The exportRecords method is a standard PHP method that has 12 parameters that can
5256
be set to modify the records that are exported and their format.</p>
5357
<p>The complete documentation for this method can be found in the PHPCap API documentation:
54-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html">https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html</a></p>
58+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html">https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html</a></p>
5559
<p>Since this method corresponds very closely to the REDCap API Export Records method, the
5660
REDCap API documentation can also be checked for more information. And the REDCap
5761
API Playground can be used to get a sense of the functionality provided by this method.</p>

‎docs/UserGuide4.html

+6-2
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@
3636
<div id="right">
3737
<div id="rightInner">
3838
<div id="content">
39+
<!-- =================================================
40+
Copyright (C) 2019 The Trustees of Indiana University
41+
SPDX-License-Identifier: BSD-3-Clause
42+
================================================== -->
3943
<h1>User Guide 4 - Importing Data</h1>
4044
<p>PHPCap's <strong>RedCapProject</strong> class provides the following methods for importing data:</p>
4145
<ol>
@@ -45,7 +49,7 @@ <h1>User Guide 4 - Importing Data</h1>
4549
<h2 id="importRecords">importRecords</h2>
4650
<p>Detailed documentation for the importRecords method can be found in
4751
the PHPCap API documentation:
48-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html">https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html</a></p>
52+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html">https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html</a></p>
4953
<p>Since this method corresponds very closely to the REDCap API Import Records method, the
5054
REDCap API documentation can also be checked for more information. And the REDCap
5155
API Playground can be used to get a sense of the functionality provided by this method.</p>
@@ -82,7 +86,7 @@ <h2 id="importFile">importFile</h2>
8286
into an existing REDCap record.</p>
8387
<p>Detailed documentation for the importRecords method can be found in
8488
the PHPCap API documentation:
85-
<a href="https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html">https://aarenson.github.io/PHPCap/api/class-IU.PHPCap.RedCapProject.html</a> </p>
89+
<a href="https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html">https://iuredcap.github.io/phpcap/api/class-IU.PHPCap.RedCapProject.html</a> </p>
8690
<p>Below is example code for importing a consent form file for a patient into the patient's record:</p>
8791
<div class="description"><pre><code class="language-php">project-&gt;importFile(<span class="php-quote">'consent1001.pdf'</span>,<span class="php-quote">'1001'</span>,<span class="php-quote">'patient_consent'</span>);</code></pre></div>
8892
<p>Or, using variables to indicate what the arguments represent:</p>

‎docs/UserGuide5.html

+4
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@
3434
<div id="right">
3535
<div id="rightInner">
3636
<div id="content">
37+
<!-- =================================================
38+
Copyright (C) 2019 The Trustees of Indiana University
39+
SPDX-License-Identifier: BSD-3-Clause
40+
================================================== -->
3741
<h1>User Guide 5 - Extending PHPCap</h1>
3842
<p>If you need additional functionality to what is provided by PHPCap, you
3943
can extend it.</p>

‎docs/api/404.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<title>Page not found | PHPCap</title>
88

9-
<link rel="stylesheet" href="resources/style.css?1a4a4336f8848356a7323a0293eae21783eb38ce">
9+
<link rel="stylesheet" href="resources/style.css?dedb718465ca351b467f65eed9af344225370157">
1010

1111
</head>
1212

@@ -55,12 +55,14 @@ <h3>Classes</h3>
5555
<li><a href="class-IU.PHPCap.RedCap.html">IU\PHPCap\RedCap</a></li>
5656
<li><a href="class-IU.PHPCap.RedCapApiConnection.html">IU\PHPCap\RedCapApiConnection</a></li>
5757
<li><a href="class-IU.PHPCap.RedCapProject.html">IU\PHPCap\RedCapProject</a></li>
58+
<li><a href="class-IU.PHPCap.Version.html">IU\PHPCap\Version</a></li>
5859
</ul>
5960

6061
<h3>Interfaces</h3>
6162
<ul>
6263
<li><a href="class-IU.PHPCap.ErrorHandlerInterface.html">IU\PHPCap\ErrorHandlerInterface</a></li>
6364
<li><a href="class-IU.PHPCap.RedCapApiConnectionInterface.html">IU\PHPCap\RedCapApiConnectionInterface</a></li>
65+
<li><a href="class-Throwable.html">Throwable</a></li>
6466
</ul>
6567

6668

@@ -113,7 +115,7 @@ <h1>Page not found</h1>
113115
</div>
114116
</div>
115117
</div>
116-
<script src="resources/combined.js?b6dc7f939a525ca18da557fc40c9f018e8eeeed0"></script>
118+
<script src="resources/combined.js?59502ae7364075a9225b536644cad63e5b9d9cc8"></script>
117119
<script src="elementlist.js"></script>
118120
</body>
119121
</html>

0 commit comments

Comments
 (0)