omnibase/press

Installation

Requirements

What composer.json requires: PHP 8.2 or later, doctrine/orm 2.15 or 3, omnisense/omnibase 3.0 or 4.0, omnibridge/symfony 1.x, omnibase/admin, and symfony/config, dependency-injection, form, http-kernel, security-bundle and string 6, 7 or 8. The back office's screens use omnibase/admin's #[OpenToAdmins] attribute (omnibase/admin from 7474f85).

The bundle

composer require omnibase/press:dev-main

// config/bundles.php
return [
    // ...
    Base\BaseBundle::class => ['all' => true],
    Base\Admin\AdminBundle::class => ['all' => true],
    Base\Press\PressBundle::class => ['all' => true],
];

PressBundle extends the core's AbstractBaseBundle: its root is the package's (templates/ is @Press, public/ is bundles/press/), and build() aliases Base\Press\Entity\* to App\Entity\Press\* and the repositories to App\Repository\Press\*: an application takes an entity over by declaring App\Entity\Press\Quote extends Base\Press\Entity\Quote.

The routes

# config/routes.yaml
press_controller:
    resource: "@PressBundle/src/Controller/Client"
    type: attribute
    prefix: /

Configuration

# config/packages/press.yaml (every key optional)
press:
    download_kit: true
    bio_lengths: [short, medium, long]
    contacts:
        - name: "Anna Keller"
          role: "General management"
          organisation: "Keller Artists"
          email: "anna@keller-artists.example"
          phone: "+49 30 000 00 00"
          url: "https://keller-artists.example"

The schema and the public files

bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate
bin/console assets:install

Tables press_quote, press_photo, press_bio; the stylesheet bundles/press/css/press.css.

What the layout provides

The page extends layout1.html.twig and fills title, description, content and stylesheets.

Quotes, photos and biographies

Quote

Base\Press\Entity\Quote (press_quote, indexed on visible, featured, position):

Empty strings are kept as null. Methods:

• getTextIn(string $locale), getRoleIn(string $locale) - the translation for a reader of that language, else the original words and role. isTranslatedIn($locale) - there is a translation and it is not the original's language.
• setTranslation(string $locale, ?string $text, ?string $role = null) - nothing in either removes it; setTranslations(array) takes {fr: {text, role}} or {fr: 'words'}.
• The magic properties translation_<xx> and role_<xx> read and write translations - the back office's fields, one pair per language of the site.
• speaks(string $locale) - no locale, or that one.
• getSignature() - "Joshua Bell, violinist — BBC Music Magazine"; the source is not repeated when the role or author already names it.
• toggleFeatured().

Photo

Base\Press\Entity\Photo (press_photo, indexed on visible, position):

