Tutoriel pour apprendre à créer une application Laravel

Les articles (front-end)

Maurice Chavelli

Les éléments essentiels d'un blog sont assurément les articles. Nous allons donc voir cet aspect. Les articles sont accessibles à tous les visiteurs. Seuls les rédacteurs et les administrateurs peuvent en rédiger.

Nous allons voir comment sont gérés les articles au niveau du front-end. Avec ces considérations :

- affichage des articles avec pagination ;

- affichage des articles par tag ;

- recherche dans les articles ;

- affichage des commentaires ;

- création et modification des commentaires.

Commentez

- Titre : Tutoriel pour apprendre à créer une application Laravel

- Auteur : Maurice Chavelli

- Parution : 28 novembre 2017

- Mise à jour : 28 novembre 2017

- Licence : Copyright ® 2017 Laravel. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Les sommaires

- II. Affichage d'un article

- III. Les tags

- IV. La recherche

- V. Les commentaires

- V-A. Affichage

- V-B. Soumission

- V-C. Suppression

- V-D. Modification

- VI. Remerciements

I - Les sommaires

Les articles sont accessibles à tous les visiteurs en cliquant sur BLOG dans le menu avec cet aspect :

On a alors les sommaires des articles qui apparaissent avec une pagination qui limite la génération à deux articles à la fois.

C'est la méthode indexFront du contrôleur BlogController qui est chargée de cet affichage :

1. /**

2. * Display a listing of the resource.

3. *

4. * @return Response

5. */

6. public function indexFront()

7. {

8. $posts = $this->blog_gestion->indexFront($this->nbrPages);

9. $links = $posts->setPath('')->render();

11. return view('front.blog.index', compact('posts', 'links'));

12. }

Le repository est injecté dans le constructeur :

1. /**

2. * Create a new BlogController instance.

3. *

4. * @param  App\Repositories\BlogRepository $blog_gestion

5. ...

6. * @return void

7. */

8. public function __construct(

9. BlogRepository $blog_gestion,

10. ...)

11. {

12. ...

13. $this->blog_gestion = $blog_gestion;

14. $this->nbrPages = 2;

16. ...

17. }

C'est la méthode indexFront du repository BlogRepository qui est appelée :

1. /**

2. * Get post collection.

3. *

4. * @param  int  $n

5. * @return Illuminate\Support\Collection

6. */

7. public function indexFront($n)

8. {

9. $query = $this->queryActiveWithUserOrderByDate();

11. return $query->paginate($n);

12. }

Le nombre de pages à afficher est passé en paramètre.

On fait appel dans le repository à une fonction privée :

1. /**

2. * Create a query for Post.

3. *

4. * @return Illuminate\Database\Eloquent\Builder

5. */

6. private function queryActiveWithUserOrderByDate()

7. {

8. return $this->model

9. ->select('id', 'created_at', 'updated_at', 'title', 'slug', 'user_id', 'summary')

10. ->whereActive(true)

11. ->with('user')

12. ->latest();

13. }

On récupère ici les articles actifs classés par dates et leurs auteurs. Le contrôleur envoie ensuite tout ça, accompagné des liens de pagination à la vue :

Les articles sont générés dans une boucle :

1. @foreach($posts as $post)

2. <div class="box">

3. <div class="col-lg-12 text-center">

4. <h2>{{ $post->title }}

5. <br>

6. <small>{{ $post->user->username }} {{ trans('front/blog.on') }} {!! $post->created_at . ($post->created_at != $post->updated_at ? trans('front/blog.updated') . $post->updated_at : '') !!}</small>

7. </h2>

8. </div>

9. <div class="col-lg-12">

10. <p>{!! $post->summary !!}</p>

11. </div>

12. <div class="col-lg-12 text-center">

13. {!! link_to('blog/' . $post->slug, trans('front/blog.button'), ['class' => 'btn btn-default btn-lg']) !!}

14. <hr>

15. </div>

16. </div>

17. @endforeach

II - Affichage d'un article

Lorsqu'on clique sur le bouton En lire plus on affiche l'article :

C'est la méthode show du contrôleur BlogController qui est chargée de cet affichage :

1. /**

2. * Display the specified resource.

3. *

4. * @param  Illuminate\Contracts\Auth\Guard $auth

5. * @param  string $slug

6. * @return Response

7. */

8. public function show(

9. Guard $auth,

10. $slug)

11. {

12. $user = $auth->user();

14. return view('front.blog.show',  array_merge($this->blog_gestion->show($slug), compact('user')));

15. }

On a besoin de connaître l'utilisateur actuel pour une bonne gestion des commentaires.

