RM - Source Code View

Source Code Viewer

This page lets you view source code from my server. The program uses a brute force code formatter to color code elements. NOTE: I wrote this program while trying to learn the vim text editor. This is not my usual coding style.

Use this select box to select a file.

Hide Lines Numbers

View: Resource Model

The Resource Model is the base code that I use in a variety of sites.

Formatted Code

Below is the code all formatted with bright colors. The program links to files opened with include() and expands those opened with require(). Clicking on the require line should change visibility.

Resource Model

001 <?php 002 // 12/26/2015: NOTE I am rewriting this from scratch. 003 // I will write a blog post explaining why when I am finished. 004 // This is closer to the code I actually use and like to use. 005 // You see test variables at the e bottom. Those will go away soon 006 // I am using thise to help debug. 007 // 008 // I will remove theses after writing the last function, then 009 // run the program through performance and QA tests. 010 011 012 /** 013 * The Resource Model for Web Design holds that certain objects in a 014 * program such as the database connection, notification object, output 015 * buffer and site definition are resources that should be global and 016 * This page includes the resources. 017 * 018 * @package ResourceModel 019 * @copyright 2002-2016 Kevin Delaney 020 * @license https://yintercept.com/resources/license.html 021 * @see https://yintercept.com/resources 022 * @see https://yintercept.com/resources/view.php?script=1 Source Code 023 * @version 0.0.10 024 * 025 * 026 */ 027 028 029 // This file has the notification object
require('/var/www/php/msg.php');
001 <?php 002 /** 003 * @package ResourceModel 004 * 005 * msgNote() functions create a poor man's notification object. 006 * 007 * msgNote() conveys general information and success messages to the user 008 * msgComment() leaves comments on the view source page for visitors and 009 * as [DEBUG] warnings for the programmer and tester. 010 * msgError() produces messages that show up in red. It sets isOkay to false 011 * You can view this code on the msg code Test page: 012 * @see https://yintercept.com/resources/view.php?script=9 013 * 014 * The function msgHTML() prints the messages and resets the buffer. 015 * @author Kevin Delaney 016 * @copyright 1999-2015 Kevin Delaney 017 * @license https://yintercept.com/resources/license.html 018 */ 019 const MSG_OK = 1; // denotes a happy message 020 const MSG_ERROR = 2; // denotes a sad message 021 const MSG_COMMENT = 3; // print as a comment or DEBUG notice. 022 // NOTE: As this "object" is a global, I will put its data in $GLOBALS 023 $GLOBALS['msg']['arr'] = array(); // holds the messages 024 $GLOBALS['msg']['isOkay'] = true; // warns that an error occurred 025 $GLOBALS['msg']['debugMode'] = false; // if true msgHTML() will display comments for programmer 026 /** 027 * msgNote() adds a neutral or success message to the buffer. 028 * @param string $txt The text of a godd message 029 */ 030 function msgNote($txt='') { 031 if($txt!='') $GLOBALS['msg']['arr'][] = ['type'=>MSG_OK, 'txt' => $txt]; 032 } 033 /** 034 * @param string $txt The text to give the user on error. 035 */ 036 function msgError($txt='') { 037 if ($txt != '') $GLOBALS['msg']['arr'][] = ['type'=>MSG_ERROR, 'txt' => $txt]; 038 $GLOBALS['msg']['isOkay'] = false; 039 } 040 /** 041 * @param string $txt Text of a comment for the programmer. 042 */ 043 function msgComment($txt='') { 044 if ($txt!='') $GLOBALS['msg']['arr'][] = ['type'=>MSG_COMMENT, 'txt' => $txt]; 045 } 046 /** 047 * msgToggle saves a success or failure message based on the toggle 048 * @PARAM boolean $test 049 * @PARAM array $msgArr This three part array holds the message. 050 * $msgArr[0] is a required success message. 051 * $msgArr[1] is a reuired failure message 052 * $msgArr[2] is an optional failure comment (with debug notes) 053 * $msgArr[3] is optional message if test is not boolean. 1=return error. * @RETURN function resturns a boolean. 054 */ 055 function msgToggle($test, $msgArr) { 056 $rv = $test; 057 if (is_integer($test)) $test = (bool) $test; 058 // some functions say they return boolean, then don't. 059 if (!(is_bool($test))) { 060 msgError($msgArr[1]); 061 msgComment('Test needs to be boolean'); 062 $rv = false; 063 } elseif ($test) { 064 // success message. 065 if (isset($msgArr[0])) msgNote($msgArr[0]); 066 } else { 067 if (isset($msgArr[1])) msgError($msgArr[1]); 068 if (isset($msgArr[2])) msgComment($msgArr[2]); 069 } 070 return $rv; 071 } 072 /** 073 * I used to call this function isOkay(); I changed name to msgOkay() 074 * to emphasize that this really is an object even though it's not in a class. 075 * @return boolean Returns true if no errors and false on error 076 */ 077 function msgOkay() { 078 return $GLOBALS['msg']['isOkay']; 079 } 080 /** 081 * @output function prints the array in HTML 082 */ 083 function msgHTML($indent=PHP_EOL.' ') { 084 // This control loops through and prints the messages. 085 static $blockId = 0; // give each message block an id 086 $cnt = count($GLOBALS['msg']['arr']); // count messages 087 088 if ($cnt > 0) { 089 $ulClass = ($GLOBALS['msg']['isOkay'])? 'ulOkay' : 'ulErrors'; 090 $blockStr = ($blockId++ == 0)? 'msg' : 'msg'.$blockId; 091 echo $indent.'<ul id="'.$blockStr.'" class="'.$ulClass.'">'; 092 093 for($i=0; $i<$cnt; $i++) { 094 $row=$GLOBALS['msg']['arr'][$i]; 095 switch ($row['type']) { 096 case MSG_OK: 097 echo PHP_EOL.' <li class="msgHappy">'.$row['txt'].'</li>'; 098 break; 099 case MSG_ERROR: 100 echo PHP_EOL.' <li class="msgSad">'.$row['txt'].'</li>'; 101 break; 102 case MSG_COMMENT: 103 if ($GLOBALS['msg']['debugMode']) { 104 // this is a message for the administrator. 105 echo PHP_EOL.' <li>[DEBUG]'.$row['txt'].'[/DEBUG]</li>'; 106 } else { 107 echo PHP_EOL.'<!--'.$row['txt'].'-->'; 108 } 109 break; 110 default: // should not happen. 111 } 112 } 113 echo PHP_EOL.'</ul>'; 114 $GLOBALS['msg']['arr'] = []; // empty the array. 115 } 116 } 117 /** 118 * msgLog() records information into the log database 119 * @param string logName is the name of a table in the log. 120 * @param arr is an array that should match the columns in the log. 121 */ 122 function msgLog($logName,$arr=[]) { 123 file_put_contents('/var/www/db/'.$logName.'.log',implode('|',$arr), FILE_APPEND | LOCK_EX); 124 } 125 ?>
// End Require
030 031 032 // This page includes the SQL functions
require('/var/www/php/sql.php');
001 <?php 002 003 /** 004 * The sql functions connect with the database using PDO and PDOStatement. 005 * NOTE, you will need to manually edit dbConn to configure the connections. 006 * 007 * @package ResourceModel 008 * @copyright 2002-2016 Kevin Delaney 009 * @license https://yintercept.com/resources/license.html 010 * @see https://yintercept.com/resources 011 * @see https://yintercept.com/resources/view.php?script=1 Source Code 012 * @version 0.0.10 013 * 014 * These are the primary functions: 015 * sqlValue() returns a single value from the database 016 * sqlRow() returns a single row from the database. 017 * sqlArr() returns a 2D array with full result set. 018 * sqlLoop @see https://yintercept.com/resources/view.php?script=10 019 * dbConn() holds the PDO Connect object. It has some additional functions: 020 * Call it with DB_BEGIN, DB_ROLLBACK & DB_COMMIT for transactions 021 * "+dbname" will run an 'ATTACH DATABASE' command 022 * DB_INSERT_ID will return the last insert id 023 * The function returns a PDOStatement if you want one of those. 024 * 025 */ 026 027 const SDB_PATH = '/var/www/db/'; // Location of my SQLite3 databases. 028 const DB_MAIN = 'main'; // name of your primary database 029 // dbConn will process these transactions 030 const DB_INSERT_ID =1; // returns last insert id 031 const DB_BEGIN = 3; // Begin a transaction 032 const DB_ROLLBACK = 4; // rollback a database transaction 033 const DB_COMMIT = 5; // commit a database transaction 034 const DB_CLOSE = 6; // closes connection, logs stats & returns dbCnt. 035 const DB_CNT = 7; // dbComm restures statement count. 036 037 // used by sqlRow() 038 const DB_CHK = 100; 039 const DB_MAX_ROWS = 2000; 040 041 // directives for sqlExec 042 const DB_ONE_MAX = 64; // rollback if more than one row updated 043 const DB_ROWCOUNT = 10; // return the row count 044 const DB_LAST_ID = 1; // same as DB_INSERT_ID 045 include('/var/www/php/cnx.php'); 046 /** 047 * dbConn is a database connection factory that maintains an array of 048 * connections and returns PDOStatements to sql requests. 049 * Currently, I am hard coding the connectson in deConn. 050 * in a future release, connection information will be in an array 051 * 052 * @param string $sql is either SQL command or a short cut code. 053 * @param string $dbi identifies the database to use. 054 * @return mixed[] returns a PDOStatement for SQL command or info related to call. 055 */ 056 057 function dbConn($dbi,$sql) { 058 static $dbh = array(); // array holds the PDO objects. 059 static $dbCnt = 0; // counts calls to the database 060 static $dbTrace = ''; // holds a trace string. 061 /** register your conections here. The values of the array are: 062 * @param string dbnam -- give each db a unique name. Use 'main' for default. 063 * @param integer status starts as 0. Is 1 if connected and -1 if failed. 064 * @param string dsn is the Data Name Source for the connection 065 * @param string user is the database user name 066 * @param string pwd is the password. 067 */ 068 static $connArr = array( 069 DB_MAIN=>['status'=>0,'dsn'=>'sqlite:'.SDB_PATH.'main.db','user'=>'','pwd'=>''], 070 'log'=>['status'=>0,'dsn'=>'sqlite:'.SDB_PATH.'log.db','user'=>'','pwd'=>''], 071 'ele'=>['status'=>0,'dsn'=>PGSQL_CONN,'user'=>null,'pwd'=>null], 072 'invalid'=>['status'=>0,'dsn'=>'whatever','user'=>'bonzo','pwd'=>'letmein']); 073 // I've defined four databases. ele is hosted by http://www.elephantsql.com 074 // the last database is a mistake ... used to test db failures. 075 076 $rv = false; 077 $dbCnt++; 078 $stmt = false; 079 080 try { 081 // verify dbi exists in the index. 082 if (isset($connArr[$dbi])) { 083 if ($connArr[$dbi]['status'] == -1) throw new Exception('No Database Connection.'); 084 } else { 085 throw new Exception('Connection "'.$dbi.'" does not exist.'); 086 } 087 if ($connArr[$dbi]['status']==0) { 088 // connect to the database 089 try { 090 $dbh[$dbi] = new PDO($connArr[$dbi]['dsn'],$connArr[$dbi]['user'],$connArr[$dbi]['pwd']); 091 $connArr[$dbi]['status'] = 1; 092 } catch(PDOException $e) { 093 // record error and set DB_ACTIVE to DB_NONE. 094 $connArr[$dbi]['status'] = -1; 095 // log database connection faxlure in a file 096 file_put_contents(SDB_PATH.'pdoerr.txt', $dbi.' //'.$_SERVER['REQUEST_TIME'].' '.$e->getMessage(), FILE_APPEND | LOCK_EX); 097 throw new Exception('Database connection '.$dbi.' failed.'); 098 } 099 } 100 // We can add little short cuts here. such as +str Attaches a database 101 if (substr($sql,0,1)=='+') { 102 if (substr_count($sql,' ')==0) { 103 $asql = 'ATTACH DATABASE '.$dbh[$dbi]->quote(SDB_PATH.substr($sql,1).'.db').' AS '.$dbh[$dbi]->quote(substr($sql,1)); 104 $dbh[$dbi]->exec($asql); 105 $dbTrace+='A'; 106 $rv = true; 107 } 108 } elseif (substr($sql,0,1) == '^') { 109 $rv = $dbh[$dbi]->quote(substr($sql,1)); 110 } elseif ($sql==DB_INSERT_ID) { 111 $rv = $dbh[$dbi]->lastInsertId(); 112 } elseif ($sql == DB_CNT) { 113 $rv = --$dbCnt; // return current dbCnt (minus this call) 114 } elseif ($sql==DB_CLOSE) { 115 $dbh[$dbi]=null; 116 $dbErrors=false; 117 $rv=$dbCnt; 118 // store a trace of page for later analysis. 119 // $page_id = 0; // will populate later. 120 msgLog('dbTrace',[0,$dbTrace]); 121 } elseif ($sql==DB_BEGIN) { 122 if ($dbh[$dbi]->inTransaction()) { 123 msgComment($dbi.' is already in transaction mode.'); 124 } else { 125 $dbh[$dbi]->beginTransaction(); 126 } 127 $rv = true; 128 } elseif ($sql==DB_ROLLBACK) { 129 if ($dbh[$dbi]->inTransaction()) { 130 $dbh[$dbi]->rollBack(); 131 } else { 132 msgComment('Rollback outside a transaction'); 133 } 134 $rv = true; 135 } elseif ($sql==DB_COMMIT) { 136 if ($dbh[$dbi]->inTransaction()) { 137 $dbh[$dbi]->commit(); 138 } else { 139 msgComment('Attempting to commit outside transaction.'); 140 } 141 $rv = true; 142 } else { 143 // return an unexecuted prepared statement to call procedure. 144 $dbTrace.=substr($sql,0,1); // add first letter of command to trace. 145 $rv = $dbh[$dbi]->prepare($sql); 146 } 147 } catch (Exception $e) { 148 msgError('PDO says: '.$e->getMessage()); 149 $rv = false; 150 } 151 return $rv; 152 } 153 154 /** 155 * sqlValue returns a single value from the database. 156 * @param string $sql is a SQL SELECT command 157 * @param array $arr holds parameters for the SQL command 158 * @return string The function returns the first column of first row of the result 159 */ 160 161 function sqlValue($sql,$arr=[],$dbi=DB_MAIN) { 162 $stmt = dbConn($dbi,$sql); 163 // return an array of zeros on failure. 164 $rv = ''; // returns a blank space on error 165 if (is_object($stmt)) { 166 if (!is_array($arr)) { 167 $tst = $arr; 168 // no need to get huffy is some forgot the brackets to make it an array. 169 if (is_string($tst) or is_numeric($tst)) { 170 $arr=[$tst]; 171 // msgComment('sqlValue - string to array'); 172 } else { 173 msgError('In valid parameter for sqlValue()'); 174 } 175 } 176 if ($stmt->execute($arr)) { 177 $row = $stmt->fetch(PDO::FETCH_NUM); 178 $rv = (isset($row[0]))? $row[0] :''; 179 } else { 180 msgError('sqlValue execute failed'); 181 msgComment($sql.'<br />Parameters = '.implode('|',$arr)); 182 } 183 } else { 184 // this should only happen with a bad SQL statement 185 msgError('sqlValue() call failed. call #'.dbConn(DB_MAIN,DB_CNT)); 186 msgComment($dbi.' '.$sql); 187 // msgComment('RV Datatype is '.gettype($stmt)); 188 } 189 return $rv; 190 } 191 192 /** sqlRow() retruns a row for a SQL command. The command buffers PDOStatement 193 * You can get multiple rows and use function in some loops 194 * Use sqlLoop for complex loops. 195 * @param string $sql is a SQL select command. If null; returns next row of last 196 * command. If $sql==DB_CHK it checks to see if their is a next row. 197 * @param array $arr holds variables for the SQL statement 198 * @param integer $fetchStyle determines the PDO fetch style 199 * @return mixed[] Function returns an array for sql calls or boolean for chk. 200 */ 201 202 function sqlRow($sql=null,$arr=null,$dbi=DB_MAIN,$fetchStyle=PDO::FETCH_NUM) { 203 static $stmt=null; 204 static $style = ''; 205 static $chkCnt = 0; 206 static $chkVal = false; 207 208 209 $rv = [false,0,0,0,0,0,0,0,0,0,0,0,0,0]; 210 if ($sql == DB_CHK) { 211 $rv = ($chkCnt++ > DB_MAX_ROWS )? false : $chkVal; 212 } elseif ($sql == null) { 213 // get the next row from the existing counter. 214 $rv = $stmt->fetch($fetchStyle); 215 if ($rv===false) { 216 $rv = [false,0,0,0,0,0,0,0,0,0,0,0,0,0]; 217 $chkVal = false; 218 } else { 219 $chkVal = true; 220 } 221 } else { 222 // get and execute a PDOStatement 223 $stmt = dbConn($dbi,$sql); 224 $style = $fetchStyle; 225 if (gettype($stmt) == 'object') { 226 if ($stmt->execute($arr)) { 227 $rv = $stmt->fetch($fetchStyle); 228 if ($rv===false) { 229 $rv = [false,0,0,0,0,0,0,0,0,0,0,0,0]; 230 $chkVal = false; 231 } else { 232 $chkVal = true; 233 } 234 } else { 235 $stmt = null; 236 msgError('SQL execute failed'); 237 msgComment($sql); 238 msgComment('Parameters = '.implode('|',$arr)); 239 } 240 } else { 241 // this should only happen with a bad SQL statement 242 msgError('SQL call failed.'); 243 msgComment($sql); 244 msgComment('RV Datatype is '.gettype($stmt)); 245 } 246 } 247 return $rv; 248 } 249 250 251 /** 252 * sqlAll() returns the entire result set as a two dimensional array. 253 * @param string $sql is a SQL SELECT Statement 254 * @param array The $arr array holds values for for the SQL statement 255 * @param integer $fetchStyle is a PDO::FETCH style option 256 * @param array function always returns an array. 257 */ 258 259 function sqlAll($sql,$arr,$dbi=DB_MAIN,$fetchStyle=PDO::FETCH_NUM) { 260 $stmt = dbConn($dbi,$sql); 261 // return an array of zeros on failure. 262 $rv = array(); // returns a blank space on error 263 if (is_object($stmt)) { 264 if ($stmt->execute($arr)) { 265 // I break out of the function to avoid making an extra copy of results 266 return $stmt->fetchAll($fetchStyle); 267 } else { 268 msgError('SQL execute failed'); 269 msgComment($sql.'<br />Parameters: '.implode('|',$arr)); 270 } 271 } else { 272 // this should only happen with a bad SQL statement 273 msgError('SQL call failed.'); 274 msgComment($sql.'<br />RV Datatype is '.gettype($stmt)); 275 } 276 // successful calls return results straignt from driver. 277 return array(); // returns empty array on failure 278 } 279 /** 280 * sqlExec() execute a DML SQL command such as INSERT OR UPDATE 281 * @param string $sql is the SQL command to upddate 282 * @param array $arr contains variables for the SQL 283 * @param integer $directive determines the output of the command The default 284 is to return a row. DB_LAST_ID returns the last insert id. 285 DB_ONE_MAX rollsback transacation if it affects more than one row. 286 * @param string $successMsg is printed on cuccesful execution. 287 Program replaces %ID with insert id and %RS or %RC with row count. 288 * @param string $failureMsg is printed on failure of the statement 289 * @output db Updates the database 290 * @return either the row count or insert id based on $directive 291 */ 292 293 function sqlExec($sql,$arr,$dbi=DB_MAIN,$successMsg='',$failureMsg='',$directive=0) { 294 if ($directive==0) $directive = (substr($sql,0,6) == 'INSERT')? DB_INSERT_ID : DB_ROWCOUNT; 295 if ($directive == DB_ONE_MAX) dbConn($dbi,DB_BEGIN); 296 $stmt = dbConn($dbi,$sql); 297 $rv = 0; // returns rows affected. 298 if (is_object($stmt)) { 299 if ($stmt->execute($arr)) { 300 // prepare message. 301 $rv = $stmt->rowCount(); // rowcount is the default return value. 302 $rowStr = $rv.' rows'; 303 if ($directive == DB_ONE_MAX) { 304 if ($rv > 1) { 305 msgError('SQL Warning. '.$rowStr.' affected on single row query.<br />Rolling back transaction.'); 306 dbConn($dbi,DB_ROLLBACK); 307 msgComment('Rolled back: '.$sql); 308 309 } else { 310 dbConn($dbi,DB_COMMIT); 311 } 312 } 313 if ($rv == 0) { 314 $rowStr = 'no rows'; 315 } elseif ($rv == 1) { 316 $rowStr = '1 row'; 317 } 318 $insertId = dbConn($dbi,DB_INSERT_ID); 319 if ($successMsg != '') msgNote(str_replace(['%ID','%RS','%RC'],[$insertId,$rowStr,$rv],$successMsg)); 320 if ($directive == DB_INSERT_ID) $rv = $insertId; 321 } else { 322 msgError('SQL Exec: '.$failureMsg); 323 msgComment($sql.'<br />Parameters = '.implode('|',$arr)); 324 } 325 } else { 326 // this should only happen with a bad SQL statement 327 msgError('SQL Call: '.$failureMsg); 328 msgComment($sql.'<br />Return Datatype is '.gettype($stmt)); 329 } 330 return $rv; 331 } 332 /** 333 * I use a fair number of sequences which I maintain in a file called Seq_Def 334 * @param string seq_nm is the name of the sequence. 335 * @param boolen if true, wrap calls in BEGIN/COMMIT Transaction 336 * @return integer is -1 on failure or incremented sequence 337 */ 338 function getSeq($seq_nm,$commit=true) { 339 $rv = -1; 340 if ($commit) dbConn(DB_MAIN,DB_BEGIN); 341 $seq=sqlValue('SELECT seq+1 FROM Seq_Def WHERE seq_nm=?',[$seq_nm]); 342 if ($seq>0) { 343 if (sqlExec('UPDATE Seq_Def SET seq=? WHERE seq_nm=?',[$seq,$seq_nm])==1) { 344 $rv=$seq; 345 } else { 346 msgError('Failed to fetch sequence <b>'.$seq_nm.'</b>'); 347 } 348 } else { 349 msgError('Sequence <b>'.$seq_nm.'</b> is undefined.'); 350 } 351 if ($commit) dbConn(DB_MAIN,DB_COMMIT); 352 return $rv; 353 } 354 355 356 357 ?>
// End Require
033 034 035 // ipInfo and Prcedures that logs hits 036 include('/var/www/php/log.php'); 037 // I create an ipInfo object from log in global context so we can refer to it. 038 $rmIP = new ipInfo(); 039 $rmIP->loadIP(); 040 041 042 /** 043 * Rather than creating a WebSite Object, I just load the site data into globals 044 * @GLOBAL array rmSite contains the Web Site name, ID and format information 045 */ 046 $GLOBALS['rmSite'] = sqlRow('SELECT site_id as \'id\', collection_id as \'defColl\', site_nm as \'name\', domain_nm as \'domain\' FROM Web_Site WHERE domain_nm LIKE ?',[strtolower($_SERVER['HTTP_HOST'])],DB_MAIN,PDO::FETCH_OBJ); 047 048 // I use the variable $btn for flow control in most pages; so I will grab the 049 // contents from $_REQUEST (which combines $_POST and $_GET. 050 051 $btn = (isset($_REQUEST['btn']))? $_REQUEST['btn'] : ''; 052 053 ?>

Use "view source" from your browser to grab the output. Feel free to link to this project and check out the Resource Model for information on PHP coding or my tumblr blog for picture of Arizona, Colorado or Utah.

File last modified at April 17 2017 19:41:07.. This page has been viewed 763 Times.

Record of Revisions
RevbyDateDescription
0.7kd2015-12-31Added block id to message block and converted msgHTML() from foreach back to while.
0.6kd2015-12-30Moved the SQL commands and msg into their own files. Added the sqlExec() command which modifies the database
0.5kd2015-12-31Changed comment style to match that of docBlock standard. Added reporting to dbConn
0.4kd2015-12-27Created the sqlAll() function which returns the full result set a two dimensional array. NOTE: In legacy code, I call the function sqlArray().
0.3kd2015-12-27Deleted sqlLoop() function. Changed sqlRow() so that it works in loops.
0.2kd2015-12-26Rewrote the entire program as a collection of flat functions. Created sqlLoop() function.

blog ~ Resource Model ~ links