├── README
└── models
    └── template.js


/README:
--------------------------------------------------------------------------------
 1 | ----------------------------------------------------------------
 2 | Simple JS Model for Appcelerator Titanium
 3 | ----------------------------------------------------------------
 4 | 
 5 | http://github.com/swanify/Appcelerator-Titanium-DB-Model
 6 | 
 7 | This is a really simple template for a model to handle database 
 8 | interaction when using Appcelerator Titanium to build iPhone / 
 9 | Android applications, there are some really useful functions, 
10 | and you can easily add your own custom functions.
11 | 
12 | We like to place them in their own folder called models i.e.
13 | /Resources/models/item.js
14 | 
15 | ----------------------------------------------------------------
16 | INSTRUCTIONS:
17 | ----------------------------------------------------------------
18 | Replace all occurrences of Singular with your desired name, i.e. 
19 | Item, Person, Setting etc 
20 | 
21 | Replace all occurrences of TABLE with the name of your table, 
22 | i.e. ITEMS, PEOPLE, SETTINGS 
23 | 
24 | Replace all occurrences of DB with the name of your DB. 
25 | 
26 | Enter all your columns in the this.columns array, created and 
27 | updated will be automatically updated so you just need to 
28 | include them in your table.
29 | 
30 | ----------------------------------------------------------------
31 | USAGE:
32 | ----------------------------------------------------------------
33 | TO INCLUDE THE MODEL
34 | Ti.include('models/item.js');
35 | 
36 | ----------------------------------------------------------------
37 | TO CREATE A NEW ENTRY
38 | ----------------------------------------------------------------
39 | var item = new Item();
40 | item.name = 'Example';
41 | item.price = '2.99';
42 | item.save();
43 | 
44 | ----------------------------------------------------------------
45 | TO UPDATE AN ENTRY
46 | ----------------------------------------------------------------
47 | var item = new Item();
48 | item.getById(1);
49 | item.name = 'Example 2';
50 | item.save();
51 | 
52 | ----------------------------------------------------------------
53 | TO GET NUMBER OF ROWS
54 | ----------------------------------------------------------------
55 | var item = new Item();
56 | var numRows = item.countAll();
57 | 
58 | ----------------------------------------------------------------
59 | TO LOOP THROUGH RESULTS
60 | ----------------------------------------------------------------
61 | var item = new Item();
62 | var rows = item.getAll();
63 | for ( var i=0, len=rows.length; i<len; ++i ){
64 |    Ti.API.info('ID: ' + rows[i].id);
65 |    Ti.API.info('Name: ' + rows[i].name);
66 | }