C'est la méthode show du repository BlogRepository qui est appelée avec transmission du slug de l'article :

1. /**

2. * Get post collection.

3. *

4. * @param  string  $slug

5. * @return array

6. */

7. public function show($slug)

8. {

9. $post = $this->model->with('user', 'tags')->whereSlug($slug)->firstOrFail();

11. $comments = $this->comment

12. ->wherePost_id($post->id)

13. ->with('user')

14. ->whereHas('user', function($q) { $q->whereValid(true); })

15. ->get();

17. return compact('post', 'comments');

18. }

Ici on récupère l'article, accompagné de son auteur et des tags. On charge aussi les commentaires correspondants et on envoie tout ça au contrôleur qui lui les envoie dans la vue :

Voici le code de l'affichage hors commentaires  :

1. <div class="row">

2. <div class="box">

3. <div class="col-lg-12">

4. <hr>

5. <h2 class="text-center">{{ $post->title }}

6. <br>

7. <small>{{ $post->user->username }} {{ trans('front/blog.on') }} {!! $post->created_at . ($post->created_at != $post->updated_at ? trans('front/blog.updated') . $post->updated_at : '') !!}</small>

8. </h2>

9. <hr>

10. {!! $post->summary !!}<br>

11. {!! $post->content !!}

12. <hr>

13. @if($post->tags->count())

14. <div class="text-center">

15. @if($post->tags->count() > 0)

16. <small>{{ trans('front/blog.tags') }}</small>

17. @foreach($post->tags as $tag)

18. {!! link_to('blog/tag?tag=' . $tag->id, $tag->tag, ['class' => 'btn btn-default btn-xs']) !!}

19. @endforeach

20. @endif

21. </div>

22. @endif

23. </div>

24. </div>

25. </div>

III - Les tags

Lorsqu'on clique sur un bouton de tag, on doit afficher tous les articles qui correspondent à ce tag :

C'est la méthode tag du contrôleur BlogController qui est chargée de cet affichage :

1. /**

2. * Get tagged posts

3. *

4. * @param  Illuminate\Http\Request $request

5. * @return Response

6. */

7. public function tag(Request $request)

8. {

9. $tag = $request->input('tag');

10. $posts = $this->blog_gestion->indexTag($this->nbrPages, $tag);

11. $links = $posts->setPath('')->appends(compact('tag'))->render();

12. $info = trans('front/blog.info-tag') . '<strong>' . $this->blog_gestion->getTagById($tag) . '</strong>';

14. return view('front.blog.index', compact('posts', 'links', 'info'));

15. }

L'index du tag est récupéré dans la requête qu'on injecte dans la méthode. Pour récupérer les articles, on utilise la méthode indexTag du repository BlogRepository :

1. /**

2. * Get post collection.

3. *

4. * @param  int  $n

5. * @param  int  $id

6. * @return Illuminate\Support\Collection

7. */

8. public function indexTag($n, $id)

9. {

10. $query = $this->queryActiveWithUserOrderByDate();

12. return $query->whereHas('tags', function($q) use($id) { $q->where('tags.id', $id); })

13. ->paginate($n);

14. }

Cette méthode ressemble beaucoup à celle qu'on a vue pour l'affichage des articles (indexFront) puisqu'on fait appel à la même fonction privée queryActiveWithUserOrderByDate. La différence réside dans le fait qu'on va limiter les articles à ceux qui possèdent le tag.

On a également besoin dans la vue du nom du tag pour la barre d'information :

C'est la méthode getTagById du repository BlogRepository qui nous le donne :

1. /**

2. * Get tag name by id.

3. *

4. * @param  int  $tag_id

5. * @return string

6. */

7. public function getTagById($tag_id)

8. {

9. return $this->tag->findOrFail($tag_id)->tag;

10. }

Le contrôleur envoie toutes les informations à la même vue que celle que nous avons vue ci-dessus pour l'affichage classique des articles, mais en transmettant en plus l'information pour la barre :

return view('front.blog.index', compact('posts', 'links', 'info'));

C'est au niveau du template (resources/views/front/template.blade.php) que s'effectue cet affichage :

1. <main role="main" class="container">

2. @if(session()->has('ok'))

3. @include('partials/error', ['type' => 'success', 'message' => session('ok')])

4. @endif

5. @if(isset($info))

6. @include('partials/error', ['type' => 'info', 'message' => $info])

7. @endif

8. @yield('main')

9. </main>

IV - La recherche

Il est prévu un champ de saisie pour la recherche dans les articles :

C'est la méthode search du contrôleur BlogController qui est chargée de cet affichage :

