Thread: [phpMP-CVS] CVS: phpMP/includes config.init.php,1.8,1.9 core.php,1.62,1.63 debug.php,1.9,1.10 functi

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/phpmp/phpMP/includes
In directory sc8-pr-cvs1:/tmp/cvs-serv15256/includes

Modified Files:
	config.init.php core.php debug.php functions.php language.php 
	mpcode.php mpcode_arrays.php session.php template.php user.php 
Log Message:
All code recommented to specification.

Index: config.init.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/config.init.php,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** config.init.php	29 Jun 2003 18:33:21 -0000	1.8
--- config.init.php	30 Jun 2003 03:43:42 -0000	1.9
***************
*** 27,30 ****
--- 27,34 ----
  	var $_cfgvars;
  	
+ 	/**
+ 	 * @return void
+ 	 * @desc Fetches Config vars. 
+ 	 */
  	function Config()
  	{

Index: core.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/core.php,v
retrieving revision 1.62
retrieving revision 1.63
diff -C2 -r1.62 -r1.63
*** core.php	30 Jun 2003 01:44:07 -0000	1.62
--- core.php	30 Jun 2003 03:43:42 -0000	1.63
***************
*** 26,29 ****
--- 26,35 ----
  {
  
+ 	/**
+ 	 * @return arr array
+ 	 * @param arr array
+ 	 * @desc Strips magic quotes from the
+ 	 *       superglobal arrays.
+ 	 */
  	function strip_magic_quotes($arr)
  	{
***************
*** 43,50 ****
  	}
  
! 	// Initiates all core components.
! 	// Author: Brian 'Heimidal' Rose
! 	// Accepts: $optional_files (string of needed files separated by commas).
! 	// Returns: none.
  	function Core( $optional_files = array() )
  	{
--- 49,57 ----
  	}
  
! 	/**
! 	 * @return void
! 	 * @param optional_files array
! 	 * @desc Initiates all core components.
! 	 */
  	function Core( $optional_files = array() )
  	{

Index: debug.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/debug.php,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -r1.9 -r1.10
*** debug.php	29 Jun 2003 18:33:21 -0000	1.9
--- debug.php	30 Jun 2003 03:43:42 -0000	1.10
***************
*** 26,36 ****
  {
  
  	function Debug()
  	{
  		@set_error_handler( array(&$this, 'msg_display') );
  	}
! 	
! 	// Very similar to that of phpBB2, considering this is my first forray into error management.
! 	// Hopefully, once I figure all of these different error codes and such out, I'll make it fit in more with the project.
  	function msg_display($errno, $msg_text, $errfile, $errline)
  	{
--- 26,47 ----
  {
  
+ 	/**
+ 	 * @return void
+ 	 * @desc Sets the error handler. 
+ 	 */
  	function Debug()
  	{
  		@set_error_handler( array(&$this, 'msg_display') );
  	}
! 
! 	/**
! 	 * @return void
! 	 * @param errno int
! 	 * @param msg_text string
! 	 * @param errfile string
! 	 * @param errline int
! 	 * @desc Error/message handler. Taken from phpBB2.
! 	 	 I still don't quite understand it. :P
! 	 */
  	function msg_display($errno, $msg_text, $errfile, $errline)
  	{

Index: functions.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/functions.php,v
retrieving revision 1.32
retrieving revision 1.33
diff -C2 -r1.32 -r1.33
*** functions.php	29 Jun 2003 18:33:21 -0000	1.32
--- functions.php	30 Jun 2003 03:43:42 -0000	1.33
***************
*** 23,30 ****
   */
   
! // Defines constants whose contents may be questionable.
! // Author: Brian 'Heimidal' Rose
! // Accepts: none.
! // Returns: none.
  function create_vars()
  {
--- 23,30 ----
   */
   
! /**
!  * @return void
!  * @desc Creates vars with no other place.  Temporary.
!  */
  function create_vars()
  {

Index: language.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/language.php,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** language.php	29 Jun 2003 19:38:20 -0000	1.16
--- language.php	30 Jun 2003 03:43:42 -0000	1.17
***************
*** 26,29 ****
--- 26,34 ----
  {
  
+ 	/**
+ 	 * @return void
+ 	 * @desc Discovers the user's language and
+ 	 	 creates the corresponding Local object.
+ 	 */
  	function Language()
  	{

Index: mpcode.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/mpcode.php,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** mpcode.php	29 Jun 2003 21:32:25 -0000	1.10
--- mpcode.php	30 Jun 2003 03:43:42 -0000	1.11
***************
*** 27,30 ****
--- 27,32 ----
  
  // Work here done by anthony.  If you dont like it feel free to change it.
+ // Deprecated.
+ 
  class mpcode {
  	

Index: mpcode_arrays.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/mpcode_arrays.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** mpcode_arrays.php	29 Jun 2003 08:19:55 -0000	1.4
--- mpcode_arrays.php	30 Jun 2003 03:43:42 -0000	1.5
***************
*** 24,27 ****
--- 24,28 ----
   
  // Contains the mpcode and corresponding html arrays
+ // Deprecated.
  
  $mpcode = array(

Index: session.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/session.php,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** session.php	29 Jun 2003 18:33:22 -0000	1.15
--- session.php	30 Jun 2003 03:43:42 -0000	1.16
***************
*** 22,26 ****
   *
   */
!  
  class Session // Creates and maintains sessions for all users.
  {
--- 22,26 ----
   *
   */
! 
  class Session // Creates and maintains sessions for all users.
  {
***************
*** 36,40 ****
  	var $page;
  	
! 	// Starts the session.  Must be called.
  	function start()
  	{
--- 36,43 ----
  	var $page;
  	
! 	/**
! 	 * @return void
! 	 * @desc Starts a session.  Must be called implicitly.
! 	 */
  	function start()
  	{
***************
*** 48,52 ****
  	}
  	
! 	// Destroys sessions.  Used for logging out and such.
  	function destroy()
  	{
--- 51,58 ----
  	}
  	
! 	/**
! 	 * @return void
! 	 * @desc Destroys sessions.  Used for logging out.
! 	 */
  	function destroy()
  	{
***************
*** 74,77 ****
--- 80,87 ----
  	}
  	
+ 	/**
+ 	 * @return void
+ 	 * @desc Logs a user in.
+ 	 */
  	function login()
  	{
***************
*** 115,119 ****
  	}
  	
! 	// Saves the session data to the database.
  	function run()
  	{
--- 125,132 ----
  	}
  	
! 	/**
! 	 * @return void
! 	 * @desc Saves the session data to the database.
! 	 */
  	function run()
  	{
***************
*** 210,213 ****
--- 223,231 ----
  	}
  
+ 	/**
+ 	 * @return void
+ 	 * @param clean_all boolean
+ 	 * @desc Cleans out old session data.
+ 	 */
  	function clean($clean_all = false)
  	{
***************
*** 230,233 ****
--- 248,255 ----
  	}
  	
+ 	/**
+ 	 * @return void
+ 	 * @desc Grabs session data for the user.
+ 	 */
  	function get_session_data()
  	{

Index: template.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/template.php,v
retrieving revision 1.44
retrieving revision 1.45
diff -C2 -r1.44 -r1.45
*** template.php	29 Jun 2003 19:38:20 -0000	1.44
--- template.php	30 Jun 2003 03:43:42 -0000	1.45
***************
*** 29,32 ****
--- 29,33 ----
  	under the GPL, you must abide by said license.
  */
+ // Deprecated in favor of the (soon-to-be-started) Fission Template System.
  
  class Template

Index: user.php
===================================================================
RCS file: /cvsroot/phpmp/phpMP/includes/user.php,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -r1.26 -r1.27
*** user.php	29 Jun 2003 18:33:22 -0000	1.26
--- user.php	30 Jun 2003 03:43:42 -0000	1.27
***************
*** 28,31 ****
--- 28,37 ----
  	var $_data;
  	
+ 	/**
+ 	 * @return boolean
+ 	 * @param userkey mixed(string,array)
+ 	 * @param userval string optional
+ 	 * @desc Set a variable in userdata.
+ 	 */
  	function set($userkey, $userval = false)
  	{
***************
*** 52,57 ****
  	
  	/**
! 	 * @return unknown
! 	 * @param userkey unknown
  	 * @desc Fetches user variables from the defined array.
  	 */
--- 58,63 ----
  	
  	/**
! 	 * @return string
! 	 * @param userkey string
  	 * @desc Fetches user variables from the defined array.
  	 */
***************
*** 68,72 ****
  	}
  	
! 	// Taken from phpBB2.  Fetches the IP in a hex form.
  	function get_ip_encoded()
  	{
--- 74,82 ----
  	}
  	
! 	/**
! 	 * @return void
! 	 * @desc Fetches the user's IP in hex-encoded form.
! 	 * Taken from phpBB2.
! 	 */
  	function get_ip_encoded()
  	{
***************
*** 83,87 ****
  	}
  	
! 	// Taken from phpBB2.  Decodes a hexed IP.
  	function decode_ip($encoded_ip)
  	{
--- 93,102 ----
  	}
  	
! 	/**
! 	 * @return string
! 	 * @param encoded_ip string
! 	 * @desc Decodes a hexed IP.
! 	 *	 Taken from phpBB2. 
! 	 */
  	function decode_ip($encoded_ip)
  	{

Thread: [phpMP-CVS] CVS: phpMP/includes config.init.php,1.8,1.9 core.php,1.62,1.63 debug.php,1.9,1.10 functi

phpmp-commits