--------------------------------------------------------------------------------
/models/template.js:
--------------------------------------------------------------------------------
  1 | // This JS file will hold all functions relating to people
  2 | Ti.include('includes/phpjs.js');
  3 | 
  4 | /*
  5 |  * Simple JS Model for Appcelerator Titanium
  6 |  * 
  7 |  * This is a really simple template for a model to handle database interaction when using
  8 |  * Appcelerator Titanium to build iPhone / Android applications, there are some really 
  9 |  * useful functions, and you can easily add your own custom functions.
 10 |  * 
 11 |  * Instructions:
 12 |  * Replace all occurances of Singular with your desired name, i.e. Item, Person, Setting etc
 13 |  * Replace all occurendes of TABLE with the name of your table, i.e. ITEMS, PEOPLE, SETTINGS
 14 |  * Replace all occurences of DB with the name of your DB
 15 |  * Enter all your columns in the this.columns array, created and updated will be automatically
 16 |  * updated so you just need to include them in your table
 17 |  *
 18 |  * http://github.com/swanify/Appcelerator-Titanium-DB-Model
 19 |  */
 20 | 
 21 | function Singular() {	
 22 | 	// Class variables
 23 | 	this.table		= 'TABLE';
 24 | 	this.db			= 'DB';
 25 | 	this.className  = 'Singular';
 26 | 	this.idColumn   = 'id';
 27 | 	this.columns	= ['id', 'name', 'price', 'created', 'updated'];
 28 | 	this.row		= [];
 29 | 	this.rows		= [];
 30 | 	
 31 | 	/* ########################################################## */
 32 | 	/* YOU DO NOT NEED TO EDIT ANY OF THE CODE BELOW THIS COMMENT */
 33 | 	/* ########################################################## */
 34 | 
 35 | 	/*
 36 | 	 *	getById
 37 |  	 *	This will return a row based on the ID column
 38 | 	*/
 39 | 	this.getById = function(id) {
 40 | 		// Open the DB
 41 | 		var db = Titanium.Database.open(this.db);
 42 | 		// Get the person based on id
 43 | 		var result = db.execute("SELECT * FROM " + this.table + " WHERE " + this.idColumn.toUpperCase() + " = ? LIMIT 1", id);
 44 | 		if(result.getRowCount() == 1){
 45 | 			// Set all of this classes variables to the data
 46 | 			for ( var i=0, len=this.columns.length; i<len; ++i ){
 47 | 				this[this.columns[i]] = result.fieldByName(this.columns[i]);
 48 | 			}
 49 | 			// Close the DB
 50 | 			db.close();
 51 | 			// Return result
 52 | 			return true;
 53 | 		}else{
 54 | 			// Close the DB
 55 | 			db.close();
 56 | 			// Return result
 57 | 			return false;
 58 | 		}
 59 | 		// Close the DB
 60 | 		db.close();
 61 | 	};
 62 | 	/*
 63 | 	 *	getAll
 64 | 	 *	This will return all rows in the DB for this model
 65 | 	 */
 66 | 	this.getAll = function() {
 67 | 		// Set an array
 68 | 		var rows = [];
 69 | 		var rowCount = 0;
 70 | 		// Open the DB
 71 | 		var db = Titanium.Database.open(this.db);
 72 | 		// Get all rows
 73 | 		var result = db.execute("SELECT * FROM " + this.table);
 74 | 		// Loop through results
 75 | 		if(result.getRowCount() > 0){
 76 | 			while (result.isValidRow())
 77 | 			{
 78 | 				eval('var thisRow = new ' + this.className + '();');
 79 | 				// Set all of this classes variables to the data
 80 | 				for ( var i=0, len=this.columns.length; i<len; ++i ){
 81 | 					thisRow[this.columns[i]] = result.fieldByName(this.columns[i]);
 82 | 				}
 83 | 				rows[rowCount]     = thisRow;
 84 | 				rowCount++;
 85 | 				result.next();
 86 | 			}
 87 | 			// Close the DB
 88 | 			db.close();
 89 | 			// Return the result
 90 | 			return rows;
 91 | 		}else{
 92 | 			// Close the DB
 93 | 			db.close();
 94 | 			// Return the result
 95 | 			return false;
 96 | 		}
 97 | 
 98 | 	};
 99 | 
100 | 
101 | 	/*
102 | 		countAll
103 | 		This function will simply return the integer of how many rows there are
104 | 		in the DB
105 | 	*/
106 | 	this.countAll = function() {
107 | 		// Open the DB
108 | 		var db = Titanium.Database.open(this.db);
109 | 		// Get the person based on id
110 | 		var result = db.execute("SELECT * FROM " + this.table);
111 | 		// Return number of rows
112 | 		return result.getRowCount();
113 | 	};
114 | 	/*
115 | 	 *	Save
116 | 	 *	This function will save the information to the database, if an ID
117 | 	 *	is present it will update the row
118 | 	*/
119 | 	this.save = function() {
120 | 		Ti.API.info('Function save()');
121 | 		// Open the DB
122 | 		var db = Titanium.Database.open(this.db);
123 | 
124 | 		if(typeof this.id == 'undefined'){
125 | 			Ti.API.info('This record has no ID, perform an INSERT');
126 | 			Ti.API.info('Adding new record...');
127 | 			// This is a new user
128 | 			this.created = date('Y-m-d H:i:s');
129 | 			this.updated = date('Y-m-d H:i:s');
130 | 
131 | 			var sql = "INSERT INTO " + this.table + " (";
132 | 			// Set all of this classes variables to the data
133 | 			for ( var i=0, len=this.columns.length; i<len; ++i ){
134 | 				if(this.columns[i] != 'id'){
135 | 					sql += this.columns[i].toUpperCase() + ",";
136 | 				}
137 | 			}
138 | 			sql = sql.substr(0, sql.length - 1);
139 | 
140 | 			sql += ") VALUES (";
141 | 
142 | 			// Set all of this classes variables to the data
143 | 			for ( var ii=0, leni=this.columns.length; ii<leni; ++ii ){
144 | 				if(this.columns[ii] != this.idColumn){
145 | 					sql += "'" + this[this.columns[ii]] + "',";
146 | 				}
147 | 			}
148 | 			sql = sql.substr(0, sql.length - 1);
149 | 			sql += ")";
150 | 
151 | 			Ti.API.info('SQL was: ' + sql);
152 | 
153 | 			db.execute(sql);
154 | 			Ti.API.info('The recorded was added with ID: ' + db.lastInsertRowId);
155 | 
156 | 			// Close the DB
157 | 			db.close();
158 | 		}else{
159 | 		    Ti.API.info('This record has an ID, perform an UPDATE');
160 | 			Ti.API.info('Updating existing record...');
161 | 			// Update existing record
162 | 			this.updated = date('Y-m-d H:i:s');
163 | 
164 | 			var updateSQL = "UPDATE " + this.table + " SET ";
165 | 			// Set all of this classes variables to the data
166 | 			for ( var x=0, l=this.columns.length; x<l; ++x ){
167 | 				if(this.columns[x] != this.idColumn){
168 | 					if(this.columns[x] != 'created'){
169 | 						updateSQL += this.columns[x].toUpperCase() + " = '" + this[this.columns[x]] + "',";
170 | 					}
171 | 				}else{
172 | 					updateSQLID = " WHERE " + this.idColumn.toUpperCase() + " = " + this[this.columns[x]] + "";
173 | 				}
174 | 			}
175 | 			updateSQL = updateSQL.substr(0, updateSQL.length - 1);
176 | 			updateSQL+= updateSQLID;
177 | 
178 | 			Ti.API.info('SQL was: ' + updateSQL);
179 | 
180 | 			db.execute(updateSQL);
181 | 
182 | 			Ti.API.info('The recorded with ID ' + this[this.idColumn] + ' was updated');
183 | 
184 | 			// Close the DB
185 | 			db.close();
186 | 		}
187 | 	};
188 | }
189 | 


--------------------------------------------------------------------------------