Mini Shell
<?php
/* Copyright (C) 2013-2014 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2014 Marcos García <marcosgdf@gmail.com>
* Copyright (C) 2020 Frédéric France <frederic.france@netlogic.fr>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* \file htdocs/opensurvey/class/opensurveysondage.class.php
* \ingroup opensurvey
* \brief This file is an example for a CRUD class file (Create/Read/Update/Delete)
* Initialy built by build_class_from_table on 2013-03-10 00:32
*/
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php";
//require_once DOL_DOCUMENT_ROOT."/societe/class/societe.class.php";
//require_once DOL_DOCUMENT_ROOT."/product/class/product.class.php";
/**
* Put here description of your class
*/
class Opensurveysondage extends CommonObject
{
/**
* @var string ID to identify managed object
*/
public $element = 'opensurvey_sondage';
/**
* @var string Name of table without prefix where object is stored
*/
public $table_element = 'opensurvey_sondage';
/**
* @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
*/
public $picto = 'poll';
/**
* @var string ID survey
*/
public $id_sondage;
/**
* @var string description
*/
public $description;
/**
* @var string email admin
*/
public $mail_admin;
/**
* @var string admin name
*/
public $nom_admin;
/**
* Id of user author of the poll
* @var int
*/
public $fk_user_creat;
/**
* @var string Title
*/
public $title;
public $date_fin = '';
public $date_m;
/**
* @var int status
*/
public $status = 1;
/**
* @var string format of survey
*/
public $format;
/**
* @var int mailsonde
*/
public $mailsonde;
/**
* @var string subject
*/
public $sujet;
/**
* @var int Allow comments on this poll
*/
public $allow_comments;
/**
* @var int Allow users see others vote
*/
public $allow_spy;
/**
* Draft status (not used)
*/
const STATUS_DRAFT = 0;
/**
* Validated/Opened status
*/
const STATUS_VALIDATED = 1;
/**
* Closed
*/
const STATUS_CLOSED = 2;
/**
* Constructor
*
* @param DoliDb $db Database handler
*/
public function __construct($db)
{
$this->db = $db;
}
/**
* Create object into database
*
* @param User $user User that creates
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = 0)
{
global $conf;
$error = 0;
// Clean parameters
$this->cleanParameters();
// Check parameters
if (!$this->date_fin > 0) {
$this->error = 'BadValueForEndDate';
dol_syslog(get_class($this)."::create ".$this->error, LOG_ERR);
return -1;
}
// Insert request
$sql = "INSERT INTO ".MAIN_DB_PREFIX."opensurvey_sondage(";
$sql .= "id_sondage,";
$sql .= "commentaires,";
$sql .= "fk_user_creat,";
$sql .= "titre,";
$sql .= "date_fin,";
$sql .= "status,";
$sql .= "format,";
$sql .= "mailsonde,";
$sql .= "allow_comments,";
$sql .= "allow_spy,";
$sql .= "sujet,";
$sql .= "entity";
$sql .= ") VALUES (";
$sql .= "'".$this->db->escape($this->id_sondage)."',";
$sql .= " ".(empty($this->description) ? 'NULL' : "'".$this->db->escape($this->description)."'").",";
$sql .= " ".(int) $user->id.",";
$sql .= " '".$this->db->escape($this->title)."',";
$sql .= " '".$this->db->idate($this->date_fin)."',";
$sql .= " ".(int) $this->status.",";
$sql .= " '".$this->db->escape($this->format)."',";
$sql .= " ".((int) $this->mailsonde).",";
$sql .= " ".((int) $this->allow_comments).",";
$sql .= " ".((int) $this->allow_spy).",";
$sql .= " '".$this->db->escape($this->sujet)."',";
$sql .= " ".((int) $conf->entity);
$sql .= ")";
$this->db->begin();
dol_syslog(get_class($this)."::create", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$error++; $this->errors[] = "Error ".$this->db->lasterror();
}
if (!$error && !$notrigger) {
global $langs, $conf;
// Call trigger
$result = $this->call_trigger('OPENSURVEY_CREATE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
dol_syslog(get_class($this)."::create ".$errmsg, LOG_ERR);
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return -1 * $error;
} else {
$this->db->commit();
return $this->id;
}
}
/**
* Load object in memory from the database
*
* @param int $id Id object
* @param string $numsurvey Ref of survey (admin or not)
* @return int <0 if KO, >0 if OK
*/
public function fetch($id, $numsurvey = '')
{
$sql = "SELECT";
$sql .= " t.id_sondage,";
$sql .= " t.titre as title,";
$sql .= " t.commentaires as description,";
$sql .= " t.mail_admin,";
$sql .= " t.nom_admin,";
$sql .= " t.fk_user_creat,";
$sql .= " t.date_fin,";
$sql .= " t.status,";
$sql .= " t.format,";
$sql .= " t.mailsonde,";
$sql .= " t.allow_comments,";
$sql .= " t.allow_spy,";
$sql .= " t.sujet,";
$sql .= " t.tms";
$sql .= " FROM ".MAIN_DB_PREFIX."opensurvey_sondage as t";
$sql .= " WHERE t.id_sondage = '".$this->db->escape($id ? $id : $numsurvey)."'";
dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
$resql = $this->db->query($sql);
if ($resql) {
if ($this->db->num_rows($resql)) {
$obj = $this->db->fetch_object($resql);
$this->id_sondage = $obj->id_sondage;
$this->ref = $this->id_sondage; //For compatibility
$this->description = $obj->description;
$this->mail_admin = $obj->mail_admin;
$this->nom_admin = $obj->nom_admin;
$this->title = $obj->title;
$this->date_fin = $this->db->jdate($obj->date_fin);
$this->status = $obj->status;
$this->format = $obj->format;
$this->mailsonde = $obj->mailsonde;
$this->allow_comments = $obj->allow_comments;
$this->allow_spy = $obj->allow_spy;
$this->sujet = $obj->sujet;
$this->fk_user_creat = $obj->fk_user_creat;
$this->date_m = $this->db->jdate(!empty($obj->tls) ? $obj->tls : "");
$ret = 1;
} else {
$sondage = ($id ? 'id='.$id : 'sondageid='.$numsurvey);
$this->error = 'Fetch no poll found for '.$sondage;
dol_syslog($this->error, LOG_ERR);
$ret = 0;
}
$this->db->free($resql);
} else {
$this->error = "Error ".$this->db->lasterror();
$ret = -1;
}
return $ret;
}
/**
* Update object into database
*
* @param User $user User that modifies
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/
public function update(User $user, $notrigger = 0)
{
global $conf, $langs;
$error = 0;
// Clean parameters
$this->cleanParameters();
// Check parameters
// Put here code to add a control on parameters values
// Update request
$sql = "UPDATE ".MAIN_DB_PREFIX."opensurvey_sondage SET";
$sql .= " id_sondage=".(isset($this->id_sondage) ? "'".$this->db->escape($this->id_sondage)."'" : "null").",";
$sql .= " commentaires=".(isset($this->description) ? "'".$this->db->escape($this->description)."'" : "null").",";
$sql .= " mail_admin=".(isset($this->mail_admin) ? "'".$this->db->escape($this->mail_admin)."'" : "null").",";
$sql .= " nom_admin=".(isset($this->nom_admin) ? "'".$this->db->escape($this->nom_admin)."'" : "null").",";
$sql .= " titre=".(isset($this->title) ? "'".$this->db->escape($this->title)."'" : "null").",";
$sql .= " date_fin=".(dol_strlen($this->date_fin) != 0 ? "'".$this->db->idate($this->date_fin)."'" : 'null').",";
$sql .= " status=".(isset($this->status) ? "'".$this->db->escape($this->status)."'" : "null").",";
$sql .= " format=".(isset($this->format) ? "'".$this->db->escape($this->format)."'" : "null").",";
$sql .= " mailsonde=".(isset($this->mailsonde) ? ((int) $this->mailsonde) : "null").",";
$sql .= " allow_comments=".((int) $this->allow_comments).",";
$sql .= " allow_spy=".((int) $this->allow_spy);
$sql .= " WHERE id_sondage='".$this->db->escape($this->id_sondage)."'";
$this->db->begin();
dol_syslog(get_class($this)."::update", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$error++;
$this->errors[] = "Error ".$this->db->lasterror();
}
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('OPENSURVEY_MODIFY', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
dol_syslog(get_class($this)."::update ".$errmsg, LOG_ERR);
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return -1 * $error;
} else {
$this->db->commit();
return 1;
}
}
/**
* Delete object in database
*
* @param User $user User that deletes
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @param string $numsondage Num sondage admin to delete
* @return int <0 if KO, >0 if OK
*/
public function delete(User $user, $notrigger = 0, $numsondage = '')
{
global $conf, $langs;
$error = 0;
if (empty($numsondage)) {
$numsondage = $this->id_sondage;
}
$this->db->begin();
if (!$error && !$notrigger) {
// Call trigger
$result = $this->call_trigger('OPENSURVEY_DELETE', $user);
if ($result < 0) {
$error++;
}
// End call triggers
}
if (!$error) {
$sql = 'DELETE FROM '.MAIN_DB_PREFIX."opensurvey_comments WHERE id_sondage = '".$this->db->escape($numsondage)."'";
dol_syslog(get_class($this)."::delete", LOG_DEBUG);
$resql = $this->db->query($sql);
$sql = 'DELETE FROM '.MAIN_DB_PREFIX."opensurvey_user_studs WHERE id_sondage = '".$this->db->escape($numsondage)."'";
dol_syslog(get_class($this)."::delete", LOG_DEBUG);
$resql = $this->db->query($sql);
$sql = "DELETE FROM ".MAIN_DB_PREFIX."opensurvey_sondage";
$sql .= " WHERE id_sondage = '".$this->db->escape($numsondage)."'";
dol_syslog(get_class($this)."::delete", LOG_DEBUG);
$resql = $this->db->query($sql);
if (!$resql) {
$error++; $this->errors[] = "Error ".$this->db->lasterror();
}
}
// Commit or rollback
if ($error) {
foreach ($this->errors as $errmsg) {
dol_syslog(get_class($this)."::delete ".$errmsg, LOG_ERR);
$this->error .= ($this->error ? ', '.$errmsg : $errmsg);
}
$this->db->rollback();
return -1 * $error;
} else {
$this->db->commit();
return 1;
}
}
/**
* Return a link to the object card (with optionaly the picto)
*
* @param int $withpicto Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
* @param int $notooltip 1=Disable tooltip
* @param string $morecss Add more css on link
* @param int $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
* @return string String with URL
*/
public function getNomUrl($withpicto = 0, $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
{
global $db, $conf, $langs;
global $dolibarr_main_authentication, $dolibarr_main_demo;
global $menumanager;
if (!empty($conf->dol_no_mouse_hover)) {
$notooltip = 1; // Force disable tooltips
}
$result = '';
$label = img_picto('', $this->picto).' <u>'.$langs->trans("ShowSurvey").'</u>';
$label .= '<br>';
$label .= '<b>'.$langs->trans('Ref').':</b> '.$this->ref.'<br>';
$label .= '<b>'.$langs->trans('Title').':</b> '.$this->title.'<br>';
$url = DOL_URL_ROOT.'/opensurvey/card.php?id='.$this->id;
// Add param to save lastsearch_values or not
$add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
$add_save_lastsearch_values = 1;
}
if ($add_save_lastsearch_values) {
$url .= '&save_lastsearch_values=1';
}
$linkclose = '';
if (empty($notooltip)) {
if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
$label = $langs->trans("ShowMyObject");
$linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
}
$linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
$linkclose .= ' class="classfortooltip'.($morecss ? ' '.$morecss : '').'"';
} else {
$linkclose = ($morecss ? ' class="'.$morecss.'"' : '');
}
$linkstart = '<a href="'.$url.'"';
$linkstart .= $linkclose.'>';
$linkend = '</a>';
$result .= $linkstart;
if ($withpicto) {
$result .= img_object(($notooltip ? '' : $label), $this->picto, ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
}
if ($withpicto != 2) {
$result .= $this->ref;
}
$result .= $linkend;
return $result;
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
/**
* Return array of lines
*
* @return int <0 if KO, >0 if OK
*/
public function fetch_lines()
{
// phpcs:enable
$this->lines = array();
$sql = "SELECT id_users, nom as name, reponses";
$sql .= " FROM ".MAIN_DB_PREFIX."opensurvey_user_studs";
$sql .= " WHERE id_sondage = '".$this->db->escape($this->id_sondage)."'";
$resql = $this->db->query($sql);
if ($resql) {
$num = $this->db->num_rows($resql);
$i = 0;
while ($i < $num) {
$obj = $this->db->fetch_object($resql);
$tmp = array('id_users'=>$obj->id_users, 'nom'=>$obj->name, 'reponses'=>$obj->reponses);
$this->lines[] = $tmp;
$i++;
}
} else {
dol_print_error($this->db);
}
return count($this->lines);
}
/**
* Initialise object with example values
* Id must be 0 if object instance is a specimen
*
* @return void
*/
public function initAsSpecimen()
{
$this->id = 0;
$this->id_sondage = 'a12d5g';
$this->description = 'Description of the specimen survey';
$this->mail_admin = 'email@email.com';
$this->nom_admin = 'surveyadmin';
$this->title = 'This is a specimen survey';
$this->date_fin = dol_now() + 3600 * 24 * 10;
$this->status = 1;
$this->format = 'classic';
$this->mailsonde = 0;
}
/**
* Returns all comments for the current opensurvey poll
*
* @return Object[]
*/
public function getComments()
{
$comments = array();
$sql = 'SELECT id_comment, usercomment, comment';
$sql .= ' FROM '.MAIN_DB_PREFIX.'opensurvey_comments';
$sql .= " WHERE id_sondage='".$this->db->escape($this->id_sondage)."'";
$sql .= " ORDER BY id_comment";
$resql = $this->db->query($sql);
if ($resql) {
$num_rows = $this->db->num_rows($resql);
if ($num_rows > 0) {
while ($obj = $this->db->fetch_object($resql)) {
$comments[] = $obj;
}
}
}
return $comments;
}
/**
* Adds a comment to the poll
*
* @param string $comment Comment content
* @param string $comment_user Comment author
* @param string $user_ip Comment author IP
* @return boolean False in case of the query fails, true if it was successful
*/
public function addComment($comment, $comment_user, $user_ip = '')
{
$now = dol_now();
$sql = "INSERT INTO ".MAIN_DB_PREFIX."opensurvey_comments (id_sondage, comment, usercomment, date_creation, ip)";
$sql .= " VALUES ('".$this->db->escape($this->id_sondage)."','".$this->db->escape($comment)."','".$this->db->escape($comment_user)."','".$this->db->idate($now)."'".($user_ip ? ",'".$this->db->escape($user_ip)."'" : '').")";
$resql = $this->db->query($sql);
if (!$resql) {
return false;
}
return true;
}
/**
* Deletes a comment of the poll
*
* @param int $id_comment Id of the comment
* @return boolean False in case of the query fails, true if it was successful
*/
public function deleteComment($id_comment)
{
$sql = 'DELETE FROM '.MAIN_DB_PREFIX.'opensurvey_comments WHERE id_comment = '.((int) $id_comment).' AND id_sondage = "'.$this->db->escape($this->id_sondage).'"';
$resql = $this->db->query($sql);
if (!$resql) {
return false;
}
return true;
}
/**
* Cleans all the class variables before doing an update or an insert
*
* @return void
*/
private function cleanParameters()
{
$this->id_sondage = trim($this->id_sondage);
$this->description = trim($this->description);
$this->mail_admin = trim($this->mail_admin);
$this->nom_admin = trim($this->nom_admin);
$this->title = trim($this->title);
$this->status = (int) $this->status;
$this->format = trim($this->format);
$this->mailsonde = ($this->mailsonde ? 1 : 0);
$this->allow_comments = ($this->allow_comments ? 1 : 0);
$this->allow_spy = ($this->allow_spy ? 1 : 0);
$this->sujet = trim($this->sujet);
}
/**
* Return status label of Order
*
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
* @return string Libelle
*/
public function getLibStatut($mode)
{
return $this->LibStatut($this->status, $mode);
}
// phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
/**
* Return label of status
*
* @param int $status Id statut
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
* @return string Label of status
*/
public function LibStatut($status, $mode)
{
// phpcs:enable
global $langs, $conf;
if (empty($this->labelStatus) || empty($this->labelStatusShort)) {
global $langs;
//$langs->load("mymodule");
$this->labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
$this->labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Opened');
$this->labelStatus[self::STATUS_CLOSED] = $langs->transnoentitiesnoconv('Closed');
$this->labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
$this->labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Opened');
$this->labelStatusShort[self::STATUS_CLOSED] = $langs->transnoentitiesnoconv('Closed');
}
$statusType = 'status'.$status;
if ($status == self::STATUS_VALIDATED) {
if (0) {
$statusType = 'status1';
} else {
$statusType = 'status4';
}
}
if ($status == self::STATUS_CLOSED) {
$statusType = 'status6';
}
return dolGetStatus($this->labelStatus[$status], $this->labelStatusShort[$status], '', $statusType, $mode);
}
/**
* Return number of votes done for this survey.
*
* @return int Number of votes
*/
public function countVotes()
{
$result = 0;
$sql = " SELECT COUNT(id_users) as nb FROM ".MAIN_DB_PREFIX."opensurvey_user_studs";
$sql .= " WHERE id_sondage = '".$this->db->escape($this->ref)."'";
$resql = $this->db->query($sql);
if ($resql) {
$obj = $this->db->fetch_object($resql);
if ($obj) {
$result = $obj->nb;
}
} else {
$this->error = $this->db->lasterror();
$this->errors[] = $this->error;
}
return $result;
}
}
Zerion Mini Shell 1.0