README

Wikibase DataModel is the canonical PHP implementation of the Data Model at the heart of the Wikibase software.

It is primarily used by the Wikibase MediaWiki extensions, though has no dependencies whatsoever on these or on MediaWiki itself.

Recent changes can be found in the release notes.

Note that this repository is a mirror of part of the upstream Wikibase project on Gerrit. Contributions should be made to the directories there using MediaWiki's Gerrit process.

Installation

You can use Composer to download and install this package as well as its dependencies. Alternatively you can simply clone the git repository and take care of loading yourself.

Composer

To add this package as a local, per-project dependency to your project, simply add a dependency on wikibase/data-model to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a dependency on Wikibase DataModel 9.x:

{
    "require": {
        "wikibase/data-model": "~9.0"
    }
}

Manual

Get the Wikibase DataModel code, either via git, or some other means. Also get all dependencies. You can find a list of the dependencies in the "require" section of the composer.json file. The "autoload" section of this file specifies how to load the resources provide by this library.

Library contents

This library contains domain objects that implement the concepts part of the Wikibase DataModel. This mainly includes simple value objects, though also contains core domain logic either bound to such objects or encapsulated as service objects.

Tests

This library comes with a set up PHPUnit tests that cover all non-trivial code. Additionally, code style checks by PHPCS and PHPMD are supported. The configuration for all 3 these tools can be found in the root directory. You can use the tools in their standard manner, though can run all checks required by our CI by executing composer ci. To just run tests use composer test, and to just run style checks use composer cs.

Contributing

This repository is a mirror of part of the upstream Wikibase project on Gerrit. Contributions should be made to the directories there using MediaWiki's Gerrit process.

Credits

Development

Wikibase DataModel has been written by Jeroen De Dauw and Thiemo Kreuz as Wikimedia Germany employees for the Wikidata project.

Contributions were also made by several other people.

Concept

The initial conceptual specification for the DataModel was created by Markus Krötzsch and Denny Vrandečić, with minor contributions by Daniel Kinzler and Jeroen De Dauw.

Links

• Wikibase DataModel on Packagist
• Wikibase DataModel on Ohloh
• Wikibase DataModel on TravisCI
• Wikibase DataModel on Wikimedia's Phabricator

See also

• Blog posts on Wikibase DataModel
• Wikibase DataModel Services
• Wikibase DataModel Serialization
• Wikibase Internal Serialization