Download the PHP package uwdoem/person without Composer

On this page you can find all versions of the php package uwdoem/person. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of uwdoem/person

Informations about the package person

Build Status Code Climate Test Coverage Latest Stable Version

UWDOEM/Person

Smoothly poll the University of Washington's Person Web Service (PWS) and Student Web Service (SWS) to aggregate data on a given affiliate, using X.509 certificate authentication.

For example:

Notice

This is not an official library, endorsed or supported by any party who manages or owns information accessed via PWS or SWS. This library is not endorsed or supported by the University of Washington Department of Enrollment Management.

Installation

This library is published on packagist. To install using Composer, add the "uwdoem/person": "1.*" line to your "require" dependencies:

Of course it is possible to use Person without Composer by downloading it directly, but use of Composer to manage packages is highly recommended. See Composer for more information.

Use

This client library provides four data-container classes: Person, Student, Employee, and Alumni.

If you have not already done so, follow PWS's instructions on getting access to PWS. A similar set of steps will allow you to gain access to SWS. You'll need to place both the private private key you created and also the university-signed certificate on your web server, with read-accessibility for your web-server process.

Before querying the web services, you must first initialize the connection by calling ::createInstance:

The terms UW_WS_SSL_KEY_PATH and UW_WS_SSL_CERT_PATH correspond to the absolute locations of your private key and university-signed certificate. The UW_WS_SSL_KEY_PASSWD corresponds to the string which unlocks your private key; if your key does not have a password then use a blank string, eg: ''.

The term UW_WS_BASE_PATH corresponds to the base URL shared by UW web services. Currently this is either "https://ws.admin.washington.edu/" for the production-access web services, or "https://wseval.s.uw.edu/" for the testing/development-access web services.

You may now issue queries against the web service:

In the case above, there does exist a student with StudentNumber "1033334": one of the university's notional test students. So this script will output "JAMES AVERAGE".

The following methods may be used to query the database:

You can cast between classes each of the container classes' ::fromPerson method:

The ::hasAffiliation method can tell you whether a given person is a student, employee, and/or alumni:

Use ::getAttr to retrieve an attribute from a person:

The Student::registrationSearch method returns an array of Registration Resources, in associative array format:

You can include optional parameters in your registration search, per the Registration Search Resource spec:

Exposed Attributes

The container classes expose the following attributes, corresponding to those described in this PWS glossary:

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

Requirements

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:

  1. Open an issue in the issue tracker.
  2. In any order:
    • Submit a pull request with a failing test that demonstrates the issue/feature.
    • Get acknowledgement/concurrence.
  3. Revise your pull request to pass the test in (2). Include documentation, if appropriate.

PSR-2 compliance is enforced by CodeSniffer in Travis.

All versions of person with dependencies

PHP Build Version
Package Version
Requires uwdoem/connection Version 3.*
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package uwdoem/person contains the following files

Loading the files please wait ....