lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Qual: PHP5 OOP, commented and typehinted class template

Browse Source
This commit is contained in:
Raphaël Doursenaud 2015-06-03 17:31:42 +02:00
parent f7eaf35d30
commit aa9f0965c0
1 changed files with 352 additions and 295 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

341
dev/skeletons/skeleton_class.class.php
View File

@ -2,6 +2,7 @@
/* Copyright (C) 2007-2012 Laurent Destailleur <eldy@users.sourceforge.net> /* Copyright (C) 2007-2012 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2014 Juanjo Menent <jmenent@2byte.es> * Copyright (C) 2014 Juanjo Menent <jmenent@2byte.es>
* Copyright (C) 2015 Florian Henry <florian.henry@open-concept.pro> * Copyright (C) 2015 Florian Henry <florian.henry@open-concept.pro>
* Copyright (C) 2015 Raphaël Doursenaud <rdoursenaud@gpcsolutions.fr>
* Copyright (C) ---Put here your own copyright and developer email--- * Copyright (C) ---Put here your own copyright and developer email---
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -22,89 +23,126 @@
* \file dev/skeletons/skeleton_class.class.php * \file dev/skeletons/skeleton_class.class.php
* \ingroup mymodule othermodule1 othermodule2 * \ingroup mymodule othermodule1 othermodule2
* \brief This file is an example for a CRUD class file (Create/Read/Update/Delete) * \brief This file is an example for a CRUD class file (Create/Read/Update/Delete)
* Put here some comments * Put some comments here
*/ */
// Put here all includes required by your class file // Put here all includes required by your class file
require_once(DOL_DOCUMENT_ROOT."/core/class/commonobject.class.php"); 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 . '/societe/class/societe.class.php';
//require_once(DOL_DOCUMENT_ROOT."/product/class/product.class.php"); //require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';
/** /**
* Class Skeleton_Class
*
* Put here description of your class * Put here description of your class
*/ */
class Skeleton_Class extends CommonObject class Skeleton_Class extends CommonObject
{ {
var $db; //!< To store db handler /**
var $error; //!< To return error code (or message) * @var DoliDb Database handler
var $errors=array(); //!< To return several error codes (or messages) */
var $element='skeleton'; //!< Id that identify managed objects protected $db;
var $table_element='skeleton'; //!< Name of table without prefix where object is stored
var $lines=array(); /**
* @var string Error code (or message)
* @deprecated
* @see Skeleton_Class::errors
*/
public $error;
/**
* @var string[] Error codes (or messages)
*/
public $errors = array();
/**
* @var string Id to identify managed objects
*/
public $element = 'skeleton';
/**
* @var string Name of table without prefix where object is stored
*/
public $table_element = 'skeleton';
var $id; /**
var $prop1; * @var Skeleton_ClassLine[] Lines
var $prop2; */
public $lines = array();
/**
* @var int ID
*/
public $id;
/**
* @var mixed Sample property 1
*/
public $prop1;
/**
* @var mixed Sample property 2
*/
public $prop2;
//... //...
/** /**
* Constructor * Constructor
* *
* @param DoliDb $db Database handler * @param DoliDb $db Database handler
*/ */
function __construct($db) public function __construct( DoliDB $db )
{ {
$this->db = $db; $this->db = $db;
return 1; return 1;
} }
/** /**
* Create object into database * Create object into database
* *
* @param User $user User that creates * @param User $user User that creates
* @param int $notrigger 0=launch triggers after, 1=disable triggers * @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, Id of created object if OK * @return int <0 if KO, Id of created object if OK
*/ */
function create($user, $notrigger=0) public function create( User $user, $notrigger = false )
{ {
global $conf, $langs; dol_syslog( __METHOD__, LOG_DEBUG );
$error = 0; $error = 0;
// Clean parameters // Clean parameters
if (isset($this->prop1)) $this->prop1=trim($this->prop1); if (isset( $this->prop1 )) {
if (isset($this->prop2)) $this->prop2=trim($this->prop2); $this->prop1 = trim( $this->prop1 );
}
if (isset( $this->prop2 )) {
$this->prop2 = trim( $this->prop2 );
}
//... //...
// Check parameters // Check parameters
// Put here code to add control on parameters values // Put here code to add control on parameters values
// Insert request // Insert request
$sql = "INSERT INTO ".MAIN_DB_PREFIX.$this->table_element."("; $sql = 'INSERT INTO ' . MAIN_DB_PREFIX . $this->table_element . '(';
$sql.= " field1,"; $sql .= ' field1,';
$sql.= " field2"; $sql .= ' field2';
//... //...
$sql.= ") VALUES ("; $sql .= ') VALUES (';
$sql.= " '".$this->prop1."',"; $sql .= ' \'' . $this->prop1 . '\',';
$sql.= " '".$this->prop2."'"; $sql .= ' \'' . $this->prop2 . '\'';
//... //...
$sql.= ")"; $sql .= ')';
$this->db->begin(); $this->db->begin();
dol_syslog(__METHOD__, LOG_DEBUG);
$resql = $this->db->query( $sql ); $resql = $this->db->query( $sql );
if (! $resql) { $error++; $this->errors[]="Error ".$this->db->lasterror(); } if (!$resql) {
$error ++;
$this->errors[] = 'Error ' . $this->db->lasterror();
dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
}
if (! $error) if (!$error) {
{
$this->id = $this->db->last_insert_id( MAIN_DB_PREFIX . $this->table_element ); $this->id = $this->db->last_insert_id( MAIN_DB_PREFIX . $this->table_element );
if (! $notrigger) if (!$notrigger) {
{
// Uncomment this and change MYOBJECT to your own tag if you // Uncomment this and change MYOBJECT to your own tag if you
// want this action to call a trigger. // want this action to call a trigger.
@ -116,45 +154,45 @@ class Skeleton_Class extends CommonObject
} }
// Commit or rollback // Commit or rollback
if ($error) if ($error) {
{
$this->db->rollback(); $this->db->rollback();
return - 1 * $error; return - 1 * $error;
} } else {
else
{
$this->db->commit(); $this->db->commit();
return $this->id; return $this->id;
} }
} }
/** /**
* Load object in memory from the database * Load object in memory from the database
* *
* @param int $id Id object * @param int $id Id object
* @param string $ref Ref * @param string $ref Ref
*
* @return int <0 if KO, 0 if not found, >0 if OK * @return int <0 if KO, 0 if not found, >0 if OK
*/ */
function fetch($id,$ref='') public function fetch( $id, $ref = null )
{ {
global $langs; dol_syslog( __METHOD__, LOG_DEBUG );
$sql = "SELECT";
$sql.= " t.rowid,"; $sql = 'SELECT';
$sql.= " t.field1,"; $sql .= ' t.rowid,';
$sql.= " t.field2"; $sql .= ' t.field1,';
//... $sql .= ' t.field2';
$sql.= " FROM ".MAIN_DB_PREFIX.$this->table_element." as t"; //...
if ($ref) $sql.= " WHERE t.ref = '".$ref."'"; $sql .= ' FROM ' . MAIN_DB_PREFIX . $this->table_element . ' as t';
else $sql.= " WHERE t.rowid = ".$id; if (null !== $ref) {
$sql .= ' WHERE t.ref = ' . '\'' . $ref . '\'';
} else {
$sql .= ' WHERE t.rowid = ' . $id;
}
dol_syslog(get_class($this)."::fetch");
$resql = $this->db->query( $sql ); $resql = $this->db->query( $sql );
if ($resql) if ($resql) {
{
$numrows = $this->db->num_rows( $resql ); $numrows = $this->db->num_rows( $resql );
if ($numrows) if ($numrows) {
{
$obj = $this->db->fetch_object( $resql ); $obj = $this->db->fetch_object( $resql );
$this->id = $obj->rowid; $this->id = $obj->rowid;
@ -164,11 +202,15 @@ class Skeleton_Class extends CommonObject
} }
$this->db->free( $resql ); $this->db->free( $resql );
return ($numrows?1:0); if ($numrows) {
return 1;
} else {
return 0;
} }
else } else {
{ $this->errors[] = 'Error ' . $this->db->lasterror();
$this->error="Error ".$this->db->lasterror(); dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
return - 1; return - 1;
} }
} }
@ -181,40 +223,39 @@ class Skeleton_Class extends CommonObject
* @param int $limit offset limit * @param int $limit offset limit
* @param int $offset offset limit * @param int $offset offset limit
* @param array $filter filter array * @param array $filter filter array
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function fetchAll($sortorder, $sortfield, $limit, $offset, $filter = array()) public function fetchAll( $sortorder, $sortfield, $limit, $offset, array $filter = array() )
{ {
global $langs; dol_syslog( __METHOD__, LOG_DEBUG );
$sql = "SELECT";
$sql.= " t.rowid,"; $sql = 'SELECT';
$sql.= " t.field1,"; $sql .= ' t.rowid,';
$sql.= " t.field2"; $sql .= ' t.field1,';
$sql .= ' t.field2';
//... //...
$sql.= " FROM ".MAIN_DB_PREFIX."mytable as t"; $sql .= ' FROM ' . MAIN_DB_PREFIX . 'mytable as t';
// Manage filter // Manage filter
$sqlwhere = array(); $sqlwhere = array();
if (count( $filter ) > 0) { if (count( $filter ) > 0) {
foreach ($filter as $key => $value) { foreach ($filter as $key => $value) {
//$sqlwhere []= ' AND '. $key . ' LIKE \'%' . $this->db->escape($value) . '%\''; $sqlwhere [] = ' AND ' . $key . ' LIKE \'%' . $this->db->escape( $value ) . '%\'';
} }
} }
if (count( $sqlwhere ) > 0) { if (count( $sqlwhere ) > 0) {
$sql .= ' WHERE ' . implode( ' AND ', $sqlwhere ); $sql .= ' WHERE ' . implode( ' AND ', $sqlwhere );
} }
$sql .= " ORDER BY " . $sortfield . " " . $sortorder . " " . $this->db->plimit($limit + 1, $offset); $sql .= ' ORDER BY ' . $sortfield . ' ' . $sortorder . ' ' . $this->db->plimit( $limit + 1, $offset );
$this->lines = array(); $this->lines = array();
dol_syslog(get_class($this)."::fetchAll", LOG_DEBUG);
$resql = $this->db->query( $sql ); $resql = $this->db->query( $sql );
if ($resql) if ($resql) {
{
$num = $this->db->num_rows( $resql ); $num = $this->db->num_rows( $resql );
while ($obj = $this->db->fetch_object($resql)) while ($obj = $this->db->fetch_object( $resql )) {
{
$line = new Skeleton_ClassLine(); $line = new Skeleton_ClassLine();
$line->id = $obj->rowid; $line->id = $obj->rowid;
@ -227,51 +268,65 @@ class Skeleton_Class extends CommonObject
$this->db->free( $resql ); $this->db->free( $resql );
return $num; return $num;
} } else {
else $this->errors[] = 'Error ' . $this->db->lasterror();
{ dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
$this->error="Error ".$this->db->lasterror();
dol_syslog(get_class($this)."::fetchAll ".$this->error, LOG_ERR);
return - 1; return - 1;
} }
} }
/** /**
* Update object into database * Update object into database
* *
* @param User $user User that modifies * @param User $user User that modifies
* @param int $notrigger 0=launch triggers after, 1=disable triggers * @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function update($user, $notrigger=0) public function update( User $user, $notrigger = false )
{ {
global $conf, $langs;
$error = 0; $error = 0;
dol_syslog( __METHOD__, LOG_DEBUG );
// Clean parameters // Clean parameters
if (isset($this->prop1)) $this->prop1=trim($this->prop1); if (isset( $this->prop1 )) {
if (isset($this->prop2)) $this->prop2=trim($this->prop2); $this->prop1 = trim( $this->prop1 );
}
if (isset( $this->prop2 )) {
$this->prop2 = trim( $this->prop2 );
}
//... //...
// Check parameters // Check parameters
// Put here code to add a control on parameters values // Put here code to add a control on parameters values
// Update request // Update request
$sql = "UPDATE ".MAIN_DB_PREFIX.$this->table_element." SET"; $sql = 'UPDATE ' . MAIN_DB_PREFIX . $this->table_element . ' SET';
$sql.= " field1=".(isset($this->field1)?"'".$this->db->escape($this->field1)."'":"null").","; if (isset( $this->field1 )) {
$sql.= " field2=".(isset($this->field2)?"'".$this->db->escape($this->field2)."'":"null").""; $sql .= ' field1=\'' . $this->db->escape( $this->field1 ) . '\',';
} else {
$sql .= ' field1=null' . ',';
}
if (isset( $this->field2 )) {
$sql .= ' field2=\'' . $this->db->escape( $this->field2 ) . '\'';
} else {
$sql .= ' field2=null';
}
//... //...
$sql.= " WHERE rowid=".$this->id; $sql .= ' WHERE rowid=' . $this->id;
$this->db->begin(); $this->db->begin();
dol_syslog(__METHOD__);
$resql = $this->db->query( $sql ); $resql = $this->db->query( $sql );
if (! $resql) { $error++; $this->errors[]="Error ".$this->db->lasterror(); } if (!$resql) {
$error ++;
$this->errors[] = 'Error ' . $this->db->lasterror();
dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
}
if (! $error && ! $notrigger) if (!$error && !$notrigger) {
{
// Uncomment this and change MYOBJECT to your own tag if you // Uncomment this and change MYOBJECT to your own tag if you
// want this action calls a trigger. // want this action calls a trigger.
@ -282,37 +337,35 @@ class Skeleton_Class extends CommonObject
} }
// Commit or rollback // Commit or rollback
if ($error) if ($error) {
{
$this->db->rollback(); $this->db->rollback();
return - 1 * $error; return - 1 * $error;
} } else {
else
{
$this->db->commit(); $this->db->commit();
return 1; return 1;
} }
} }
/** /**
* Delete object in database * Delete object in database
* *
* @param User $user User that deletes * @param User $user User that deletes
* @param int $notrigger 0=launch triggers after, 1=disable triggers * @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
function delete($user, $notrigger=0) public function delete( User $user, $notrigger = false )
{ {
global $conf, $langs; dol_syslog( __METHOD__, LOG_DEBUG );
$error = 0; $error = 0;
$this->db->begin(); $this->db->begin();
if (! $error) if (!$error) {
{ if (!$notrigger) {
if (! $notrigger)
{
// Uncomment this and change MYOBJECT to your own tag if you // Uncomment this and change MYOBJECT to your own tag if you
// want this action calls a trigger. // want this action calls a trigger.
@ -323,51 +376,51 @@ class Skeleton_Class extends CommonObject
} }
} }
if (! $error) if (!$error) {
{ $sql = 'DELETE FROM ' . MAIN_DB_PREFIX . $this->table_element;
$sql = "DELETE FROM ".MAIN_DB_PREFIX.$this->table_element; $sql .= ' WHERE rowid=' . $this->id;
$sql.= " WHERE rowid=".$this->id;
dol_syslog(__METHOD__);
$resql = $this->db->query( $sql ); $resql = $this->db->query( $sql );
if (! $resql) { $error++; $this->errors[]="Error ".$this->db->lasterror(); } if (!$resql) {
$error ++;
$this->errors[] = 'Error ' . $this->db->lasterror();
dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
}
} }
// Commit or rollback // Commit or rollback
if ($error) if ($error) {
{
$this->db->rollback(); $this->db->rollback();
return - 1 * $error; return - 1 * $error;
} } else {
else
{
$this->db->commit(); $this->db->commit();
return 1; return 1;
} }
} }
/** /**
* Load an object from its id and create a new one in database * Load an object from its id and create a new one in database
* *
* @param int $fromid Id of object to clone * @param int $fromid Id of object to clone
*
* @return int New id of clone * @return int New id of clone
*/ */
function createFromClone($fromid) public function createFromClone( $fromid )
{ {
global $user,$langs; dol_syslog( __METHOD__, LOG_DEBUG );
global $user;
$error = 0; $error = 0;
$object = new Skeleton_Class( $this->db ); $object = new Skeleton_Class( $this->db );
$this->db->begin(); $this->db->begin();
// Load source object // Load source object
$object->fetch( $fromid ); $object->fetch( $fromid );
// Reset object
$object->id = 0; $object->id = 0;
$object->statut=0;
// Clear fields // Clear fields
// ... // ...
@ -376,39 +429,31 @@ class Skeleton_Class extends CommonObject
$result = $object->create( $user ); $result = $object->create( $user );
// Other options // Other options
if ($result < 0) if ($result < 0) {
{
$this->error=$object->error;
$error ++; $error ++;
} $this->errors = $object->errors;
dol_syslog( __METHOD__ . ' ' . join( ',', $this->errors ), LOG_ERR );
if (! $error)
{
} }
// End // End
if (! $error) if (!$error) {
{
$this->db->commit(); $this->db->commit();
return $object->id; return $object->id;
} } else {
else
{
$this->db->rollback(); $this->db->rollback();
return - 1; return - 1;
} }
} }
/** /**
* Initialise object with example values * Initialise object with example values
* Id must be 0 if object instance is a specimen * Id must be 0 if object instance is a specimen
* *
* @return void * @return void
*/ */
function initAsSpecimen() public function initAsSpecimen()
{ {
$this->id = 0; $this->id = 0;
$this->prop1 = 'prop1'; $this->prop1 = 'prop1';
@ -417,9 +462,21 @@ class Skeleton_Class extends CommonObject
} }
/**
* Class Skeleton_ClassLine
*/
class Skeleton_ClassLine class Skeleton_ClassLine
{ {
var $id; /**
var $prop1; * @var int ID
var $prop2; */
public $id;
/**
* @var mixed Sample line property 1
*/
public $prop1;
/**
* @var mixed Sample line property 2
*/
public $prop2;
} }