Ajout commentaires + indentation controllers frontend

frontend/controllers/FrontendController.php

@@ -41,7 +41,8 @@ namespace frontend\controllers;
 use yii;
 use common\controllers\CommonController;
 
-class FrontendController extends CommonController {
+class FrontendController extends CommonController 
+{
     
 }
 

frontend/controllers/SiteController.php

@@ -63,12 +63,14 @@ use dosamigos\leaflet\widgets\Map;
 /**
  * Site controller
  */
-class SiteController extends FrontendController {
+class SiteController extends FrontendController 
+{
 
     /**
      * @inheritdoc
      */
-    public function behaviors() {
+    public function behaviors() 
+    {
         return [
             'access' => [
                 'class' => AccessControl::className(),
@@ -98,7 +100,8 @@ class SiteController extends FrontendController {
     /**
      * @inheritdoc
      */
-    public function actions() {
+    public function actions() 
+    {
         return [
             'captcha' => [
                 'class' => 'yii\captcha\CaptchaAction',
@@ -107,6 +110,11 @@ class SiteController extends FrontendController {
         ];
     }
     
+    /**
+     * Affiche la page d'erreur.
+     * 
+     * @return mixed
+     */
     public function actionError()
     {
         $exception = Yii::$app->errorHandler->exception;
@@ -120,13 +128,23 @@ class SiteController extends FrontendController {
         }
     }
 
-    public function actionIndex() {
-
+    /**
+     * Affiche la page d'accueil.
+     * 
+     * @return mixed
+     */
+    public function actionIndex() 
+    {
         return $this->render('index');
     }
     
-    public function actionProducers() {
-        
+    /**
+     * Liste les producteurs utilisant la plateforme.
+     *  
+     * @return mixed
+     */
+    public function actionProducers() 
+    {    
         $data_provider_producers = new ActiveDataProvider([
             'query' => Etablissement::find()
                 ->where([
@@ -143,11 +161,23 @@ class SiteController extends FrontendController {
         ]);
     }
 
-    public function actionMentions() {
+    /**
+     * Affiche les mentions légales.
+     * 
+     * @return mixed
+     */
+    public function actionMentions() 
+    {
         return $this->render('mentions');
     }
 
-    public function actionLogin() {
+    /**
+     * Affiche la page de connexion et traite le formulaire de connexion.
+     * 
+     * @return mixed
+     */
+    public function actionLogin() 
+    {
         if (!\Yii::$app->user->isGuest) {
             return Yii::$app->getResponse()->redirect(['commande/index']);
         }
@@ -168,12 +198,24 @@ class SiteController extends FrontendController {
         }
     }
 
-    public function actionLogout() {
+    /**
+     * Déconnecte l'utilisateur.
+     * 
+     * @return mixed
+     */
+    public function actionLogout() 
+    {
         Yii::$app->user->logout();
         return $this->goHome();
     }
 
-    public function actionContact() {
+    /**
+     * Affiche la page de contact et traite le formulaire s'il est soumis.
+     * 
+     * @return mixed
+     */
+    public function actionContact() 
+    {
         $model = new ContactForm();
         if ($model->load(Yii::$app->request->post()) && $model->validate()) {
             if ($model->sendEmail(Yii::$app->params['adminEmail'])) {
@@ -190,12 +232,17 @@ class SiteController extends FrontendController {
         }
     }
 
-    public function actionSignup() {
+    /**
+     * Affiche la page d'inscription et traite son formulaire.
+     * 
+     * @return mixed
+     */
+    public function actionSignup() 
+    {
         $model = new SignupForm();
         if ($model->load(Yii::$app->request->post())) {
             if ($user = $model->signup()) {
                 if (Yii::$app->getUser()->login($user)) {
-
                     $this->redirect(['commande/index']);
                 }
             }
@@ -213,7 +260,14 @@ class SiteController extends FrontendController {
         ]);
     }
 
-    public function actionRequestPasswordReset() {
+    /**
+     * Affiche la page de demande de nouveau mot de passe.
+     * Traitement du formulaire.
+     * 
+     * @return mixed
+     */
+    public function actionRequestPasswordReset() 
+    {
         $model = new PasswordResetRequestForm();
         if ($model->load(Yii::$app->request->post()) && $model->validate()) {
             if ($model->sendEmail()) {
@@ -226,10 +280,17 @@ class SiteController extends FrontendController {
         }
 
         return $this->render('requestPasswordResetToken', [
-                    'model' => $model,
+            'model' => $model,
         ]);
     }
 
+    /**
+     * Met à jour le mot de passe de l'utilisateur.
+     * 
+     * @param string $token
+     * @return mixed
+     * @throws BadRequestHttpException
+     */
     public function actionResetPassword($token) {
         try {
             $model = new ResetPasswordForm($token);
@@ -244,19 +305,39 @@ class SiteController extends FrontendController {
         }
 
         return $this->render('resetPassword', [
-                    'model' => $model,
+            'model' => $model,
         ]);
     }
 
-    public function actionCgv() {
+    /**
+     * Affiche les conditions générale de service.
+     * 
+     * @return mixed
+     */
+    public function actionCgv() 
+    {
         return $this->render('cgv');
     }
 
-    public function actionCreditpain() {
+    /**
+     * Affiche les précisions concernant l'utilisation du crédit pain.
+     * @return type
+     */
+    public function actionCreditpain() 
+    {
         return $this->render('creditpain');
     }
     
-    public function actionProducerCode($id) {
+    /**
+     * Affiche le formulaire de demande de code pour accéder à certains
+     * producteurs.
+     * 
+     * @param integer $id
+     * @return mixed
+     * @throws \yii\web\HttpException
+     */
+    public function actionProducerCode($id) 
+    {
         
         $producer = Etablissement::findOne($id);
         if(!$producer)
@@ -276,7 +357,15 @@ class SiteController extends FrontendController {
         ]) ;
     }
 
-    public function actionProducer($id) {
+    /**
+     * Affiche la page de connexion / inscription  pour accéder notamment au 
+     * formulaire de commande des producteirs.
+     * 
+     * @param integer $id
+     * @return mixed
+     */
+    public function actionProducer($id) 
+    {
         $model_login = new LoginForm();
         $model_signup = new SignupForm();
         

frontend/controllers/UserController.php

@@ -50,9 +50,11 @@ use frontend\controllers\FrontendController;
 /**
  * UserController implements the CRUD actions for User model.
  */
-class UserController extends FrontendController {
+class UserController extends FrontendController 
+{
 
-    public function behaviors() {
+    public function behaviors() 
+    {
         return [
             'verbs' => [
                 'class' => VerbFilter::className(),
@@ -80,7 +82,8 @@ class UserController extends FrontendController {
      * @param integer $id
      * @return mixed
      */
-    public function actionUpdate() {
+    public function actionUpdate() 
+    {
         $model = $this->findModel(Yii::$app->user->identity->id);
 
         if ($model->load(Yii::$app->request->post()) && $model->validate()) {
@@ -118,12 +121,6 @@ class UserController extends FrontendController {
         }
     }
 
-    public function actionCredit() {
-
-        return $this->render('credit', [
-        ]);
-    }
-
     /**
      * Finds the User model based on its primary key value.
      * If the model is not found, a 404 HTTP exception will be thrown.
@@ -131,7 +128,8 @@ class UserController extends FrontendController {
      * @return User the loaded model
      * @throws NotFoundHttpException if the model cannot be found
      */
-    protected function findModel($id) {
+    protected function findModel($id) 
+    {
         if (($model = User::findOne($id)) !== null) {
             return $model;
         } else {

frontend/views/user/credit.php

@@ -1,65 +0,0 @@
-<?php
-
-/** 
-Copyright La boîte à pain (2018) 
-
-contact@laboiteapain.net
-
-Ce logiciel est un programme informatique servant à aider les producteurs 
-à distribuer leur production en circuits courts. 
-
-Ce logiciel est régi par la licence CeCILL soumise au droit français et
-respectant les principes de diffusion des logiciels libres. Vous pouvez
-utiliser, modifier et/ou redistribuer ce programme sous les conditions
-de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA 
-sur le site "http://www.cecill.info".
-
-En contrepartie de l'accessibilité au code source et des droits de copie,
-de modification et de redistribution accordés par cette licence, il n'est
-offert aux utilisateurs qu'une garantie limitée.  Pour les mêmes raisons,
-seule une responsabilité restreinte pèse sur l'auteur du programme,  le
-titulaire des droits patrimoniaux et les concédants successifs.
-
-A cet égard  l'attention de l'utilisateur est attirée sur les risques
-associés au chargement,  à l'utilisation,  à la modification et/ou au
-développement et à la reproduction du logiciel par l'utilisateur étant 
-donné sa spécificité de logiciel libre, qui peut le rendre complexe à 
-manipuler et qui le réserve donc à des développeurs et des professionnels
-avertis possédant  des  connaissances  informatiques approfondies.  Les
-utilisateurs sont donc invités à charger  et  tester  l'adéquation  du
-logiciel à leurs besoins dans des conditions permettant d'assurer la
-sécurité de leurs systèmes et ou de leurs données et, plus généralement, 
-à l'utiliser et l'exploiter dans les mêmes conditions de sécurité. 
-
-Le fait que vous puissiez accéder à cet en-tête signifie que vous avez 
-pris connaissance de la licence CeCILL, et que vous en avez accepté les
-termes.
-*/
-
-$this->title = 'Crédit' ;
-
-?>
-
-<h1>Crédit</h1>
-
-<p>Vous avez plusieurs manières de créditer votre compte.</p>
-
-<h2>À la boutique</h2>
-<p>Bla bla bla</p>
-
-<h2>Par carte bancaire via Paypal</h2>
-
-<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
-<input type="hidden" name="cmd" value="_s-xclick">
-<input type="hidden" name="hosted_button_id" value="KME2NU24R334A">
-<table>
-<tr><td><input type="hidden" name="on0" value="Montant du crédit pain">Montant du crédit pain</td></tr><tr><td><select name="os0">
-	<option value="10 crédits pains">10 crédits pains €10,00 EUR</option>
-	<option value="20 crédits pains">20 crédits pains €20,00 EUR</option>
-	<option value="50 crédits pains">50 crédits pains €50,00 EUR</option>
-</select> </td></tr>
-</table>
-<input type="hidden" name="currency_code" value="EUR">
-<input type="image" src="https://www.paypalobjects.com/fr_FR/FR/i/btn/btn_buynowCC_LG.gif" border="0" name="submit" alt="PayPal, le réflexe sécurité pour payer en ligne">
-<img alt="" border="0" src="https://www.paypalobjects.com/fr_FR/i/scr/pixel.gif" width="1" height="1">
-</form>