README

Symfony Bundle with interfaces, traits, models and services needed by more than one Survos components. For example, Model\Column is used by grid, api-grid and simple-datatables. RouteParametersInterface is used by tree and the griid bundles.

symfony/symfony#20083

composer req survos/core-bundle

<?php
// src/Entity/Foo.php
namespace App\Entity;

use Survos\CoreBundle\Entity\RouteParametersInterface;
use Survos\CoreBundle\Entity\RouteParametersTrait;

class Foo implements RouteParametersInterface
{
use RouteParametersTrait;

public function getUniqueParams(): array { 
    return ['fooId' => $this->getFooCode()];
}

Now use .rp in twig and ->getRp() in php as part of generating a route

<a href="{{ path('foo_show', foo.rp) }}">Show</a>

Combined with survos/maker-bundle, create a param converter

bin/console survos:make:param-converter Foo

Helper Tasks

echo "SYMFONY_DEPRECATIONS_HELPER=weak" >> .env

Shared Utilities

Survos\CoreBundle\Service\SurvosUtils is the home for small, shared helpers that are useful across multiple Survos bundles and applications. Before adding local string/path/entity helper methods in another bundle, check here first.

Common static helpers:

Example:

use App\Entity\Intake;
use Survos\CoreBundle\Service\SurvosUtils;

$code = SurvosUtils::entityCode(Intake::class); // app_intake
$route = $code . '_show';                       // app_intake_show

Instance helpers are available when the service is injected:

Guideline for agents and bundle authors: if a helper needs to be shared by api-grid-bundle, tabler-bundle, field-bundle, maker code, or app code, put it in core-bundle instead of recreating it locally.