table_template.txt
1 |
<?php |
---|---|
2 |
/** |
3 |
* |
4 |
* Description |
5 |
* |
6 |
* @package VirtueMart |
7 |
* @subpackage |
8 |
* @author |
9 |
* @link http://www.virtuemart.net |
10 |
* @copyright Copyright (c) 2004 - 2010 VirtueMart Team. All rights reserved. |
11 |
* @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php |
12 |
* VirtueMart is free software. This version may have been modified pursuant |
13 |
* to the GNU General Public License, and as distributed it includes or |
14 |
* is derivative of works licensed under the GNU General Public License or |
15 |
* other free or open source software licenses. |
16 |
* @version $Id: $ |
17 |
*/ |
18 |
|
19 |
// Check to ensure this file is included in Joomla! |
20 |
defined('_JEXEC') or die('Restricted access'); |
21 |
|
22 |
/** |
23 |
* Class Description |
24 |
* |
25 |
* @package VirtueMart |
26 |
* @author |
27 |
*/ |
28 |
class TableProduct extends JTable { |
29 |
|
30 |
/** |
31 |
* Method Description |
32 |
* |
33 |
* @access (define if the method is public or private here) |
34 |
* @author |
35 |
*/ |
36 |
function __construct($db) { |
37 |
parent::__construct('#__<table name>', '<primary key>', $db); |
38 |
|
39 |
} |
40 |
|
41 |
You may use the @var tag to document the data type of class variables. |
42 |
|
43 |
Example |
44 |
|
45 |
/** @var integer Primary key */ |
46 |
var $_id; |
47 |
|
48 |
/** |
49 |
* Function Description |
50 |
* |
51 |
* @copyright (Only specify if different to the top @copyright) |
52 |
* @author |
53 |
* @todo (Use @todo as current on going tasks or projects with in the current file) |
54 |
* (Correct use of the @todo will result in quicker bug fixing and will help keep the file up to date) |
55 |
* Example of a correctly formated todo - "@todo Date Added - Task Name" |
56 |
* |
57 |
* @see (Use @see tag to document reference to code with another files if needed) |
58 |
* (Please use the @see tag in all the files you wish to link to help outline the section within the code) |
59 |
* |
60 |
* @access (define if the method is public or private here) |
61 |
* @param |
62 |
* @return |
63 |
*/ |
64 |
} |
65 |
?> |