Indentation + commentaires modèle Produit

common/models/Produit.php

@@ -54,21 +54,24 @@ use Yii;
  * @property double $poids
  * @property string $recette
  */
-class Produit extends \yii\db\ActiveRecord {
+class Produit extends \yii\db\ActiveRecord 
+{
 
     var $total = 0;
 
     /**
      * @inheritdoc
      */
-    public static function tableName() {
+    public static function tableName() 
+    {
         return 'produit';
     }
 
     /**
      * @inheritdoc
      */
-    public function rules() {
+    public function rules() 
+    {
         return [
             [['nom', 'id_etablissement'], 'required'],
             [['actif', 'order', 'quantite_max', 'id_etablissement'], 'integer'],
@@ -83,7 +86,8 @@ class Produit extends \yii\db\ActiveRecord {
     /**
      * @inheritdoc
      */
-    public function attributeLabels() {
+    public function attributeLabels() 
+    {
         return [
             'id' => 'ID',
             'nom' => 'Nom',
@@ -108,7 +112,13 @@ class Produit extends \yii\db\ActiveRecord {
         ];
     }
 
-    public function getDescription() {
+    /**
+     * Retourne la description du produit.
+     * 
+     * @return string
+     */
+    public function getDescription() 
+    {
         $description = $this->description;
         if (isset($this->poids) && is_numeric($this->poids) && $this->poids > 0) {
             if ($this->poids >= 1000) {
@@ -120,16 +130,35 @@ class Produit extends \yii\db\ActiveRecord {
         return $description;
     }
 
-    public function getLibelleAdmin() {
+    /**
+     * Retourne le libellé (admin) du produit.
+     * @return type
+     */
+    public function getLibelleAdmin() 
+    {
         return $this->nom;
     }
 
-    public function save($runValidation = true, $attributeNames = NULL) {
+    /**
+     * Enregistre le produit.
+     * 
+     * @param boolean $runValidation
+     * @param array $attributeNames
+     * @return boolean
+     */
+    public function save($runValidation = true, $attributeNames = NULL) 
+    {
         $this->id_etablissement = Yii::$app->user->identity->id_etablissement;
         return parent::save($runValidation, $attributeNames);
     }
 
-    public function getAll() {
+    /**
+     * Retourne les produits de l'établissement courant.
+     * 
+     * @return array
+     */
+    public function getAll() 
+    {
         return Produit::find()
             ->where([
                 'id_etablissement' => Yii::$app->user->identity->id_etablissement,
@@ -138,7 +167,14 @@ class Produit extends \yii\db\ActiveRecord {
             ->all();
     }
 
-    public function getByProduction($id_production) {
+    /**
+     * Retourne les produits d'une production donnée.
+     * 
+     * @param integer $id_production
+     * @return array
+     */
+    public function getByProduction($id_production) 
+    {
         return Produit::find()
             ->leftJoin('production_produit', 'produit.id = production_produit.id_produit')
             ->where([
@@ -149,7 +185,13 @@ class Produit extends \yii\db\ActiveRecord {
             ->all();
     }
 
-    public static function count() {
+    /**
+     * Retourne le nombre de produits du producteur courant.
+     * 
+     * @return integer
+     */
+    public static function count() 
+    {
         return Produit::find()
             ->where([
                 'id_etablissement' => Yii::$app->user->identity->id_etablissement