A photograph not cleared for the press goes in the gallery only. getFileUrl() is the address an <img> takes (/uploads/...: the storage's path with the public directory taken off). getAlt() is the caption, else the title. getCreditLine() adds © unless the credit starts with ©, (c), photo or foto.

Bio

Base\Press\Entity\Bio (press_bio, unique on locale and bio_length):

getParagraphs(), getWordCount(), Bio::countWords(string) - what stands between two blanks, in any alphabet: "l'archet" and "Sinfonie-Orchester" are one word each, a lone dash none. isTooLong() - more than the length's words plus ten percent (never for LONG).

In memory

Run in omnisense/omnibase's harness image, with this checkout's src/ on the autoloader:

use Base\Press\Entity\Bio;
use Base\Press\Entity\Photo;
use Base\Press\Entity\Quote;
use Base\Press\Enum\BioLength;
use Base\Press\Service\PhotoFilename;

$quote = (new Quote('« A harp that sings. »', 'Joshua Bell', 'BBC Music Magazine'))->setRole('violinist')->setLanguage('en');
$quote->setTranslation('fr', 'Une harpe qui chante.', 'violoniste');
echo $quote->getText(), ' | ', $quote->getSignature(), "\n";
echo $quote->getTextIn('fr'), ' | ', $quote->getRoleIn('fr'), ' | ', $quote->getTextIn('de'), "\n";

$bio = new Bio('FR', BioLength::SHORT, str_repeat('mot ', 111));
var_dump($bio->getLocale(), $bio->getWordCount(), $bio->isTooLong());
echo Bio::countWords("l'archet du Sinfonie-Orchester - fin"), "\n";

echo (new Photo())->setCredit('Harald Hoffmann')->getCreditLine(), "\n";
echo PhotoFilename::of('Clara Weiss', 'Portrait with harp', '© Harald Hoffmann', 12, 'JPEG'), "\n";
echo PhotoFilename::of('clara-weiss.example', null, null, 12, 'png'), "\n";

A harp that sings. | Joshua Bell, violinist — BBC Music Magazine
Une harpe qui chante. | violoniste | A harp that sings.
string(2) "fr"
int(111)
bool(true)
4
© Harald Hoffmann
clara-weiss-portrait-with-harp.jpg
clara-weiss-example-photo-12.png

Repositories

The page and the downloads

/press

Base\Press\Controller\Client\PressController::index() renders @Press/client/index.html.twig:

The languages: a quote is for a reader of its locale, or of every language when it has none; its words are the reader's translation when there is one (with the original on demand when offerOriginal). The fallback language is PressController::FALLBACK_LOCALE, en.

Downloading an original

GET /press/photo/{id}/download sends the original as an attachment, with X-Robots-Tag: noindex. A 404 when the picture does not exist, is not in the press kit, is not downloadable, has no file, or press.download_kit is off.

The file is named by Base\Press\Service\PhotoFilename::of($site, $title, $credit, $id, $extension): <site>-<slug>.<ext> - the site's title (base.settings.title, else the host without www.), the picture's title, else its credit without its sign, else photo-<id>; slugged in ASCII and lowercased; jpeg written jpg; an extension cannot carry a path. The file in a journalist's folder still says whose it is.

Twig functions

Base\Press\Twig\PressExtension, in the current request's language:

{% for quote in press_quotes(2) %}
    {% include '@Press/client/_quote.html.twig' with {quote: quote} %}
{% endfor %}

{% set bio = press_bio('medium') %}
{% if bio %}{% for paragraph in bio.paragraphs %}<p>{{ paragraph }}</p>{% endfor %}{% endif %}

Templates and look

@Press/client/: index, _quote (one quote), _quote_words. An application overrides them in templates/bundles/PressBundle/client/.... bundles/press/css/press.css follows the host's --press-accent, --press-ink, --press-soft, --press-line, --press-surface and --press-measure when it defines them.

Translations: the domain press (ICU), in English, French and German.

The back office

Loaded when omnibase/admin is installed. The three screens carry omnibase/admin's #[OpenToAdmins]: the site's administrator (ROLE_ADMIN) creates, edits and deletes, not only the super-administrator - and, on quotes, uses the feature button.

The languages are kernel.enabled_locales, else en, fr, de.

Feature (/admin/quotes/{entityId}/feature, on the list and on a quote) toggles featured and says which way it went.

The biography's text has a live word counter under it: the same words Bio::countWords() counts, shown against 100 or 250 for the length chosen, in red past ten percent more.

Configuration reference

press:

Base\Press\DependencyInjection\PressConfiguration, dumped with Symfony's YamlReferenceDumper in omnisense/omnibase's harness image:

press:

    # Who the press writes to: the agency, the label's PR, the artist.
    contacts:

        # Prototype
        -
            name:                 ~ # Required

            # "General management", "Press, Germany"...
            role:                 null
            email:                null
            phone:                null
            organisation:         null
            url:                  null

    # The HD downloads at all: off, the photos are shown and none can be taken.
    download_kit:         true

    # The biographies the page shows, in this order.
    bio_lengths:

        # Defaults:
        - short
        - medium
        - long

The parameters are press.contacts (read whole), press.download_kit, press.bio_lengths (and the flattened leaves of each).

Services

config/services.php autowires and autoconfigures every class of src/ but DependencyInjection/, Entity/, Enum/, Controller/Admin/ and the bundle class; Controller/Client/ is tagged controller.service_arguments; with omnibase/admin, Controller/Admin/ too. PressController and PressExtension read the parameters with #[Autowire]; PressController reads base.settings.title from the core's setting bag.

Testing

vendor/bin/phpunit                                                    # checked out on its own
php vendor/bin/phpunit -c vendor/omnibase/press/phpunit.xml.dist      # from an application

In omnisense/omnibase's harness, this checkout mounted over the package (the harness registers the press bundle for this suite):

docker run --rm --network none -v "$PWD":/srv/demo/vendor/omnibase/press:ro omnisense/omnibase-harness test press

..................................                                34 / 34 (100%)

OK (34 tests, 142 assertions)