Download the PHP package wikibase/data-model-serialization without Composer

On this page you can find all versions of the php package wikibase/data-model-serialization. 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?

Informations about the package data-model-serialization

Wikibase DataModel Serialization

Build Status Scrutinizer Quality Score Code Coverage Download count License

Latest Stable Version

Library containing serializers and deserializers for the basic Wikibase DataModel entity types and components they are made of. The supported formats are limited to public ones, ie those used by a web API. Serialization code for private formats, such as the format used by the Wikibase Repo data access layer, belongs in other components.

Recent changes can be found in the release notes.

Installation

The recommended way to use this library is via Composer.

Composer

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

Manual

Get the code of this package, 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. Then take care of autoloading the classes defined in the src directory.

Library usage

Construct an instance of the specific deserializer or serializer you need via the appropriate factory.

Then use the deserialize or serialize method.

In case of deserialization, guarding against failures is good practice. So it is typically better to use the slightly more verbose try-catch approach.

All access to services provided by this library should happen through the SerializerFactory and DeserializerFactory. The rest of the code is an implementation detail which users should not know about.

Library structure

The Wikibase DataModel objects can all be serialized to a generic format from which the objects can later be reconstructed. This is done via a set of Serializers\Serializer implementing objects. These objects turn for instance a Statement object into a data structure containing only primitive types and arrays. This data structure can thus be readily fed to json_encode, serialize, or the like. The process of reconstructing the objects from such a serialization is provided by objects implementing the Deserializers\Deserializer interface.

Serializers can be obtained via an instance of SerializerFactory and deserializers can be obtained via an instance of DeserializerFactory. You are not allowed to construct these serializers and deserializers directly yourself or to have any kind of knowledge of them (ie type hinting). These objects are internal to this component and might change name or structure at any time. All you are allowed to know when calling $serializerFactory->newItemDeserializer() is that you get back an instance of Serializers\Serializer.

Running the tests

For tests only

composer test

For style checks only

composer cs

For a full CI run

composer ci

Authors

Wikibase DataModel Serialization has been written by Thomas PT as volunteer and by Jeroen De Dauw as Wikimedia Germany employee for the Wikidata project.

Links

See also

Bugs on Phabricator

https://phabricator.wikimedia.org/project/view/922/


All versions of data-model-serialization with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
wikibase/data-model Version ~9.0|~8.0|~7.0|~6.0|~5.0|~4.2
serialization/serialization Version ~4.0|~3.1
data-values/serialization Version ~1.0
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 wikibase/data-model-serialization contains the following files

Loading the files please wait ....