Download the PHP package indiana-university/iukb-api-php without Composer
On this page you can find all versions of the php package indiana-university/iukb-api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download indiana-university/iukb-api-php
More information about indiana-university/iukb-api-php
Files in indiana-university/iukb-api-php
Package iukb-api-php
Short Description A set of classes to pull documents from the IU knowledge base into your application
License BSD-3-Clause
Homepage https://github.com/indiana-university/iukb-api-php
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 iukb-api-php
IUKB API - PHP
A set of classes to pull documents from the IU knowledge base into your PHP application
Requirements
- PHP 7 or 8
- Composer
- A knowledge base REST account
- See the knowledge base REST api documentation for more information
Usage
To instantiate the KB class, you must simply give it a provider. This is an
instance of a class which will pull KB data from somewhere and feed it into the
main KB class. There are currently three different providers, however, one of
them is simply an intermediary class to provide caching. The two actual data
providers are Filesystem and Web.
Filesystem
The Filesystem class is used for testing purposes, but could be used to provide
caching in a different way from the way it is implemented in the caching class.
For example, if you need to alter the content of the KB docs before displaying
them. You could save the result some where on disk and load it through the
Filesystem provider.
Web
The Web class is used to load data from the Knowledge Base REST API. It
requires credentials to authenticate to the REST API.
Instantiating the KB class
Caching
In previous versions caching was built into the main class, but the resulting implementation was quite messy. It also forced users to use a cache even if they did not want to. Caching is now provided by a separate intermediate provider.
The cache class requires a provider, a cache object, and a TTL. The default time for the TTL is 3600 seconds.
Also note that the Caching provider will also cache search results. It will always refresh the search result cache after the TTL though as there is no way to check if the search results have changed.
Fetching a document
Searching the KB
Contributing
Contributions are welcome in the form of a github pull request. Note, for
consistency sake, please run composer check and composer run-tests on any code
you wish to contribute to this project and fix and resolve any issues found.
