uwdoem / r25
Client library for the University of Washington R25 Web Service
Requires
- uwdoem/connection: 2.*
Requires (Dev)
- codeclimate/php-test-reporter: dev-master
- phpdocumentor/phpdocumentor: 2.7.*
- phpunit/phpunit: 4.5.*
- squizlabs/php_codesniffer: 2.*
- uwdoem/standard: *
This package is not auto-updated.
Last update: 2024-10-26 19:10:49 UTC
README
UWDOEM/R25
Smoothly poll the University of Washington's R25 Classroom Scheduling Service.
For example:
// Intialize the required settings
define('R25_BASE_PATH', 'https://r25web.admin.washington.edu/r25ws/servlet/wrd/run/');
define('UW_WS_SSL_KEY_PATH', '/path/to/my/private.key');
define('UW_WS_SSL_CERT_PATH', '/path/to/my/public_cert.pem');
define('UW_WS_SSL_KEY_PASSWD', 'myprivatekeypassword'); // Can be blank for no password: ''
$spaces = Space::getSpaces();
echo $spaces[5]->getAttr('space_name');
// KIN 114
Installation
This library is published on packagist. To install using Composer, add the "uwdoem/r25": "1.*"
line to your "require" dependencies:
{
"require": {
"uwdoem/r25": "0.*"
}
}
Of course it is possible to use R25 without Composer by downloading it directly, but use of Composer to manage packages is highly recommended. See Composer for more information.
Troubleshooting
This library will throw warnings and exceptions when it recognizes an error. Turn on error reporting to see these. For errors involving cURL, SSL, and or script execution halts/no output, see UWEnrollmentManagement/Connection troubleshooting.
Compatibility
- R25 Classroom Scheduling Web Service v2
Requirements
- PHP 5.5, 5.6, 7.0
- uwdoem/connection 2.*
Todo
See GitHub issue tracker.
Getting Involved
Feel free to open pull requests or issues. GitHub is the canonical location of this project.
Here's the general sequence of events for code contribution:
- Open an issue in the issue tracker.
- In any order:
- Submit a pull request with a failing test that demonstrates the issue/feature.
- Get acknowledgement/concurrence.
- Revise your pull request to pass the test in (2). Include documentation, if appropriate.
PSR-2 compliance is enforced by CodeSniffer in Travis.