model_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 |
// Load the model framework |
23 |
jimport('joomla.application.component.model'); |
24 |
|
25 |
/** |
26 |
* Class Description |
27 |
* |
28 |
* @package VirtueMart |
29 |
* @author |
30 |
*/ |
31 |
class VirtueMartModel<name> extends JModel { |
32 |
|
33 |
/** |
34 |
* Method Description |
35 |
* |
36 |
* @access (define if the method is public or private here) |
37 |
* @author |
38 |
*/ |
39 |
function __construct() { |
40 |
parent::__construct(); |
41 |
|
42 |
} |
43 |
|
44 |
You may use the @var tag to document the data type of class variables. |
45 |
|
46 |
Example |
47 |
|
48 |
/** @var integer Primary key */ |
49 |
var $_id; |
50 |
|
51 |
/** |
52 |
* Function Description |
53 |
* |
54 |
* @copyright (Only specify if different to the top @copyright) |
55 |
* @author |
56 |
* @todo (Use @todo as current on going tasks or projects with in the current file) |
57 |
* (Correct use of the @todo will result in quicker bug fixing and will help keep the file up to date) |
58 |
* Example of a correctly formated todo - "@todo Date Added - Task Name" |
59 |
* |
60 |
* @see (Use @see tag to document reference to code with another files if needed) |
61 |
* (Please use the @see tag in all the files you wish to link to help outline the section within the code) |
62 |
* |
63 |
* @access (define if the method is public or private here) |
64 |
* @param |
65 |
* @return |
66 |
*/ |
67 |
} |
68 |
?> |