{"id":508,"date":"2019-12-13T15:57:22","date_gmt":"2019-12-13T14:57:22","guid":{"rendered":"https:\/\/wiki.ad-libitum.info\/?page_id=508"},"modified":"2020-09-22T11:57:03","modified_gmt":"2020-09-22T09:57:03","slug":"symfony-projekt","status":"publish","type":"page","link":"https:\/\/wiki.ad-libitum.info\/?page_id=508","title":{"rendered":"Symfony-Projekt"},"content":{"rendered":"\n

Mit dem composer das Projekt erstellen. Dazu auf DOS-Ebene ins htdocs-Verzeichnis gehen und den Befehl composer create-project symfony\/skeleton zielpfad<\/code> eingeben. Zielpfad ist das Verzeichnis innerhalb von htdocs, in dem das Projekt erstellt werden soll.<\/p>\n\n\n\n

Im Verzeichnis public muss eine .htaccess erstellt werden. Die bekommt folgenden Inhalt:<\/p>\n\n\n\n

<IfModule mod_rewrite.c>\n    RewriteEngine On\n\n    # Determine the _RewriteBase automatically and set is \n    # as environment variable\n    RewriteCond %{REQUEST_URI}::$1 ^(\/.+)\/(.*)::\\2$\n    RewriteRule ^(.*) - [E=BASE:%1]\n\n    # If the requested filename existes, simply serve it.\n    # We only want to let Apache serve files and not directories.\n    RewriteCond %{REQUEST_FILENAME} -f\n    RewriteRule .? - [L]\n\n    # Rewrite all other queries to the front controller.\n    RewriteRule .? %{ENV:BASE}\/index.php [L]\n<\/IfModule><\/pre>\n\n\n\n
Subversion<\/h2>\n\n\n\n
Damit die Versionierung klappt, muss Subversion eingerichtet werden. Dazu in PHPStorm unter VCS \/ Import into Version Control aufrufen und in das gew\u00fcnschte Repository exportieren. Anschlie\u00dfend gleich wieder mit VCS \/ Get from Version Control importieren, damit \u00c4nderungen erkannt werden.<\/p>\n\n\n\n
Dann noch im Dateiexplorer \u00fcber das Kontextmen\u00fc die nicht erforderlichen Verzeichnisse von Subversion ausnehmen.<\/p>\n\n\n\n
Zugriff auf die neue Site<\/h2>\n\n\n\n
F\u00fcr den Zugriff auf die Site sind zwei Anpassungen erforderlich:<\/p>\n\n\n\n
In der httpd-vhosts.conf<\/code> m\u00fcssen die folgenden Zeilen eingef\u00fcgt werden, wobei die Parameter hinter DocumentRoot und ServerName nat\u00fcrlich angepasst<\/b> werden m\u00fcssen.<\/p>\n\n\n\n
<virtualhost *:80=\"\">\n    DocumentRoot \"C:\\xampp\\htdocs\\symfony\\public\"\n    ServerName symphony.test\n<\/virtualhost><\/pre>\n\n\n\n
Anschlie\u00dfend muss XAMPP neu gestartet werden.<\/p>\n\n\n\n
Die zweite \u00c4nderung muss auf denjenigen PCs innerhalb des lokalen Netzes durchgef\u00fchrt werden, auf denen die Seite angezeigt werden soll. Und zwar in der Datei C:\\Windows\\System32\\drivers\\etc\\hosts<\/code>. Dort muss f\u00fcr die neue Site eine neue Zeile eingef\u00fcgt werden: 192.168.0.12        adlibitum.test<\/code>. Die IP ist dabei die IP des XAMPP-Servers und der zweite Parameter derjenige, der in der httpd-vhosts.conf<\/code> als ServerName eingetragen worden ist.<\/p>\n\n\n\n
Profiler<\/h2>\n\n\n\n
Der Profiler liefert viele interessante Informationen zum Programm im aktuellen Status zur\u00fcck. Das ist die Statuszeile am unteren Bildschirmrand.<\/p>\n\n\n\n
composer require profiler --dev<\/pre>\n\n\n\n
Logger<\/h2>\n\n\n\n
Der Logger liefert viele zus\u00e4tzliche Informationen zum Programm im aktuellen Status zur\u00fcck.<\/p>\n\n\n\n
composer require logger<\/pre>\n\n\n\n
Debugger installieren<\/h2>\n\n\n\n
In das Verzeichnis mit der neuen Internetsite wechseln.<\/p>\n\n\n\n
composer require debug --dev\ncomposer unpack debug<\/pre>\n\n\n\n
Der zweite Befehl dient dazu, das Paket in die einzelnen Komponenten  aufzul\u00f6sen. Damit k\u00f6nnen diese gezielt an die ben\u00f6tigte Version angepasst oder entfernt werden.<\/p>\n\n\n\n
Router installieren<\/h2>\n\n\n\n
composer require annotations<\/pre>\n\n\n\n
Das sorgt auch daf\u00fcr, dass die Use-Statements automatisch erg\u00e4nzt werden, falls erforderlich.<\/p>\n\n\n\n
Security Checker installieren<\/h2>\n\n\n\n
Um die Packages auf Sicherheitslecks pr\u00fcfen zu k\u00f6nnen, kann der sec-checker verwendet werden.<\/p>\n\n\n\n
composer require sec-checker --dev<\/pre>\n\n\n\n
Damit wird auch erreicht, dass nach jeder Installation eines Pakets ein Sicherheitscheck durchgef\u00fchrt wird. Um eine Pr\u00fcfung ohne Installation durchzuf\u00fchren: composer install<\/code>.<\/p>\n\n\n\n
Twig installieren<\/h2>\n\n\n\n
Wenn HTML-Templates verwendet werden sollen, wird Twig ben\u00f6tigt:<\/p>\n\n\n\n
composer require twig<\/pre>\n\n\n\n
Damit das dann auch genutzt werden kann, muss der Controller den AbstractController extenden: class XxxController extends AbstractController<\/code><\/p>\n\n\n\n
Maker-Bundle<\/h2>\n\n\n\n
Dieses Bundle wird f\u00fcr zahlreiche Funktionen ben\u00f6tigt.<\/p>\n\n\n\n
composer require symfony\/maker-bundle --dev<\/pre>\n\n\n\n
Datenbanktreiber<\/h2>\n\n\n\n
Mit Doctrine sind Datenbankfunktionen m\u00f6glich.<\/p>\n\n\n\n
composer require doctrine<\/pre>\n\n\n\n
Konfiguriert wird in der .env: <\/p>\n\n\n\n
DATABASE_URL=mysql:\/\/db_user:db_password@127.0.0.1:3306\/db_name?serverVersion=mariadb-10.4.14<\/pre>\n\n\n\n
Die mariadb ist wichtig, sonst kommt der Fehler sync-metadata-storage soll gestartet werden. Unter Umst\u00e4nden sind auch in der config\\packages\\doctrine.yaml<\/code> Einstellungen erforderlich.<\/p>\n\n\n\n
Anschlie\u00dfend kann auf DOS-Ebene die Datenbank mit php bin\/console doctrine:database:create<\/code> erstellt werden.<\/p>\n\n\n\n
Tabellen werden mit php bin\/console make:entity<\/code> erstellt. Anschlie\u00dfend mit php bin\/console make:migration<\/code> eine Migration erstellen. Diese im Verzeichnis migrations pr\u00fcfen, bevor sie mit php bin\/console doctrine:migrations:migrate<\/code> ausgef\u00fchrt wird.<\/p>\n\n\n\n
Debug-Infos<\/h2>\n\n\n\n
Um an beliebiger Stelle im Code Debugginginfos zu bekommen, kann dump($var);<\/code> eingebaut werden. Das erzeugt in der Debugging-Statuszeile ein neues Symbol: ein Fadenkreuz. \u00dcber dieses k\u00f6nnen die Inhalte der Variablen betrachtet werden. Die Verwendung ist auch in twig-Dateien m\u00f6glich. Dort einfach {{ dump() }}<\/code> einf\u00fcgen.<\/p>\n\n\n\n
Unter Windows erfolgt der Aufruf der Konsole mit php bin\/console<\/code>.<\/p>\n\n\n\n
Routing<\/h2>\n\n\n\n
Um das Routing in den Kommentarblock zu schreiben, m\u00fcssen Annotations installiert sein: composer require annotations<\/code>. Im Docbloc \u00fcber der Funktion dann @Route(\"\/\")<\/code> einf\u00fcgen, wobei zwischen den Anf\u00fchrungszeichen die Route steht. Im Beispiel die Route f\u00fcr index.<\/p>\n\n\n\n
Dar\u00fcber hinaus ist es sinnvoll, den Namen f\u00fcr die Route selbst festzulegen. Dadurch kann der Controller \u00fcber ein und denselben Namen referenziert werden, auch wenn der Name der Funktion ge\u00e4ndert wird. Um den Namen von Hand festzulegen, einfach einen zweiten Parameter mit angeben:<\/p>\n\n\n\n
\/**
<\/em> * <\/em>@Route<\/em><\/strong>(\"\/\", name=\"app_homepage\")
<\/em> *\/
<\/em>public function homepage()
{
    return new Response(\"Hallo Homepage!\");
}<\/pre>\n\n\n\n
Zum Aufrufen dieser Router dient dann <\/p>\n\n\n\n
href=\"{{ path('app_homepage') }}<\/pre>\n\n\n\n
Erwartet der Controller Parameter, so sind diese in Form eines Array zus\u00e4tzlich einzutragen: <\/p>\n\n\n\n
href=\"{{ path('article_show',{slug:'nur-ein-test'}) }}\"<\/pre>\n\n\n\n
HTML-Vorlagen<\/h2>\n\n\n\n
HTML-Vorlagen k\u00f6nnen dank Twig verwendet werden: composer require twig<\/code>. Die Templates daf\u00fcr kommen in das Verzeichnis templates.<\/p>\n\n\n\n
Damit Twig genutzt werden kann, muss die Controllerklasse erweitert werden: extends AbstractController<\/code>. Eingebunden wird dann mit dem Befehl return $this->render()<\/code>. Der Aufruf erwartet zwei Parameter: der erste ist die zu verwendende Vorlage, der zweite sind zu \u00fcbergebenden Parameter in Form eines Arrays.<\/p>\n\n\n\n
\/**\n * <\/em>@Route<\/em><\/strong>(\"\/fahrten\/{slug}\")\n *\/\n<\/em>public function fahrten($slug)\n{\nreturn $this->render('homepage\/base.html.twig',[\n\"title\" => ucwords(str_replace(\"-\", \" \", $slug)),\n]);\n}<\/pre>\n\n\n\n
Assets<\/h2>\n\n\n\n
Mit Assets kann man im Code automatische Referenzen einbauen. Zur Nutzung mit dem Befehl composer require asset<\/code> installieren. Damit kann man dann in Twigdateien folgendes verwenden: <\/p>\n\n\n\n
<link rel=\"stylesheet\" href=\"{{ asset('css\/styles.css') }}\"><\/pre>\n\n\n\n
Markdown<\/h2>\n\n\n\n
Um per Twig auszugebenden Text zu formatieren, muss ein Markdownbundle installiert werden: composer require knplabs\/knp-markdown-bundle<\/code>.<\/p>\n\n\n\n
\u00dcbersetzungen<\/h2>\n\n\n\n
Installieren mit composer require symfony\/translation<\/code>.<\/p>\n\n\n\n
Im YAML-Format werden die Strings OHNE “ eingegeben. Das Leerzeichen nach dem Doppelpunkt zwischen den Sprachen ist wichtig!<\/p>\n\n\n\n
Formulare<\/h2>\n\n\n\n
Installieren mit composer require form<\/code>.<\/p>\n\n\n\n
Zun\u00e4chst eine Klasse f\u00fcr das Formular erstellen. Diese muss Bedingungen erf\u00fcllen:<\/p>\n\n\n\n
NAMExFormType extends AbstractType<\/code><\/pre>\n\n\n\n
Der Name muss mit FormType beendet werden und die Klasse muss die oben genannte Klasse erweitern. Darin dann eine Funktion erstellen (Strg+O):<\/p>\n\n\n\n
public function buildForm() {
    $builder
        ->add('NameDBFeld') \/\/so oft wie erforderlich
     ;<\/code><\/pre>\n\n\n\n
Im Kontroller wird dann das Formular gerendert:<\/p>\n\n\n\n
$form = $this-> createForm(NAMExFormType::class);
return $this-> render('Verzeichnis\/NAMEz.htlm.twig', [
    'NAMEy' => $form->createView(),
])<\/code><\/pre>\n\n\n\n
Im Template, wird schnell erstellt, indem man im Kontroller den Cursor auf den Templatenamen setzt und Alt+Enter dr\u00fcckt, dann folgendes einf\u00fcgen:<\/p>\n\n\n\n
{{ form_start (NAMEy) }}
    {{form_widget(NAMEy) }}
{{ form_end (NAMEy) }}<\/code><\/pre>\n\n\n\n
Um die Formulardaten zu verarbeiten, den Kontroller wie folgt erweitern:<\/p>\n\n\n\n
public function new(EntityManagerInterface $em, Request $request) \/\/httpFoundation\n...\n{\n    $form = $this->createForm(ArticleFormType::class);\n\n    $form->handleRequest($request);\n    if ($form->isSubmitted() && $form->isValid()) {\n        $data = $form->getData();\n        $article = new Article();\n        $article->setTitle($data['title']);\n        $article->setContent($data['content']);\n        $article->setAuthor($this->getUser());\n\n        $em->persist($article);\n        $em->flush();\n\n        $this->addFlash('erfolg', \"Hat geklappt!\");\n\n        return $this->redirectToRoute('admin_article_list');\n    }\n\n    return $this->render('article_admin\/new.html.twig', [\n        'articleForm' => $form->createView(),\n    ]);\n}<\/pre>\n\n\n\n
Damit der Anwender wei\u00df, dass es geklappt hat, soll eine entsprechende Meldung angezeigt werden. Dazu die DB-Klasse erweitern:<\/p>\n\n\n\n
$this->addFlash('erfolg', \"Meldung\");<\/pre>\n\n\n\n
Sowohl erfolg als auch Meldung sind beliebige Texte. Gespeichert wird in der Session und die Inhalte k\u00f6nnen nur 1x<\/strong> gelesen werden, weil sie beim Lesen gleich gel\u00f6scht werden.<\/p>\n\n\n\n
Zur Anzeige der Meldung im Twig-Template einfach einbauen:<\/p>\n\n\n\n
{% for message in app.flashes('erfolg') %}\n    {{ message }}\n{% endfor %}<\/pre>\n\n\n\n
Um eine solche Variable zu pr\u00fcfen, ohne<\/strong> sie zu l\u00f6schen:<\/p>\n\n\n\n
{{ app.session.flashBag.peek('erfolg')|length > 0 ? '' : 'mb-5' }}<\/pre>\n\n\n\n
Man kann sich das Leben auch vereinfachen, indem man das Formular an die DB-Klasse bindet. Dann wird nicht nur der Feldtype automatisch erkannt, auch die manuelle Zuweisung der Formularfelder zu den DB-Feldern kann entfallen. Dazu in der Formularklasse eine neue Funktion einbauen – Strg+O \/ Configure Options:<\/p>\n\n\n\n
public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
        'data_class' => Article::class
    ]);
}<\/pre>\n\n\n\n
Im Kontroller zur DB-Klasse k\u00f6nnen dann die manuellen Zuweisungen entfallen. Statt dessen wird eine Variable f\u00fcr die DB-Klasse verwendet:<\/p>\n\n\n\n
\/** <\/em>@var <\/em><\/strong>Article <\/em>$article <\/em>*\/
<\/em>$article = $form->getData();
$article->setAuthor($this->getUser());<\/pre>\n\n\n\n
Das Article muss dabei vom Typ App\\Entity sein.<\/p>\n\n\n\n
Formulare k\u00f6nnen auch automatisch mit Formatvorlagen verkn\u00fcpft werden. Dazu muss in config\\packages die twig.yaml angepasst werden:<\/p>\n\n\n\n
form-themes:
    - 'bootstrap_4_layout.html.twig'<\/pre>\n\n\n\n
Welche Themes es gibt, kann man bei Symfony<\/a> nachschauen.<\/p>\n\n\n\n
Die Feldtypen k\u00f6nnen auch von Hand angepasst werden. Infos gibt es bei Symfony<\/a>. Infos zu den Formattypen gibt es hier<\/a>. Der hinzugef\u00fcgte Feldtyp muss vom Typ Symfony\\Component\\Form\\Extension\\Core\\Type sein. \u00dcbrigens, um den zweiten Parameter zu \u00fcberspringen, null eintragen.<\/p>\n\n\n\n
Auswahllisten anhand von DB-Feldern werden ebenfalls mit ->add bef\u00fcllt. Als dritter Parameter wird die gew\u00fcnschte DB angegeben.<\/p>\n\n\n\n
-> add('author', EntityType::class, [
    'class' => User::class
])<\/pre>\n\n\n\n
In dieser Klasse braucht es dann aber eine spezielle Funktion:<\/p>\n\n\n\n
public function __toString()
{
    return $this->getFirstName();
}<\/pre>\n\n\n\n
Hier wird dasjenige Feld aus der zuvor definierten Tabelle \u00fcbergeben, das hier genannt wird.<\/p>\n\n\n\n
Soll ein definiertes Feld angesprochen werden, wird so gearbeitet:<\/p>\n\n\n\n
-> add('author', EntityType::class, [\n    'class' => User::class,\n    'choice_label' => function(User $user) {\n        return sprintf('(%d) %s', $user->getId(), $user->getFirstName());\n    },\n])<\/pre>\n\n\n\n
Wenn keine der Optionen aus der Liste vorausgew\u00e4hlt sein soll:<\/p>\n\n\n\n
'placeholder' => 'Bitte ausw\u00e4hlen',<\/pre>\n\n\n\n
F\u00fcr individuelle Abfragen muss zun\u00e4chst das Repository deklariert werden – in der Formklasse:<\/p>\n\n\n\n
public function __construct(UserRepository $userRepository)
{
    $this->userRepository = $userRepository;
}<\/pre>\n\n\n\n
Um die Variablen automatisch zu initialisieren, den Cursor auf die Variable setzen, Alt-Enter dr\u00fccken und den Code erzeugen lassen. Dann im Formularbereich eine neue Variable einf\u00fcgen:<\/p>\n\n\n\n
'choices' => $this->userRepository
    ->findAllEmailAlphabetical(),<\/pre>\n\n\n\n
Diese Funktion findAllEmailAlphabetical muss dann im Repository\\userRepository.php erzeugt werden:<\/p>\n\n\n\n
public function findAllEmailAlphabetical()
{
    return $this->createQueryBuilder('u')
        ->orderBy('u.email', 'ASC')
        ->getQuery()
        ->execute();
}<\/pre>\n\n\n\n
<\/p>\n\n\n\n
Auch ansehen<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Mit dem composer das Projekt erstellen. Dazu auf DOS-Ebene ins htdocs-Verzeichnis gehen und den Befehl composer create-project symfony\/skeleton zielpfad eingeben. Zielpfad ist das Verzeichnis innerhalb von htdocs, in dem das Projekt erstellt werden soll. Im Verzeichnis public muss eine .htaccess erstellt werden. Die bekommt folgenden Inhalt: <IfModule mod_rewrite.c> RewriteEngine On # Determine the _RewriteBase automatically […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-508","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=\/wp\/v2\/pages\/508","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=508"}],"version-history":[{"count":0,"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=\/wp\/v2\/pages\/508\/revisions"}],"wp:attachment":[{"href":"https:\/\/wiki.ad-libitum.info\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=508"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}