Doxygen
This commit is contained in:
parent
d434dcc85b
commit
f0dcd8ad51
@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
/* Copyright (C) 2007-2008 Laurent Destailleur <eldy@users.sourceforge.net>
|
/* Copyright (C) 2007-2011 Laurent Destailleur <eldy@users.sourceforge.net>
|
||||||
* 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
|
||||||
@ -52,8 +52,8 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Constructor
|
* Constructor
|
||||||
* \param DB Database handler
|
* @param DB Database handler
|
||||||
*/
|
*/
|
||||||
function Skeleton_class($DB)
|
function Skeleton_class($DB)
|
||||||
{
|
{
|
||||||
@ -63,10 +63,10 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Create in database
|
* Create object into database
|
||||||
* \param user User that create
|
* @param user User that create
|
||||||
* \param notrigger 0=launch triggers after, 1=disable triggers
|
* @param notrigger 0=launch triggers after, 1=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)
|
function create($user, $notrigger=0)
|
||||||
{
|
{
|
||||||
@ -136,9 +136,9 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Load object in memory from database
|
* Load object in memory from database
|
||||||
* \param id id object
|
* @param id id object
|
||||||
* \return int <0 if KO, >0 if OK
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function fetch($id)
|
function fetch($id)
|
||||||
{
|
{
|
||||||
@ -178,10 +178,10 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Update database
|
* Update object into database
|
||||||
* \param user User that modify
|
* @param user User that modify
|
||||||
* \param notrigger 0=launch triggers after, 1=disable triggers
|
* @param notrigger 0=launch triggers after, 1=disable triggers
|
||||||
* \return int <0 if KO, >0 if OK
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function update($user=0, $notrigger=0)
|
function update($user=0, $notrigger=0)
|
||||||
{
|
{
|
||||||
@ -245,10 +245,10 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Delete object in database
|
* Delete object in database
|
||||||
* \param user User that delete
|
* @param user User that delete
|
||||||
* \param notrigger 0=launch triggers after, 1=disable triggers
|
* @param notrigger 0=launch triggers after, 1=disable triggers
|
||||||
* \return int <0 if KO, >0 if OK
|
* @return int <0 if KO, >0 if OK
|
||||||
*/
|
*/
|
||||||
function delete($user, $notrigger=0)
|
function delete($user, $notrigger=0)
|
||||||
{
|
{
|
||||||
@ -301,9 +301,9 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief 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 fromid Id of object to clone
|
* @param fromid Id of object to clone
|
||||||
* \return int New id of clone
|
* @return int New id of clone
|
||||||
*/
|
*/
|
||||||
function createFromClone($fromid)
|
function createFromClone($fromid)
|
||||||
{
|
{
|
||||||
@ -355,8 +355,8 @@ class Skeleton_class // extends CommonObject
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Initialise object with example values
|
* Initialisz object with example values
|
||||||
* \remarks id must be 0 if object instance is a specimen.
|
* Id must be 0 if object instance is a specimen.
|
||||||
*/
|
*/
|
||||||
function initAsSpecimen()
|
function initAsSpecimen()
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user