Download the PHP package sayamaapps/kirby-higawari without Composer
On this page you can find all versions of the php package sayamaapps/kirby-higawari. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sayamaapps/kirby-higawari
More information about sayamaapps/kirby-higawari
Files in sayamaapps/kirby-higawari
Package kirby-higawari
Short Description Daily menu (Tageskarte) for Kirby CMS 5: dishes with a validity date and window, a Panel structure, a plain snippet and a Fude marker for changes by chat. No scripts, no third-party requests, no chat or write endpoint.
License MIT
Homepage https://github.com/sayamaapps/kirby-higawari
FAQ
Example:
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 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.
Informations about the package kirby-higawari
Higawari
Daily menu for Kirby CMS 5. Higawari (日替わり) is Japanese for "changes every day": a menu of dishes, each menu valid on a date you set, shown on that day and nothing else.
- A date, a window. A menu is valid on its date, or on as many days as the site sets, counted from that date. Without a date nothing is shown, so an old card cannot linger.
- The Panel. A tab with the date and up to five dishes (name, further lines, price, markers). Dish names are the only required text.
- Plain output. One snippet with semantic HTML and
higawari-*classes. No JavaScript, no request to another server, no cookie. - Optional text when nothing is valid. Either nothing, or a sentence of your choice.
- Nothing that writes from outside. Higawari has no chat, bot or write endpoint. Changes by chat belong to the separate package Fude, which reads the marker in the dishes blueprint (see below).
Code, comments and this README are in English. The Panel texts and the snippet texts are in German and English.
Requirements
- PHP 8.2 to 8.4
- Kirby 5
Installation
Composer installs the plugin into site/plugins/higawari/. Until the package is on Packagist, add the repository first:
Off by default. Switch it on in site/config/config.php:
Configuration
All options are read as sayamaapps.higawari.<name>, flat or nested. null counts as "not set". A broken value is reported to the PHP error log once and the default is used; with Kirby's debug option on, it throws instead.
| Option | Default | Meaning |
|---|---|---|
active |
false |
Master switch. Only a real true switches it on. |
days |
1 |
How many days a menu is shown, counted from its date: 1 is the day itself, 3 is the date and the two days after. From 1 to 366. Only in mode from; mode until ignores it. |
dateMode |
from |
What the date means, see Two date modes. from: the first day, shown for days days. until: the last day ("Anzeigen bis"). Any other value is reported and from is used. |
timezone |
Europe/Berlin |
The zone in which "today" is decided. |
currency |
€ |
Shown after a price, with a space: 7,50 €. An empty string shows bare numbers: 7,50. |
emptyText |
null |
Shown in place of the menu when none is valid. null shows nothing. |
note |
null |
A line under the dishes, for example about prices or allergens. |
language |
site language | de or en, for the snippet and Panel texts. Otherwise the default language, then the first two letters of locale, then English. |
Content field contract
The Panel tab writes two fields. Their names are a compatibility promise: sites that already store these field names keep working unchanged, so their content needs no migration.
| Field | Type | Meaning |
|---|---|---|
tageskarteDatum |
date | "Gilt am", in mode until "Anzeigen bis": the day the menu is valid on, or with dateMode until the last day it is shown. Empty: nothing is shown. |
tagesgerichte |
structure, max. 5 | The dishes (see below). |
Dish fields:
| Field | Type | Meaning |
|---|---|---|
gericht |
text, required, max. 160 | The dish. |
beschreibung |
textarea, max. 300 | Further lines, one per line break. |
preis |
number, 0 to 999, step 0.01 | Optional. Empty shows the dish without a price. |
kennzeichnungen |
text, max. 40 | Optional markers, shown as written. |
Reading rules, the same for the Panel content and imported data: a dish without a name is dropped; a price that cannot be read (abc, 1000, 12.345) drops the dish rather than showing a wrong amount; a decimal comma and a decimal point both work; at most five dishes are shown, in order.
Two date modes
from(default): the date is the first day. The menu is shown on it and on thedays− 1 days after it.until: the date is the last day. The menu is shown on every day up to and including it, with no first day, so a card entered "until Friday" is visible at once and disappears after Friday.daysdoes not apply.
Switching the mode changes the meaning of the stored date, not the content: a site that moves from from to until has to re-enter the dates that should now mean "until".
Why these fields
gericht,preis,beschreibung: the same price check applies to every price. The extra text can be kept as one string or split into lines; Higawari splits it, because a line break in a Panel field is the way editors write a list of sauces or sides.kennzeichnungen: free text, because an allergen or marker list is a legal matter that the site should decide, not the package. A structured list (for example EU allergen numbers) would be a guess at that decision.tageskarteDatum: the day the menu is served, plus the window (days), so a menu can be shown for more than one day. An undated menu that stays visible until it is removed is deliberately not supported: a daily menu without a date would show last week's dishes.- Five dishes: the cap is five, both in the code and in the blueprint, so a larger blueprint cannot show more dishes than the code does.
- Price format:
7,50 €or7,50, depending on whether the Panel shows the unit. Thecurrencyoption covers both.
Left out on purpose
- Weekend and closing-day rules. The menu logic has none. Opening hours are another package's job (Noren).
- Chat, bots and write endpoints. Changes by chat are Fude's job.
- "Tageskarte leeren" as a Panel button. The clearing itself is here (see below). The button needs a dialog in the site's own Panel area, which only the site can define.
- The picture beside the menu, and its layout. Those are site design.
Blueprints
Add the tab to a page blueprint with extends:
Pieces for your own blueprints: higawari/tabs/daily-menu (the tab), higawari/fields/date and higawari/fields/dishes. The tab and the date show the texts of the configured dateMode, so the same blueprint works in both modes.
Snippet
Markup, with classes only and no inline style:
With dateMode until, the line reads Bis einschließlich Samstag, 10.10.2026 (English: Until Saturday, 10 October 2026), and its datetime is the last day.
With nothing valid, the snippet prints nothing, or only <p class="higawari-leer"> with the emptyText option. Every value is escaped. The page is never cached by Kirby, because the menu depends on the clock. To change the markup, create site/snippets/higawari.php; Kirby uses it instead.
No CSS is shipped. The classes are the hooks for your own stylesheet.
Page method
Clearing
CLEARED empties both fields together. Keeping the date would hide a menu entered the next day, because the old date has already passed.
Fude
The dishes field carries a fude: marker, so a site with Fude 1.4 or later gets the menu as a chat collection without a line in site/config/fude.php: a bot may replace the whole menu, update or delete a dish (at most five), and every change sets tageskarteDatum. That is today, unless the chat names another day ("the menu for tomorrow"); the marker sets editable, Fude refuses a past day. The bot learns what the date means from the field's label and help text. The marker sets readImages, so the chat side may read a photo of the blackboard as the new menu; the dishes on it still arrive as a draft that someone confirms. touch stamps the day in Fude's fude.timezone (default Europe/Berlin). Without Fude, Kirby ignores the marker.
| Dish | |
|---|---|
| Required | gericht |
| Asked | — (the menu comes as one message or a photo; asking every day would slow it down) |
| Free | beschreibung, preis, kennzeichnungen |
- In mode
untila change by chat without a named day sets the date to today, so the menu is shown until today only. The bot names the last day ("bis Freitag"). - The collection is named
<page id>-tagesgerichte, for examplehome-tagesgerichte. - The page needs both fields, as the tab brings them. A blueprint that extends only
higawari/fields/dishesmakes every Fude route fail, because the date to stamp is missing. - To switch it off, or to change it, use Fude's overrides in
site/config/fude.php:'home-tagesgerichte' => falseremoves the collection, an array under the same name replaces it.
Privacy
Higawari processes no visitor data: it sets no cookies, uses no browser storage and makes no request to a third party. There is nothing to add to a site's privacy policy.
Development
Every tests/*Test.php is a standalone script: exit code 0 means pass, so the suite also runs on a hoster's PHP without a test framework. MenuTest and I18nTest need no Kirby; KirbyTest and BlueprintsTest boot a real Kirby 5 on a throwaway site and need no network connection. CI runs them on PHP 8.2 to 8.4.
Changelog
See CHANGELOG.md.
License
MIT, see LICENSE.
