From bf09e4a0b947850e80c27c69e008b3175cafcb8a Mon Sep 17 00:00:00 2001
From: Laurent Destailleur <eldy@destailleur.fr>
Date: Fri, 6 May 2016 21:28:06 +0200
Subject: [PATCH] PHPdoc
---
.../mailing/class/advtargetemailing.class.php | 13 ++--
.../html.formadvtargetemailing.class.php | 5 +-
htdocs/websites/class/website.class.php | 59 +++++++++++++++----
3 files changed, 57 insertions(+), 20 deletions(-)
diff --git a/htdocs/comm/mailing/class/advtargetemailing.class.php b/htdocs/comm/mailing/class/advtargetemailing.class.php
index 599173a1869..62cf5f2436f 100644
--- a/htdocs/comm/mailing/class/advtargetemailing.class.php
+++ b/htdocs/comm/mailing/class/advtargetemailing.class.php
@@ -17,15 +17,14 @@
*/
/**
- * \file class/advtargetemailing.class.php
- * \ingroup advtargetemailing
+ * \file comm/mailing/class/advtargetemailing.class.php
+ * \ingroup mailing
* \brief This file is an example CRUD class file (Create/Read/Update/Delete)
-
*/
/**
- * Put your class' description here
+ * Class to manage advanced emailing target selector
*/
class AdvanceTargetingMailing extends CommonObject
{
@@ -293,7 +292,7 @@ class AdvanceTargetingMailing extends CommonObject
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/
- function update($user=0, $notrigger=0)
+ function update($user, $notrigger=0)
{
global $conf, $langs;
$error=0;
@@ -737,9 +736,9 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param string $column_to_test column to test
* @param string $criteria Use %% as magic caracters. For exemple to find all item like <b>jean, joe, jim</b>, you can input <b>j%%</b>, you can also use ; as separator for value,
- * and use ! for except this value.
+ * and use ! for except this value.
* For exemple jean;joe;jim%%;!jimo;!jima%> will target all jean, joe, start with jim but not jimo and not everythnig taht start by jima
- * @return int <0 if KO, >0 if OK
+ * @return string Sql to use for the where condition
*/
public function transformToSQL($column_to_test,$criteria) {
$return_sql_criteria = '(';
diff --git a/htdocs/comm/mailing/class/html.formadvtargetemailing.class.php b/htdocs/comm/mailing/class/html.formadvtargetemailing.class.php
index ac6b5727c58..8c2adbe08f8 100644
--- a/htdocs/comm/mailing/class/html.formadvtargetemailing.class.php
+++ b/htdocs/comm/mailing/class/html.formadvtargetemailing.class.php
@@ -17,8 +17,9 @@
*/
/**
- * \file advtargetemailing/class/html.formadvtragetemaling.class.php
- * \brief Fichier de la classe des fonctions predefinie de composants html advtargetemaling
+ * \file comm/mailing/class/html.formadvtragetemaling.class.php
+ * \ingroup mailing
+ * \brief Fichier de la classe des fonctions predefinie de composants html advtargetemaling
*/
/**
diff --git a/htdocs/websites/class/website.class.php b/htdocs/websites/class/website.class.php
index a82a0833aba..e87e830bb77 100644
--- a/htdocs/websites/class/website.class.php
+++ b/htdocs/websites/class/website.class.php
@@ -54,16 +54,37 @@ class Website extends CommonObject
public $lines = array();
/**
+ * @var int
*/
-
public $entity;
+ /**
+ * @var string
+ */
public $ref;
+ /**
+ * @var string
+ */
public $description;
+ /**
+ * @var int
+ */
public $status;
- public $date_creation = '';
- public $date_modification = '';
+ /**
+ * @var mixed
+ */
+ public $date_creation;
+ /**
+ * @var mixed
+ */
+ public $date_modification;
+ /**
+ * @var mixed
+ */
public $tms = '';
- public $fk_default_home;
+ /**
+ * @var integer
+ */
+ public $fk_default_home;
public $records;
/**
@@ -625,20 +646,36 @@ class WebsiteLine
*/
public $id;
/**
- * @var mixed Sample line property 1
+ * @var int
*/
-
public $entity;
+ /**
+ * @var string
+ */
public $ref;
+ /**
+ * @var string
+ */
public $description;
+ /**
+ * @var int
+ */
public $status;
+ /**
+ * @var int
+ */
public $fk_default_home;
- public $date_creation = '';
- public $date_modification = '';
- public $tms = '';
-
/**
- * @var mixed Sample line property 2
+ * @var mixed
+ */
+ public $date_creation;
+ /**
+ * @var mixed
+ */
+ public $date_modification;
+ /**
+ * @var mixed
*/
+ public $tms = '';
}
--
GitLab