[geeklog-cvs] MVCnPHP README.txt,1.2,1.3

[geeklog-cvs-admin at lists.geeklog.net]

Update of /usr/cvs/geeklog/MVCnPHP
In directory internal.geeklog.net:/tmp/cvs-serv25797

Modified Files:
	README.txt 
Log Message:
Added a pros/cons section as well as resources to MVC related information. Also updated the organization structure a bit

Index: README.txt
===================================================================
RCS file: /usr/cvs/geeklog/MVCnPHP/README.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** README.txt	5 Apr 2003 20:15:18 -0000	1.2
--- README.txt	2 May 2003 18:30:46 -0000	1.3
***************
*** 8,15 ****
  
  INTRODUCTION TO MVC
  ORGANIZATION OF MVCnPHP
  INSTALLATION
      REQUIREMENTS
!     INSTALLING THE EXAMPLE
      INSTALLING FOR GENERAL USE
  TODO
--- 8,18 ----
  
  INTRODUCTION TO MVC
+ MVC FEATURES
+ MVC DRAWBACKS
  ORGANIZATION OF MVCnPHP
  INSTALLATION
      REQUIREMENTS
!     INSTALLING THE CONTACT MANAGER EXAMPLE
!     INSTALLING THE QUCKFORM EXAMPLE
      INSTALLING FOR GENERAL USE
  TODO
***************
*** 44,55 ****
  http://phrame.itsd.ttu.edu/ 
  
  ORGANIZATION OF MVCnPHP
  -------------------------
  
  MVCnPHP (holds base MVCnPHP code files)
!     contactmanager (folder for sample application)
!         commands (holds commands used in contact manager application)
!         views (holds views used in contact manager application)
!     docs (phpDocumentor documentation)
  
  INSTALLATION
--- 47,99 ----
  http://phrame.itsd.ttu.edu/ 
  
+ MVC FEATURES
+ ------------
+ 
+ Obviously using a framework package like MVCnPHP you would expect to see the benefits before
+ you invest.  Here is a run down of the benefits of implementing MVC in your applications:
+ 
+ - The MVC is a solution to the classic problem of separating the user interface, business
+   logic and related data.
+ - Render views (user interfaces) via a variety of technologies like XHTML, XML/XSL, WML, 
+   Web services, or any other 3rd party technology (e.g. PEAR::HTML_QuickForm).
+ - Have multiple views that rely upon a single model.  Thus your HTML and WML views can call
+   on the same underlying business logic for processing.
+ - Ability to switch backend DBMS with little effort (e.g. MySQL -> PostgreSQL)
+ - Code ends up being in smaller, more manageable files.
+ 
+ MVC DRAWBACKS
+ --------------
+ 
+ In an effort to show two sides of the MVC fence here are a few drawbacks:
+ 
+ - MVC implementations time a fair amount of time to learn how to use them.
+ - Debugging between models and veiws can be more difficult
+ - Because MVC breaks tasks down to atomic parts, you end up with a lot of relatively small
+   files you have to manage.
+ - Because of the associated ramp-up, MVC in smaller applications may not make much sense.
+ 
+ MVC RESOURCES
+ -------------
+ 
+ You are encouraged to learn as much about the MVC design pattern as possible.  Below are
+ a few sites related to the MVC pattern you may find useful.  Of course, spend time doing
+ a few Google searches if you desire more diverse information:
+ 
+ - http://java.sun.com/blueprints/guidelines/designing_enterprise_applications_2e/web-tier/web-tier5.html
+ - http://phrame.itsd.ttu.edu/
+ - http://ootips.org/mvc-pattern.html
+ - http://www.phppatterns.com/index.php/article/articleview/19/1/1/
+ - http://www.google.com and http://groups.google.com for more information
+ 
  ORGANIZATION OF MVCnPHP
  -------------------------
  
  MVCnPHP (holds base MVCnPHP code files)
!     /contactmanager (folder for sample application)
!         /commands (holds commands used in contact manager application)
!         /views (holds views used in contact manager application)
!     /quickform (folder for quick form example)
!         /views (holds an example view that uses PEAR::HTML_QuickForm)
!     /docs (phpDocumentor documentation)
  
  INSTALLATION
***************
*** 62,68 ****
  2) MySQL 3.23.x or better (Only needed if you want to run the contact manager 
     application)
  
! INSTALLING THE EXAMPLE
! ----------------------
  
  It is strongly recommended that you install the example before you begin using this MVC
--- 106,113 ----
  2) MySQL 3.23.x or better (Only needed if you want to run the contact manager 
     application)
+ 3) PEAR::HTML_QuickForm (Only needed if you require QuickForm integration
  
! INSTALLING THE CONTACT MANAGER EXAMPLE
! ---------------------------------------
  
  It is strongly recommended that you install the example before you begin using this MVC
***************
*** 80,83 ****
--- 125,137 ----
  use.  It is merely meant to show you that MVCnPHP works and give you a taste
  at how you might you it in your PHP applications.
+ 
+ INSTALLING THE QUCKFORM EXAMPLE
+ -------------------------------
+ 
+ PEAR::HTML_QuickForm is a PEAR package that provides object oriented methods for creating
+ HTML forms and for doing data validation.  This example is provided to prove that MVCnPHP
+ can be easily extended to use other packages for the creation of views.  Furthermore, 
+ MVCnPHP includes QF_View.class.php as part of the base distribution so that you could begin
+ using HTML QuickForm right out-of-the-box.  
  
  INSTALLATION FOR GENERAL USE