1. /**

2. * Find search in blog

3. *

4. * @param  App\Http\Requests\SearchRequest $request

5. * @return Response

6. */

7. public function search(SearchRequest $request)

8. {

9. $search = $request->input('search');

10. $posts = $this->blog_gestion->search($this->nbrPages, $search);

11. $links = $posts->setPath('')->appends(compact('search'))->render();

12. $info = trans('front/blog.info-search') . '<strong>' . $search . '</strong>';

14. return view('front.blog.index', compact('posts', 'links', 'info'));

15. }

Elle ressemble évidemment beaucoup à la méthode tag vue ci-dessus.

La validation est assurée par la requête de formulaire SearchRequest avec des règles simples :

1. <?php namespace App\Http\Requests;

3. class SearchRequest extends Request {

5. /**

6. * Get the validation rules that apply to the request.

7. *

8. * @return array

9. */

10. public function rules()

11. {

12. return [

13. 'search' => 'required|max:100',

14. ];

15. }

17. }

C'est la méthode search du repository BlogRepository qui est appelée par le contrôleur :

1. /**

2. * Get search collection.

3. *

4. * @param  int  $n

5. * @param  string  $search

6. * @return Illuminate\Support\Collection

7. */

8. public function search($n, $search)

9. {

10. $query = $this->queryActiveWithUserOrderByDate();

12. return $query->where(function($q) use ($search) {

13. $q->where('summary', 'like', "%$search%")

14. ->orWhere('content', 'like', "%$search%");

15. })->paginate($n);

16. }

On utilise à nouveau la fonction privée queryActiveWithUserOrderByDate. Ensuite on sélectionne les articles avec la recherche passée en paramètre. On applique enfin la pagination.

Le retour par le contrôleur est exactement le même que pour les tags :

return view('front.blog.index', compact('posts', 'links', 'info'));

En effet c'est la même vue et on envoie un message pour la barre :

V - Les commentaires

V-A - Affichage

Les articles sont affichés avec une zone de commentaire dans leur partie inférieure :

On a vu ci-dessus que c'est la méthode show du repository BlogRepository qui récupère les commentaires dans la base pour l'article.

Au niveau de la vue (resources/views/front/blog/show.blade.php) ils sont générés dans une boucle :

1. @if($comments->count())

2. @foreach($comments as $comment)

3. <div class="commentitem">

4. <h3>

5. <small>{{ $comment->user->username . ' ' . trans('front/blog.on') . ' ' . $comment->created_at }}</small>

6. @if($user && $user->username == $comment->user->username)

7. <a id="deletecomment{!! $comment->id !!}" href="#" class="deletecomment"><span class="fa fa-fw fa-trash pull-right" data-toggle="tooltip" data-placement="left" title="{{ trans('front/blog.delete') }}"></span></a>

8. <a id="comment{!! $comment->id !!}" href="#" class="editcomment"><span class="fa fa-fw fa-pencil pull-right" data-toggle="tooltip" data-placement="left" title="{{ trans('front/blog.edit') }}"></span></a>

9. @endif

10. </h3>

11. <div id="contenu{!! $comment->id !!}">{!! $comment->content !!}</div>

12. <hr>

13. </div>

14. @endforeach

15. @endif

D'autre part si l'utilisateur est authentifié, on génère aussi un formulaire :

1. <div class="row" id="formcreate">

2. @if(session()->has('warning'))

3. @include('partials/error', ['type' => 'warning', 'message' => session('warning')])

4. @endif

5. @if(session('statut') != 'visitor')

6. {!! Form::open(['url' => 'comment']) !!}

7. {!! Form::hidden('post_id', $post->id) !!}

8. {!! Form::control('textarea', 12, 'comments', $errors, trans('front/blog.comment')) !!}

9. {!! Form::submit(trans('front/form.send'), ['col-lg-12']) !!}

10. {!! Form::close() !!}

11. @else

12. <div class="text-center"><i class="text-center">{{ trans('front/blog.info-comment') }}</i></div>

13. @endif

14. </div>

S'il n'est pas authentifié, il a à la place un petit message :

V-B - Soumission

C'est la méthode store du contrôleur CommentController qui est chargée de gérer la soumission d'un commentaire :

1. /**

2. * Store a newly created resource in storage.

3. *

4. * @param  App\requests\CommentRequest $request

5. * @return Response

6. */

7. public function store(

8. CommentRequest $request)

9. {

10. $this->comment_gestion->store($request->all(), $request->user()->id);

12. if($request->user()->valid)

13. {

14. return redirect()->back();

15. }

17. return redirect()->back()->with('warning', trans('front/blog.warning'));

18. }

