Přidání About boxu do PHP aplikace (Laravel, Symfony)

Živá ukázka

Toto je About box samotné aplikace AboutTheApp. Přepnutím varianty uvidíte další podoby. Kód níže zobrazí přesně tento box. Pro svou aplikaci v něm změňte alias.

<script src="https://aboutthe.app/embed/web/0.3.5/card.js" integrity="sha384-X3VGSEdTNGsfVKfVUx7sq9ICfpWsJW88HDQYidGPio1KjoxYCbSirTNqtbVfq1sj" crossorigin="anonymous" async></script>

<about-the-app alias="aboutthe.app" variant="card" api-base="https://aboutthe.app/api/v1" visual-style="default" palette="default" appearance="auto"></about-the-app>

Přidání do šablony v PHP ve 3 krocích

About box je Web Component, který vykresluje prohlížeč. PHP aplikace vypíše jen skript a prvek, takže nepotřebuje balíček z Composeru a nevolá žádné API.

1. 1

   Vytvořte si produkt

   Vytvořte ho v AboutTheApp a poznamenejte si jeho alias. V panelu Integrovat na kartě produktu najdete stejný kód jako v živé ukázce, už s vaším aliasem.

2. 2

   Načtěte skript v hlavní šabloně

   Vložte skript jednou do hlavní šablony, například resources/views/layouts/app.blade.php v Laravelu nebo templates/base.html.twig v Symfony.

3. 3

   Umístěte prvek

   Vložte <about-the-app alias="aboutthe.app"></about-the-app> do patičky hlavní šablony nebo do šablony stránky O aplikaci.

<footer>
  <about-the-app alias="aboutthe.app" variant="footer" version="{{ $appVersion }}"></about-the-app>
</footer>

<script src="https://aboutthe.app/embed/web/v1/abouttheapp.js" async></script>

Verze z Composeru v Laravelu

Composer 2 zná verzi vašeho kořenového balíčku. Metoda InstalledVersions::getRootPackage() ji vrací jako pretty_version, což je pole version ze souboru composer.json nebo tag v Gitu, ze kterého byla aplikace nainstalovaná. Na větvi bez tagu vrátí hodnotu jako dev-main.

Zpřístupněte ji všem šablonám v AppServiceProvider a hlavní šablona výše ji použije. Poznámky k vydání se zobrazí, pokud stejná verze existuje v katalogu verzí produktu a je veřejná. Pokud si nejste jistí, jak aplikaci verzovat, přečtěte si článek Verzování aplikací.

use Composer\InstalledVersions;
use Illuminate\Support\Facades\View;

public function boot(): void
{
    View::share('appVersion', InstalledVersions::getRootPackage()['pretty_version']);
}

Symfony a Twig

V Symfony definujte app_version jako globální proměnnou Twigu v souboru config/packages/twig.yaml, například z proměnné prostředí APP_VERSION, kterou nastaví nasazení. Základní šablona ji pak předá prvku.

<footer>
  <about-the-app alias="aboutthe.app" variant="footer" version="{{ app_version }}"></about-the-app>
</footer>

<script src="https://aboutthe.app/embed/web/v1/abouttheapp.js" async></script>

Časté otázky