https://github.com/stadgent/drupal_module_opening-hours
Drupal module that integrates the Opening Hours platform functionality.
https://github.com/stadgent/drupal_module_opening-hours
d09check22 web
Last synced: 4 months ago
JSON representation
Drupal module that integrates the Opening Hours platform functionality.
- Host: GitHub
- URL: https://github.com/stadgent/drupal_module_opening-hours
- Owner: StadGent
- License: gpl-2.0
- Created: 2017-12-08T10:26:47.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-09T13:30:46.000Z (about 1 year ago)
- Last Synced: 2025-05-09T14:46:14.721Z (about 1 year ago)
- Topics: d09check22, web
- Language: PHP
- Homepage:
- Size: 270 KB
- Stars: 2
- Watchers: 9
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Drupal Opening Hours module
Drupal 9.4+ module that integrates the Opening Hours platform functionality.
This module allows to consume the [Opening Hours Platform] API to lookup
services, their channels and their opening hours data.
[![Github][github-badge]][github-link]
[![License][license-badge]][license-link]
[![Build Status Master][travis-master-badge]][travis-master-link]
[![Build Status Develop][travis-develop-badge]][travis-develop-link]
[![Maintainability][codeclimate-maint-badge]][codeclimate-maint-link]
[![Test Coverage][codeclimate-cover-badge]][codeclimate-cover-link]
## Install
Install using composer:
Add the git source to the composer by editing the `composer.json` in the project
root and add following lines in the `repositories section:
```json
"repman-digipolis": {
"type": "composer",
"url": "https://digipolis.repo.repman.io"
},
"digipolis-gent/opening-hours-widget": {
"type": "package",
"package": {
"name": "drupal/opening-hours-widget",
"type": "drupal-library",
"version": "0.1.1",
"dist": {
"type": "zip",
"url": "https://github.com/StadGent/npm_package_opening-hours-widget/releases/download/0.1.1/opening-hours-widget.zip"
}
}
}
```
Install the module using composer:
```bash
composer require drupal/opening_hours
```
Enable the module:
```bash
drush -y en opening_hours
```
Configure the opening hours module and set the Opening Hours API url via
`admin/admin/config/services/opening-hours`.
## Usage
Adding opening hours information to an entity is done by adding an opening hours
field.
The opening hours information is loaded via ajax requests to the opening hours
backend.
## Synchronization
The opening hours information could be changed (service and channel label) or
could be removed from the opening hours backend. A drush command is available to
synchronization the data and to flag opening hours fields with broken links.
- `drush opening-hours:sync all` : Synchronize all opening hours fields of all
entities where they are used.
- `drush opening-hours:sync node_type` : Synchonize all opening hours fields of
all entities of the provided entity type.
- `drush opening-hours:sync node_type:123` : Synchronize all opening hours
fields of the provided entity type and entity id.
Broken links will be logged in the log.
There is an event that is triggered if a broken field is detected.
See `\Drupal\opening_hours\Event\FieldBrokenLinkEvent`
and `\Drupal\opening_hours\EventSubscriber\FieldSubscriber`.
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed
recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md)
and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
## Security
If you discover any security related issues, please email security [at] gent.be
instead of using the issue tracker. See [SECURITY](SECURITY.md)
## Credits
- [Stad Gent][link-author-stadgent]
- [Digipolis Gent][link-author-digipolisgent]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File][link-license] for more
information.
## Roadmap and issue queue notes
This project is created and maintained by Digipolis Gent. During active
development, we use an internal issue tracker to guide/drive our development.
By working this way, we can link issues for other projects dependent on this
project, create cross-project boards, ... This allows our developers, project
leads and business analysts to have a better overview than we can create on
Github. This means that our roadmap won't be visible on here (for now).
We still look at the issue queue here and off course we welcome pull requests
with open arms! We are committed to creating and maintaining open source
projects. Questions about our approach can be asked through the issue queue
(except for security issues).
[link-author-stadgent]: https://github.com/stadgent
[link-author-digipolisgent]: https://github.com/digipolisgent
[link-contributors]: ../../contributors
[Opening Hours platform]: https://github.com/StadGent/laravel_site_opening-hours
[github-badge]: https://img.shields.io/badge/github-StadGent_Opening_Hours-blue.svg?logo=github
[github-link]: https://github.com/StadGent/drupal_module_opening-hours
[license-badge]: https://img.shields.io/github/license/StadGent/drupal_module_opening-hours.svg?style=flat-square
[license-link]: LICENSE.md
[travis-master-badge]: https://api.travis-ci.com/StadGent/drupal_module_opening-hours.svg?branch=8.x-1.x "Travis build master"
[travis-master-link]: https://travis-ci.com/github/StadGent/drupal_module_opening-hours/branches
[travis-develop-badge]: https://api.travis-ci.com/StadGent/drupal_module_opening-hours.svg?branch=8.x-1.x-dev "Travis build develop"
[travis-develop-link]: https://travis-ci.com/github/StadGent/drupal_module_opening-hours/branches
[codeclimate-maint-badge]: https://api.codeclimate.com/v1/badges/b91a9d4708dae2596c04/maintainability
[codeclimate-maint-link]: https://codeclimate.com/github/StadGent/drupal_module_opening-hours/maintainability
[codeclimate-cover-badge]: https://api.codeclimate.com/v1/badges/b91a9d4708dae2596c04/test_coverage
[codeclimate-cover-link]: https://codeclimate.com/github/StadGent/drupal_module_opening-hours/test_coverage