Download the PHP package wikisource/api without Composer
On this page you can find all versions of the php package wikisource/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wikisource/api
More information about wikisource/api
Files in wikisource/api
Package api
Short Description A PHP API to Wikisources (all languages).
License GPL-2.0-or-later
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 api
Wikisource API
This is an client API library for retrieving data from Wikisources. It uses data from Wikidata where it can, or MediaWiki API data from specific Wikisources, or resorts to scraping HTML where that's the only option.
Features (some are in development and are not yet functional):
- List all Wikisources.
- Get metadata about a single Wikisource: language code, language name (in that language), and information about namespaces (their names and IDs).
- List all Works in a Wikisource.
- Get metadata about a single Work on a Wikisource: URL, page name, work title, author, year of publication, proofreading quality, and a list of Index Pages used by the Work.
- Get metadata about a single Index Page on a Wikisource: URL, page name, list of Pages, and proofreading quality.
- Get metadata about a single proofreading Page on a Wikisource (i.e. a wiki-page in the Page namespace): URL, wiki-page name, page number (in Djvu/PDF), page label (in the Index's page-list), and proofreading quality.
Installation
Install with Composer:
You might also want something that implements psr/log
and something that implements psr/cache, if you want to
use the logging and caching features of this library.
Usage
Find all Wikisources:
Get a single work:
Let it cache results, such as the seldom-changing list of available Wikisources as derived from Wikidata (any implementation of PSR-6 works here):
``
See the examples/ directory for fully-functioning examples
that you can run straight away from the command line.
Caching
Every external request that this library performs will be cached
if you provide a cache pool via WikisourceApi::setCache().
The default cache times are as follows:
| Data | Default lifetime | Override |
|---|---|---|
| List of Wikisources | 30 days | Parameter to WikisourceApi::getWikisources() |
| Index Page metadata | 1 hour | Parameter to IndexPage::__construct() |
| A Work's Wikidata Item number | 1 day | Not possible |
Logging
You can enable logging by passing WikisourceApi::setLogger() any object
that implements PSR-3's LoggerInterface.
Issues
Please report all issues via Phabricator (tag them with the 'wikisource-api' project).
Licence
Copyright © 2016 Sam Wilson and other contributors.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
All versions of api with dependencies
ext-simplexml Version *
psr/cache Version ^1|^2|^3
psr/log Version ^1|^2|^3
dflydev/dot-access-data Version ^3.0
addwiki/mediawiki-api Version ^3
symfony/dom-crawler Version ^4.2|^5.0|^6|^7