openeuropa / oe_corporate_site_info
OpenEuropa Corporate Site Information.
Installs: 96 958
Dependents: 4
Suggesters: 0
Security: 0
Stars: 0
Watchers: 14
Forks: 1
Open Issues: 0
Type:drupal-module
Requires
- php: >=8.1
- drupal/core: ^10
- drupal/multivalue_form_element: ^1.0@beta
- openeuropa/rdf_skos: ^1.0.0-alpha9
Requires (Dev)
- composer/installers: ^1.5
- drupal/core-composer-scaffold: ^10
- drupal/drupal-extension: ^5.0
- drush/drush: ^12.4
- openeuropa/code-review: ^2.0.0-alpha6
- openeuropa/task-runner-drupal-project-symlink: ^1.0-beta6
- phpspec/prophecy-phpunit: ^2
- symfony/phpunit-bridge: ^6.2
This package is auto-updated.
Last update: 2024-10-31 00:17:37 UTC
README
The OpenEuropa Corporate Site Information module provides corporate information about the site, such as site owner, content owners, etc.
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.
Requirements
This depends on the following software:
- PHP >=8.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:
composer require openeuropa/oe_corporate_site_info
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:
sparql:
image: openeuropa/triple-store-dev
environment:
- SPARQL_UPDATE=true
- DBA_PASSWORD=dba
ports:
- "8890:8890"
Otherwise, make sure you have the triple store instance running and have imported the "Corporate body" vocabulary.
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:
sparql:
host: "sparql"
port: "8890"
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:
sparql_default:
default:
prefix: ""
host: ${drupal.sparql.host}
port: ${drupal.sparql.port}
namespace: 'Drupal\Driver\Database\sparql'
driver: 'sparql'
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:
$databases["sparql_default"] = array(
'default' => array(
'prefix' => '',
'host' => 'your-triple-store-host',
'port' => '8890',
'namespace' => 'Drupal\\Driver\\Database\\sparql',
'driver' => 'sparql'
)
);
Development setup
You can build the development site by running the following steps:
- Install the Composer dependencies:
composer install
A post command hook (drupal:site-setup
) is triggered automatically after composer install
.
It will make sure that the necessary symlinks are properly setup in the development site.
It will also perform token substitution in development configuration files such as behat.yml.dist
.
Please note: project files and directories are symlinked within the test site by using the OpenEuropa Task Runner's Drupal project symlink command.
If you add a new file or directory in the root of the project, you need to re-run drupal:site-setup
in order to make
sure they are be correctly symlinked.
If you don't want to re-run a full site setup for that, you can simply run:
$ ./vendor/bin/run drupal:symlink-project
- Install test site by running:
./vendor/bin/run drupal:site-install
The development site web root should be available in the build
directory.
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:
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:
docker-compose up
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
:
docker-compose up -d
Then:
docker-compose exec web composer install docker-compose exec web ./vendor/bin/run drupal:site-install
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:
docker-compose exec web ./vendor/bin/grumphp run
To run the phpunit tests:
docker-compose exec web ./vendor/bin/phpunit
To run the behat tests:
docker-compose exec web ./vendor/bin/behat
Step debugging
To enable step debugging from the command line, pass the XDEBUG_SESSION
environment variable with any value to
the container:
docker-compose exec -e XDEBUG_SESSION=1 web <your command>
Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests.
To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at https://www.jetbrains.com/phpstorm/marklets/.
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.