Skip to content

UPGRADE-PRE-1.0.md

Latest commit

 

History

History
159 lines (115 loc) · 3.35 KB

UPGRADE-PRE-1.0.md

File metadata and controls

159 lines (115 loc) · 3.35 KB

Upgrading (pre v1.0)

Any upgrade notes for pre v1.0 releases that include backward-incompatible API changes.

Upgrading from v0.6 and 0.7 to v0.8

PHP 7.4

Strata currently requires a minimum of PHP 7.4, the current actively supported version of PHP.

Upgrade from Symfony 4.4 to Symfony 5

Note: Symfony 5.3 is released in May

Update all Symfony packages in your composer.json to "5.2.*"

E.g.

  symfony/framework-bundle": "5.2.*"

Update the extra.symfony.require setting at the bottom of your composer.json file:

 "extra": {
      "symfony": {
          "allow-contrib": false,
          "require": "5.2.*"
      }
  }

Run composer update "symfony/*"

There may be other steps to follow for your application, see https://symfony.com/doc/current/setup/upgrade_major.html

Use v0.8 branch

While in dev, update your composer.json file:

  "strata/frontend": "dev-release/0.8.0 as 0.8.0"

When released:

  "strata/frontend": "^0.8"

Run composer update

Update content model config files

In 0.8.0 the ContentModel classes, which define what content types you have available to query in the API, have been changed to Schema classes.

Update controller code TODO

v0.6 format (example page controller action):

public function __construct(CacheInterface $cache, LoggerInterface $logger)
{
    $this->api = new Wordpress(
        getenv('APP_API_BASE_URL'),
        new ContentModel(__DIR__ . '/../../config/content/content-model.yaml')
    );
    $this->api->setCache($cache);
    $this->api->setCacheLifetime(1800);
    $this->api->setLogger($logger);
}
    
public function page(string $slug, Request $request)
{
    $slug = filter_var($slug, FILTER_SANITIZE_STRING);
    $this->api->setCacheKey($request->getRequestUri());

    try {
        // Home content
        $this->api->setContentType('page');
        $page = $this->api->getPageBySlug($slug);

    } catch (NotFoundException $e) {
        throw new NotFoundHttpException('Page not found', $e);
    }

    return $this->render('pages/page.html.twig', [
        'page'  => $page,
    ]);
}

This has been updated and simplified in v0.8:

public function __construct(CacheInterface $cache, LoggerInterface $logger)
{
    $this->api = new Wordpress(
        getenv('APP_API_BASE_URL'),
        new ContentModel(__DIR__ . '/../../config/content/content-model.yaml')
    );
    $this->api->setCache($cache);
    $this->api->setLogger($logger);
}

public function page(string $slug, Request $request)
{
    $slug = filter_var($slug, FILTER_SANITIZE_STRING);

    try {
        // Home content
        $this->api->setContentType('page');
        $page = $this->api->getPageBySlug($slug);

    } catch (NotFoundException $e) {
        throw new NotFoundHttpException('Page not found', $e);
    }

    return $this->render('pages/page.html.twig', [
        'page'  => $page,
    ]);
}
  • Data caching is now automated based on URI and options (you may still want to add cache tags)

Twig helpers

slugify

Now a filter. Old format:

{{ slugify(content) }}

New format:

{{ content | slugify }}

fix_url

Now a filter, defaults to https instead of http. Old format:

{{ fix_url(url) }}

New format:

{{ url | fix_url }}

To return http:// URLs:

{{ url | fix_url('http' }}