La validation est assurée par la requête de formulaire CommentRequest :

1. <?php namespace App\Http\Requests;

3. class CommentRequest extends Request {

5. /**

6. * Get the validation rules that apply to the request.

7. *

8. * @return array

9. */

10. public function rules()

11. {

12. $id = $this->comment;

13. return [

14. 'comments' . $id => 'required|max:65000',

15. ];

16. }

18. }

Le contrôleur appelle la méthode store du repository CommentRepository :

1. /**

2. * Store a comment.

3. *

4. * @param  array $inputs

5. * @param  int   $user_id

6. * @return void

7. */

8. public function store($inputs, $user_id)

9. {

10. $comment = new $this->model;

12. $comment->content = $inputs['comments'];

13. $comment->post_id = $inputs['post_id'];

14. $comment->user_id = $user_id;

16. $comment->save();

17. }

Le contrôleur renvoie alors la même page, avec le commentaire créé et un message si l'utilisateur n'a pas encore été validé pour les commentaires :

C'est cette partie de la vue (resources/views/front/blog/show.blade.php) qui gère ce commentaire :

1. @if(session()->has('warning'))

2. @include('partials/error', ['type' => 'warning', 'message' => session('warning')])

3. @endif

Et évidemment en cas de problème de validation c'est signalé à l'utilisateur :

V-C - Suppression

Un utilisateur peut supprimer son commentaire. Il dispose pour cela d'une icône représentant une poubelle :

Évidemment ces icônes n'apparaissent que si l'utilisateur connecté est l'auteur du commentaire :

1. @if($user && $user->username == $comment->user->username)

2. <a id="deletecomment{!! $comment->id !!}" href="#" class="deletecomment"><span class="fa fa-fw fa-trash pull-right" data-toggle="tooltip" data-placement="left" title="{{ trans('front/blog.delete') }}"></span></a>

3. <a id="comment{!! $comment->id !!}" href="#" class="editcomment"><span class="fa fa-fw fa-pencil pull-right" data-toggle="tooltip" data-placement="left" title="{{ trans('front/blog.edit') }}"></span></a>

4. @endif

La requête est envoyée en Ajax avec ce code :

1. // Delete comment

2. $('a.deletecomment').click(function(e) {

3. e.preventDefault();

4. if (!confirm('{{ trans('front/blog.confirm') }}')) return;

5. var i = $(this).attr('id').substring(13);

6. var token = $('input[name="_token"]').val();

7. $(this).replaceWith('<i class="fa fa-refresh fa-spin pull-right"></i>');

8. $.ajax({

9. method: 'delete',

10. url: '{!! url('comment') !!}' + '/' + i,

11. data: '_token=' + token

12. })

13. .done(function(data) {

14. $('#comment' + data.id).parents('.commentitem').remove();

15. })

16. .fail(function() {

17. alert('{{ trans('front/blog.fail-delete') }}');

18. });

19. });

C'est la méthode destroy du contrôleur CommentController qui est chargée de gérer la suppression d'un commentaire :

1. /**

2. * Remove the specified resource from storage.

3. *

4. * @param  Illuminate\Http\Request $request

5. * @param  int  $id

6. * @return Response

7. */

8. public function destroy(

9. Request $request,

10. $id)

11. {

12. $this->comment_gestion->destroy($id);

14. if($request->ajax())

15. {

16. return response()->json(['id' => $id]);

17. }

19. return redirect('comment');

20. }

On verra que cette méthode est aussi utilisée par le back-end sans Ajax. D'où la présence d'un test de la requête.

Cette méthode est protégée par le middleware auth au niveau du constructeur :

$this->middleware('auth', ['only' => ['store', 'update', 'destroy']]);

Par contre, je n'ai jugé utile de vérifier qu'il s'agit réellement de l'auteur du commentaire.

C'est la méthode destroy du repository de base BaseRepository qui effectue la suppression dans la base :

1. /**

2. * Destroy a model.

3. *

4. * @param  int $id

5. * @return void

6. */

7. public function destroy($id)

8. {

9. $this->getById($id)->delete();

10. }

V-D - Modification

Voyons maintenant la partie la plus délicate qui concerne la modification d'un commentaire. Délicate parce qu'il faut :

- générer dynamiquement un formulaire ;

- donner la possibilité d'annuler l'action ;

- gérer les erreurs de saisie avec forcément une requête en Ajax ;

- ne pas mélanger les formulaires de la page.

Pour modifier un article, l'utilisateur a un bouton à disposition :

