Download the PHP package monkdev/monk-id without Composer
On this page you can find all versions of the php package monkdev/monk-id. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package monk-id
Monk ID PHP
Integrate Monk ID authentication and single sign-on for apps and websites on the server-side.
Overview
Install
Using Composer, add monkdev/monk-id to your
composer.json:
Or:
Configure
Configuration is done in an external INI file. There's a sample file in this
repository: config/monkId.sample.yml. Copy this file to your codebase, then
load the config in your code during initialization:
Remember, replace the sample values with your own, and keep the file safe as it contains your app secret.
Access
If you have Monk ID JS configured to store the payload automatically in a cookie (the default), you can skip the next part as the cookie is also loaded automatically.
If not, the encoded payload can be passed directly, which is useful if you're sending it in a GET/POST request instead:
Loading the payload must be done before trying to access any values stored in
the payload. In an MVC framework, this usually means placing it in a method in
your ApplicationController that's executed before the specific action is
processed.
Once the payload is loaded, you can ask whether the user is logged in:
Or for their ID and email:
null is returned if the user isn't logged in or the payload can't be decoded
and verified.
Development
Composer is used for dependency management and task running. Start by installing the dependencies:
Tests
Testing is done with PHPUnit. To run the tests:
Continuous integration is setup through Travis CI to run the tests against PHP v5.6, v7.0, and v7.1. (Circle CI is also setup to run the tests against PHP v5.6, but is backup for now until multiple versions can easily be specified.) The code coverage results are sent to Codecov during CI for tracking over time. Badges for both are dispayed at the top of this README.
While the test suite is complete, it's not a bad idea to also test changes manually in real-world integrations.
Documentation
phpDocumentor is used for code documentation. To build:
This creates a doc directory (that is ignored by git).
Quality
A number of code quality tools are configured to aid in development. To run them all at once:
Each tool can also be run individually:
- php -l:
$ composer phplint - PHP_CodeSniffer:
$ composer phpcs - PHP Copy/Paste Detector:
$ composer phpcpd - PHPLOC:
$ composer phploc - PHP Mess Detector:
$ composer phpmd - SensioLabs Security Checker:
$ composer security-checker
Deployment
Publishing a release to Packagist simply requires creating a git tag:
Be sure to choose the correct version by following Semantic Versioning.
Publish Documentation
After releasing a new version, the documentation must be manually built and
published to the gh-pages branch.
