Download the PHP package davidjguru/oe_content without Composer

OpenEuropa Content

BEWARE: ONLY TEST FOR LOCAL ENVIRONMENTS

This component is in active development. It is not ready to be used.

This is a Drupal module that contains the European Commission corporate entity types.

The module uses the RDF SKOS module to provide SKOS modelling for the Publications Office taxonomy vocabularies. These are directly made available in the dependent RDF triple store.

Table of contents:

• Requirements
• Installation
• Usage
• Development setup
• Contributing
• Versioning

Requirements

This depends on the following software:

• PHP 7.1
• Virtuoso (or equivalent) triple store which contains the RDF representations of the following Publications Office (OP) vocabularies: Corporate Bodies, Target Audiences, Organisation Types, Resource Types, Eurovoc

Installation

Install the package and its dependencies:

It is strongly recommended to use the provisioned Docker image for Virtuoso that contains already the OP vocabularies. To do this, add the image to your docker.compose.yml file:

Otherwise, make sure you have the triple store instance running and have imported those vocabularies.

Next, if you are using the Task Runner to set up your site, add the runner.yml configuration for connecting to the triple store. Under the drupal key:

Still in the runner.yml, add the instruction to create the Drupal settings for connecting to the triple store. Under the drupal.settings.databases key:

Then you can proceed with the regular Task Runner commands for setting up the site.

Otherwise, ensure that in your site's setting.php file you have the connection information to your own triple store instance:

Usage

OpenEuropa Content

If you want to use OpenEuropa Content, enable the module:

Development setup

Requirements

• Virtuoso 7 (Triplestore database)

Initial setup

You can build the test site by running the following steps.

• Install Virtuoso. The easiest way to do this is by using the OpenEuropa Triple store development Docker container which also pre-imports the main Europa vocabularies.

• Install all the composer dependencies:

• Customize build settings by copying runner.yml.dist to runner.yml and changing relevant values, like your database credentials.

This will also symlink the theme in the proper directory within the test site and perform token substitution in test configuration files such as behat.yml.dist.

• Install test site by running:

Your test site will be available at ./build.

Using Docker Compose

Alternatively, you can build a development site using Docker and Docker Compose with the provided configuration.

Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration.

Requirements:

• Docker
• Docker Compose

Configuration

By default, Docker Compose reads two files, a docker-compose.yml and an optional docker-compose.override.yml file. By convention, the docker-compose.yml contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations.

Find more information on Docker Compose extension mechanism on the official Docker Compose documentation.

Usage

To start, run:

It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:

Then:

Using default configuration, the development site files should be available in the build directory and the development site should be available at: http://127.0.0.1:8080/build.

Running the tests

To run the grumphp checks:

To run the phpunit tests:

To run the behat tests:

Working with content

The project ships with the following Task Runner commands to work with content in the RDF store, they require Docker Compose services to be up and running.

Purge all data:

Or, if you can run commands on your host machine:

Import default data:

Or, if you can run commands on your host machine:

Reset all data, i.e. run purge and import:

Or, if you can run commands on your host machine:

Contributing

Please read the full documentation for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the available versions, see the tags on this repository.