Il obtient ainsi un formulaire :

Il conserve la possibilité de supprimer son commentaire avec la petite poubelle. Il peut aussi annuler l'action avec le bouton « Annuler ». Il peut enfin soumettre le formulaire avec le bouton « Valider ».

Tout cela est évidemment géré côté client en JavaScript :

1. // Set comment edition

2. $('a.editcomment').click(function(e) {

3. e.preventDefault();

4. $(this).hide();

5. var i = $(this).attr('id').substring(7);

6. var existing = $('#contenu' + i).html();

7. var url = $('#formcreate').find('form').attr('action');

8. jQuery.data(document.body, 'comment' + i, existing);

9. var html = "<div class='row'><form id='form" + i + "' method='POST' action='" + url + '/' + i + "' accept-charset='UTF-8' class='formajax'><input name='_token' type='hidden' value='" + $('input[name="_token"]').val() + "'><div class='form-group col-lg-12 '><label for='comments' class='control-label'>{{ trans('front/blog.change') }}</label><textarea id='cont" + i +"' class='form-control' name='comments" + i + "' cols='50' rows='10' id='comments" + i + "'>" + existing + "</textarea><small class='help-block'></small></div><div class='form-group col-lg-12'>" + buttons(i) + "</div>";

10. $('#contenu' + i).html(html);

11. CKEDITOR.replace('comments' + i, {

12. language: '{{ config('app.locale') }}',

13. height: 200,

14. toolbarGroups: [

15. { name: 'basicstyles', groups: [ 'basicstyles'] },

16. { name: 'links' },

17. { name: 'insert' }

18. ],

19. removeButtons: 'Table,SpecialChar,HorizontalRule,Anchor'

20. });

21. });

Je ne vais pas détailler le fonctionnement puisqu'il n'a rien à voir avec Laravel à ce niveau et pourrait être traité de manière différente, par exemple avec AngularJS. Par contre, on va s'intéresser à la partie soumission en Ajax parce qu'ici Laravel intervient.

C'est la méthode update du contrôleur CommentController qui est chargée de gérer la modification d'un commentaire :

1. /**

2. * Update the specified resource in storage.

3. *

4. * @param  App\requests\CommentRequest $request

5. * @param  int  $id

6. * @return Response

7. */

8. public function update(

9. CommentRequest $request,

10. $id)

11. {

12. $id = $request->segment(2);

13. $content = $request->input('comments' . $id);

14. $this->comment_gestion->updateContent($content, $id);

16. return response()->json(['id' => $id, 'content' => $content]);

17. }

On voit que la validation est réalisée par la requête de formulaire CommentRequest que nous avons déjà vue ci-dessus pour la création.

La soumission côté client est gérée par ce code JavaScript :

1. // Validation

2. $(document).on('submit', '.formajax', function(e) {

3. e.preventDefault();

4. var i = $(this).attr('id').substring(4);

5. $('#val' + i).parent().html('<i class="fa fa-refresh fa-spin fa-2x"></i>').addClass('text-center');

6. $.ajax({

7. method: 'put',

8. url: $(this).attr('action'),

9. data: $(this).serialize()

10. })

11. .done(function(data) {

12. $('#comment' + data.id).show();

13. $('#contenu' + data.id).html(data.content);

14. })

15. .fail(function(data) {

16. var errors = data.responseJSON;

17. $.each(errors, function(index, value) {

18. $('textarea[name="' + index + '"]' + ' ~ small').text(value);

19. $('textarea[name="' + index + '"]').parent().addClass('has-error');

20. $('.fa-spin').parent().html(buttons(index.slice(-1))).removeClass('text-center');

21. });

22. });

23. });

Si la validation est correcte, le contrôleur renvoie une réponse JSON en transmettant l'identifiant du commentaire et son contenu. On régénère le commentaire avec le nouveau contenu.

C'est la méthode updateContent du repository CommentRepository qui fait la mise à jour dans la base :

1. /**

2. * Update a comment.

3. *

4. * @param  string $commentaire

5. * @param  int    $id

6. * @return void

7. */

8. public function updateContent($content, $id)

9. {

10. $comment = $this->getById($id);

11. $comment->content = $content;

12. $comment->save();

13. }

Si la validation n'est pas correcte, il faut le signaler à l'utilisateur. Donc on récupère les erreurs (ici en fait une seule peut arriver) et on adapte le DOM en conséquence.

VI - Remerciements

Nous remercions Maurice Chavelli qui nous autorise à publier ce tutoriel.

Nous tenons également à remercier Winjerome pour la mise au gabarit et Claude Leloup pour la relecture orthographique.