1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502:
<?php
namespace IU\PHPCap;
class RedCap
{
protected $superToken;
protected $errorHandler;
protected $connection;
protected $ProjectConstructorCallback;
public function __construct(
$apiUrl,
$superToken = null,
$sslVerify = false,
$caCertificateFile = null,
$errorHandler = null,
$connection = null
) {
$this->errorHandler = new ErrorHandler();
if (isset($errorHandler)) {
$this->errorHandler = $this->processErrorHandlerArgument($errorHandler);
}
if (isset($connection)) {
$this->connection = $this->processConnectionArgument($connection);
} else {
$apiUrl = $this->processApiUrlArgument($apiUrl);
$sslVerify = $this->processSslVerifyArgument($sslVerify);
$caCertificateFile = $this->processCaCertificateFileArgument($caCertificateFile);
$this->connection = new RedCapApiConnection($apiUrl, $sslVerify, $caCertificateFile);
}
$this->superToken = $this->processSuperTokenArgument($superToken);
$this->ProjectConstructorCallback = function (
$apiUrl,
$apiToken,
$sslVerify = false,
$caCertificateFile = null,
$errorHandler = null,
$connection = null
) {
return new RedCapProject(
$apiUrl,
$apiToken,
$sslVerify,
$caCertificateFile,
$errorHandler,
$connection
);
};
}
public function createProject(
$projectData,
$format = 'php',
$odm = null
) {
$data = array(
'token' => $this->superToken,
'content' => 'project',
'returnFormat' => 'json'
);
$legalFormats = array('csv', 'json', 'php', 'xml');
$data['format'] = $this->processFormatArgument($format, $legalFormats);
$data['data'] = $this->processImportDataArgument($projectData, 'projectData', $format);
if (isset($odm)) {
$data['odm'] = $this->processOdmArgument($odm);
}
$apiToken = $this->connection->callWithArray($data);
$this->processNonExportResult($apiToken);
$connection = clone $this->connection;
$errorHandler = clone $this->errorHandler;
$ProjectConstructorCallback = $this->ProjectConstructorCallback;
$project = call_user_func(
$ProjectConstructorCallback,
$apiUrl = null,
$apiToken,
$sslVerify = null,
$caCertificateFile = null,
$errorHandler,
$connection
);
return $project;
}
public function getProject($apiToken)
{
$apiToken = $this->processApiTokenArgument($apiToken);
$connection = clone $this->connection;
$errorHandler = clone $this->errorHandler;
$ProjectConstructorCallback = $this->ProjectConstructorCallback;
$project = call_user_func(
$ProjectConstructorCallback,
$apiUrl = null,
$apiToken,
$sslVerify = null,
$caCertificateFile = null,
$errorHandler,
$connection
);
return $project;
}
public function getProjectConstructorCallback()
{
return $this->ProjectConstructorCallback;
}
public function setProjectConstructorCallback($ProjectConstructorCallback)
{
$this->ProjectConstructorCallback
= $this->processProjectConstructorCallbackArgument($ProjectConstructorCallback);
}
public function getErrorHandler()
{
return $this->errorHandler;
}
public function setErrorHandler($errorHandler)
{
$this->errorHandler = $this->processErrorHandlerArgument($errorHandler);
}
public function getConnection()
{
return $this->connection;
}
public function setConnection($connection)
{
$this->connection = $this->processConnectionArgument($connection);
}
protected function processApiTokenArgument($apiToken)
{
if (!isset($apiToken)) {
$message = 'The REDCap API token specified for the project was null or blank.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
} elseif (gettype($apiToken) !== 'string') {
$message = 'The REDCap API token provided should be a string, but has type: '
.gettype($apiToken);
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
} elseif (!ctype_xdigit($apiToken)) {
$message = 'The REDCap API token has an invalid format.'
.' It should only contain numbers and the letters A, B, C, D, E and F.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
} elseif (strlen($apiToken) != 32) {
$message = 'The REDCap API token has an invalid format.'
.' It has a length of '.strlen($apiToken).' characters, but should have a length of'
.' 32.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $apiToken;
}
protected function processApiUrlArgument($apiUrl)
{
if (!isset($apiUrl)) {
$message = 'The REDCap API URL specified for the project was null or blank.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
} elseif (gettype($apiUrl) !== 'string') {
$message = 'The REDCap API URL provided ('.$apiUrl.') should be a string, but has type: '
. gettype($apiUrl);
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $apiUrl;
}
protected function processCaCertificateFileArgument($caCertificateFile)
{
if (isset($caCertificateFile) && gettype($caCertificateFile) !== 'string') {
$message = 'The value for $sslVerify must be a string, but has type: '
.gettype($caCertificateFile);
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $caCertificateFile;
}
protected function processConnectionArgument($connection)
{
if (!($connection instanceof RedCapApiConnectionInterface)) {
$message = 'The connection argument is not valid, because it doesn\'t implement '
.RedCapApiConnectionInterface::class.'.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $connection;
}
protected function processErrorHandlerArgument($errorHandler)
{
if (!($errorHandler instanceof ErrorHandlerInterface)) {
$message = 'The error handler argument is not valid, because it doesn\'t implement '
.ErrorHandlerInterface::class.'.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $errorHandler;
}
protected function processFormatArgument(& $format, $legalFormats)
{
if (gettype($format) !== 'string') {
$message = 'The format specified has type "'.gettype($format).'", but it should be a string.';
$this->errorHandler->throwException($message, ErrorHandlerInterface::INVALID_ARGUMENT);
}
$format = strtolower(trim($format));
if (!in_array($format, $legalFormats)) {
$message = 'Invalid format "'.$format.'" specified.'
.' The format should be one of the following: "'.
implode('", "', $legalFormats).'".';
$this->errorHandler->throwException($message, ErrorHandlerInterface::INVALID_ARGUMENT);
}
$dataFormat = '';
if (strcmp($format, 'php') === 0) {
$dataFormat = 'json';
} else {
$dataFormat = $format;
}
return $dataFormat;
}
protected function processImportDataArgument($data, $dataName, $format)
{
if (!isset($data)) {
$message = "No value specified for required argument '".$dataName."'.";
$this->errorHandler->throwException($message, ErrorHandlerInterface::INVALID_ARGUMENT);
} elseif ($format === 'php') {
if (!is_array($data)) {
$message = "Argument '".$dataName."' has type '".gettype($data)."'"
.", but should be an array.";
$this->errorHandler->throwException($message, ErrorHandlerInterface::INVALID_ARGUMENT);
}
$data = array($data);
$data = json_encode($data);
$jsonError = json_last_error();
switch ($jsonError) {
case JSON_ERROR_NONE:
break;
default:
$message = 'JSON error ('.$jsonError.') "'. json_last_error_msg().
'"'." while processing argument '".$dataName."'.";
$this->errorHandler->throwException($message, ErrorHandlerInterface::JSON_ERROR);
break;
}
} else {
if (gettype($data) !== 'string') {
$message = "Argument '".$dataName."' has type '".gettype($data)."'"
.", but should be a string.";
$this->errorHandler->throwException($message, ErrorHandlerInterface::INVALID_ARGUMENT);
}
}
return $data;
}
protected function processNonExportResult(& $result)
{
$matches = array();
$hasMatch = preg_match('/^[\s]*{"error":\s*"([^"]+)"}[\s]*$/', $result, $matches);
if ($hasMatch === 1) {
$message = $matches[1];
$this->errorHandler->throwException($message, ErrorHandlerInterface::REDCAP_API_ERROR);
}
}
protected function processOdmArgument($odm)
{
if (isset($odm) && !is_string($odm)) {
$message = 'The value for $odm must have type string, but has type: '
.gettype($odm);
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $odm;
}
protected function processProjectConstructorCallbackArgument($callback)
{
if (!is_callable($callback)) {
$message = 'The project constructor callback needs to be callable (i.e., be a function)'
.', but it isn\'t.';
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $callback;
}
protected function processSslVerifyArgument($sslVerify)
{
if (isset($sslVerify) && gettype($sslVerify) !== 'boolean') {
$message = 'The value for $sslVerify must be a boolean (true/false), but has type: '
.gettype($sslVerify);
$code = ErrorHandlerInterface::INVALID_ARGUMENT;
$this->errorHandler->throwException($message, $code);
}
return $sslVerify;
}
protected function processSuperTokenArgument($superToken)
{
if (!isset($superToken) || trim($superToken) === '') {
;
} elseif (gettype($superToken) !== 'string') {
$this->errorHandler->throwException("The REDCap super token provided should be a string, but has type: "
. gettype($superToken), ErrorHandlerInterface::INVALID_ARGUMENT);
} elseif (!ctype_xdigit($superToken)) {
$this->errorHandler->throwException(
"The REDCap super token has an invalid format."
." It should only contain numbers and the letters A, B, C, D, E and F.",
ErrorHandlerInterface::INVALID_ARGUMENT
);
} elseif (strlen($superToken) != 64) {
$this->errorHandler->throwException(
"The REDCap super token has an invalid format."
. " It has a length of ".strlen($superToken)." characters, but should have a length of"
. " 64 characters.",
ErrorHandlerInterface::INVALID_ARGUMENT
);
}
return $superToken;
}
}