GeeklogWiki - User contributions [en]

MVC Introduction

2005-05-19T08:02:36Z

ShiYan:

The model-view-controller, commonly referred to as MVC, is an industry standard solution to a long time problem in software. For years, software architects have been trying to find ways to cleanly separate the user interface from the business logic from the data access details. MVC provides a theorhetically simple solution to this problem. The MVC pattern was originally developed in Smalltalk and was made wildly popular by the Java community. I will not be able to give the background of MVC the in-depth converage it deserves so please, take the time to [http://www.google.com/search?q=model-view-controller Search on MVC]. FWIW, I did put a little background on MVC in the [http://cvs.geeklog.net/co.php/MVCnPHP/README.txt MVCnPHP package in CVS].

Before continuing on, be sure you understand what MVC is. I'll demonstrate the details of how MVCnPHP through the sample application.

[http://www.shneon.com 霓虹灯]
[http://www.junyuan.com.cn 制作网页]
[http://www.junyuan.com.cn/cnstrct 建站]
[http://www.junyuan.com.cn/design 网页设计]
[http://www.junyuan.com.cn/page 网页制作]
[http://www.junyuan.com.cn/site 网站制作]
[http://www.junyuan.com.cn/site_design 网站设计]
[http://www.junyuan.com.cn/site_con 网站建设]
[http://www.junyuan.com.cn/web 企业上网]
[http://www.junyuan.com.cn/con_site 建设网站]
[http://www.junyuan.com.cn/dsgn_pg 设计网页]
[http://www.junyuan.com.cn/mk_site 制作网站]
[http://www.junyuan.com.cn/net 网络公司]
[http://www.junyuan.com.cn/dsgn_site 设计网站]
[http://www.junyuan.com.cn/com_con 企业建站]
[http://www.junyuan.com.cn/ebiz 电子商务]
[http://www.junyuan.com.cn/database 数据库开发]
[http://www.junyuan.com.cn/dvlp_dtbs 开发数据库]
[http://www.junyuan.com.cn/program 程序开发]
[http://www.junyuan.com.cn/dvlp_prgrm 开发程序]
[http://www.junyuan.com.cn/data 数据库]
[http://www.junyuan.com.cn/e_mail 企业邮局]
[http://www.junyuan.com.cn/e_email 企业电子信箱]
[http://www.junyuan.com.cn/email 电子信箱]
[http://www.junyuan.com.cn/mailbox 邮局]
[http://www.junyuan.com.cn/flash_mk flash制作]
[http://www.junyuan.com.cn/flash_dsgn flash设计]
[http://www.junyuan.com.cn/ani_dsgn 动画设计]
[http://www.junyuan.com.cn/ani_mk 动画制作]
[http://www.junyuan.com.cn/mk_ani 制作动画]
[http://www.junyuan.com.cn/dsgn_ani 设计动画]
[http://www.junyuan.com.cn/ecard 多媒体电子名片]
[http://www.junyuan.com.cn/cdrom 多媒体设计]

Introduction to the Geeklog 2 FrameworkG2

2005-05-19T08:01:28Z

ShiYan:

It will be worth your while to download and install the [http://www.geeklog.net/filemgmt/visit.php?lid=557 Sample Contact Manager Application]as it is a working example that illustrates the use of the Geeklog 2 framework. Installation should be fairly trivial as I have included all necessary PEAR libraries in the tarball (hence the unusually large footprint for such a small appliction). To install, create a database called PHPARCH and import the sql/create.sql. Be sure you have MySQL 4.1.x and that it supports the use of INNODB (it will work without it but transactions are supported by the framework). From there, edit the config.php. The comments in that file should explain everything just fine. Please email me at tony AT geeklog DOT net if you have any trouble getting the application installed.

From this point, I'm assuming that you have the sample application installed. From the login screen use tbibbs as the username (the password doesn't matter) and submit the page. That should take you to a listing of two contacts. If you have gotten that far with no errors then you are ready to proceed.

Here are the things you will learn about in this introduction:
#[http://www.tonybibbs.com/index.php?topic=MVCnPHP MVCnPHP]
##[[MVC Introduction|Introduction to the Model-View-Controller design pattern]]
##[[Template Engines|A Note About Template Engines]]
##[[A Simple View|A Simple View]]
##[[Commands|Commands]]
##[[Introduction to Models|Introduction to Models]]
##[[The MVCnPHP Controller|The MVCnPHP Controller]]
#[http://propel.phpdb.org/trac/ Propel]
##[[Introduction to Object Relational Mapping (ORM) Tools|Introduction to Object Relational Mapping (ORM) Tools]]
##[[Building the Propel Schema|Building the Propel Schema]]
##[[Building the Model Objects|Building the Model Objects]]
#[[The Propel Data Access Object|The Propel Data Access Object]]
##[[Retrieving Propel Objects|Retrieving Propel Objects]]
##[[Saving (Persisting) Propel Objects|Saving (Persisting) Propel Objects]]
##[[Deleting Propel Objects|Deleting Propel Objects]]
##[[Customized Queries using Named Queries Concept|Customized Queries using Named Queries Concept]]

[http://www.shneon.com 霓虹灯]
[http://www.junyuan.com.cn 制作网页]
[http://www.junyuan.com.cn/cnstrct 建站]
[http://www.junyuan.com.cn/design 网页设计]
[http://www.junyuan.com.cn/page 网页制作]
[http://www.junyuan.com.cn/site 网站制作]
[http://www.junyuan.com.cn/site_design 网站设计]
[http://www.junyuan.com.cn/site_con 网站建设]
[http://www.junyuan.com.cn/web 企业上网]
[http://www.junyuan.com.cn/con_site 建设网站]
[http://www.junyuan.com.cn/dsgn_pg 设计网页]
[http://www.junyuan.com.cn/mk_site 制作网站]
[http://www.junyuan.com.cn/net 网络公司]
[http://www.junyuan.com.cn/dsgn_site 设计网站]
[http://www.junyuan.com.cn/com_con 企业建站]
[http://www.junyuan.com.cn/ebiz 电子商务]
[http://www.junyuan.com.cn/database 数据库开发]
[http://www.junyuan.com.cn/dvlp_dtbs 开发数据库]
[http://www.junyuan.com.cn/program 程序开发]
[http://www.junyuan.com.cn/dvlp_prgrm 开发程序]
[http://www.junyuan.com.cn/data 数据库]
[http://www.junyuan.com.cn/e_mail 企业邮局]
[http://www.junyuan.com.cn/e_email 企业电子信箱]
[http://www.junyuan.com.cn/email 电子信箱]
[http://www.junyuan.com.cn/mailbox 邮局]
[http://www.junyuan.com.cn/flash_mk flash制作]
[http://www.junyuan.com.cn/flash_dsgn flash设计]
[http://www.junyuan.com.cn/ani_dsgn 动画设计]
[http://www.junyuan.com.cn/ani_mk 动画制作]
[http://www.junyuan.com.cn/mk_ani 制作动画]
[http://www.junyuan.com.cn/dsgn_ani 设计动画]
[http://www.junyuan.com.cn/ecard 多媒体电子名片]
[http://www.junyuan.com.cn/cdrom 多媒体设计]

Prerequisites for DevelopersG2

2005-05-19T07:59:18Z

ShiYan:

As we have already eluded, Geeklog 2 is a complete rewrite of Geeklog to overcome some design limitations in the 1.3.x codebase. The underlying framework for Geeklog 2 will definitely take some ramp-up time and this section will guide you through that process. Before you can begin, however, you must bring a few basic skills to the table (or be willing to learn them before proceeding). To help the the Geeklog Development effort you must understand the following:

#Basic Web Server Administration (Includes Apache and IIS)
#Experience with PHP5 Configuration and Installation
#Basic Knowledge of PHP5 Syntax
#Understanding of managing PEAR packages
#Object Oriented Programming
#Design Patterns
##Singleton
##Factory
##Model-View-Controller
##Observer
##Observable
#Learn the Geeklog 2 Framework Libraries
##MVCnPHP (Model-View-Controller library we are using)
##PEAR::HTML_Template_Flexy (The template engine)
##Propel - PHP-based object relational mapping tool
##Data Access Object
###Using the DAO
###Named Queries

[http://www.shneon.com 霓虹灯]
[http://www.junyuan.com.cn 制作网页]
[http://www.junyuan.com.cn/cnstrct 建站]
[http://www.junyuan.com.cn/design 网页设计]
[http://www.junyuan.com.cn/page 网页制作]
[http://www.junyuan.com.cn/site 网站制作]
[http://www.junyuan.com.cn/site_design 网站设计]
[http://www.junyuan.com.cn/site_con 网站建设]
[http://www.junyuan.com.cn/web 企业上网]
[http://www.junyuan.com.cn/con_site 建设网站]
[http://www.junyuan.com.cn/dsgn_pg 设计网页]
[http://www.junyuan.com.cn/mk_site 制作网站]
[http://www.junyuan.com.cn/net 网络公司]
[http://www.junyuan.com.cn/dsgn_site 设计网站]
[http://www.junyuan.com.cn/com_con 企业建站]
[http://www.junyuan.com.cn/ebiz 电子商务]
[http://www.junyuan.com.cn/database 数据库开发]
[http://www.junyuan.com.cn/dvlp_dtbs 开发数据库]
[http://www.junyuan.com.cn/program 程序开发]
[http://www.junyuan.com.cn/dvlp_prgrm 开发程序]
[http://www.junyuan.com.cn/data 数据库]
[http://www.junyuan.com.cn/e_mail 企业邮局]
[http://www.junyuan.com.cn/e_email 企业电子信箱]
[http://www.junyuan.com.cn/email 电子信箱]
[http://www.junyuan.com.cn/mailbox 邮局]
[http://www.junyuan.com.cn/flash_mk flash制作]
[http://www.junyuan.com.cn/flash_dsgn flash设计]
[http://www.junyuan.com.cn/ani_dsgn 动画设计]
[http://www.junyuan.com.cn/ani_mk 动画制作]
[http://www.junyuan.com.cn/mk_ani 制作动画]
[http://www.junyuan.com.cn/dsgn_ani 设计动画]
[http://www.junyuan.com.cn/ecard 多媒体电子名片]
[http://www.junyuan.com.cn/cdrom 多媒体设计]

Geeklog's way of doing things

2005-05-19T07:57:28Z

ShiYan:

All of Geeklog's php files are pure php. PHP allows you to use php as a scripting language imbedded in html files but this is not how Geeklog does it. All of Geeklog's php files must have <?php as the first five characters and end with ?>. Failure to structure your Geeklog files this way will cause session and header errors. Geeklog attempts as much as possible to have only php code in the php files. Two of the conventions used in Geeklog to accomplish this are the use of templates and language files.

Time will be well spent by the Geeklog plugin or block developer to become familiar with several Geeklog libraries. The following section outlines the more important or frequently used libraries, functions and standards.

== lib-common.php: ==

The Geeklog plugin or block developer should have a good understanding of lib-common.php which contains most of the display routines as well as some other general purpose routines. All of the Geeklog display routines return html. They do not contain echos or prints themselves. The way the Geeklog system is designed; you usually put your code between Geeklog display routines. For example: code to display a page would look like this:

$display = COM_siteHeader(); 
$display .= COM_startBlock("Title of Your Block"); 
$display .= "Some words"; 
$display .= somefunction(); 
$display .= COM_endBlock; 
$display .= COM_siteFooter(true); 
echo $display;

A summary of commonly used Geeklog functions are described below but reference the attached lib-common.php documentation for further examples.

== lib-security.php: ==

The lib-security.php file contains the interface routines to the security system used in Geeklog. See the attached lib-security.php documentation. There are several SEC type functions that you may want to use in your projects. The table Commonly Used Geeklog Functions at the end of this section defines a couple of the more commonly used functions.

== lib-database.php: ==

All database access should take place through the database abstraction in lib-database.php and table names should be accessed through the $_TABLES array. The table definitions in this array will then include whatever table prefix this site is using. You should ensure that your plugin or block uses the $_TABLES['mytable'] for all Database access related functions.
*Block developers and site admins installing the block need to edit the lib-database.php program and add the new $_TABLES entries for your block tables. Ensure you follow the same standard by using the $_DB_table_prefix.
*Plugin developers need to define their tables in the plugin config.php file. You have the ability to use the $_TABLES array or use your own plugin specific array to maintain the table definitions. It's recommend that your arrays use a name such as _XX_TABLES, where XX are two letters to describe your plugin. Once the plugin is installed and enabled, the tables defined in the config.php for the plugin are automatically known as globals.

== lib-plugins.php: ==

This library contains all the code used to interface your plugin or block to Geeklog. You will not call any code from here directly. The functions in this file are called by the Geeklog main programs as they are used to call all plugins and are used to resolve the plugin name and check if your plugin has a particular function. You will usually only have to look at this file to understand some nuance of the implementation. See the documentation for functions.inc and the original plugin documentation for further help.

== How your Plug-in or Block Interacts with Geeklog: ==

The program lib-common.php is the key to all interaction with Geeklog. It includes Geeklog's config.php and the rest of the Geeklog code libraries.
*At the top of lib-common.php is an include of lib-custom.php. This is where you place all your block functions. They are then included when the site index.php is called.
*At the very end of lib-common.php is a check for all enabled plugins. A plugin is registered with Geeklog when it has a record in the plugins table and the field pi_enabled is true. For all registered and enabled plugins, the code in lib-common.php will include the functions.inc file for each plugin. This is why the naming convention and location for each plugin file is strictly defined. All code libraries or configuration files your plugin needs should be included in your functions.inc. Since the plugins config.php is now also included this way - via the include in functions.inc - the variables in your plugin config.php become global and can be referenced in your plugin functions.

== Common Global Variables ==

There are a few commonly used globals within Geeklog that you will want to use and reference. The following table outlines the more frequently used ones and its recommended that these be used instead of hard coding paths and table names in your links or project code.

<table border="1" cellpadding="3" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="75%" id="AutoNumber2" height="72">
<tr>
<td width="27%" bgcolor="#000000" height="16">
 Variable</td>
<td width="73%" bgcolor="#000000" height="16">
  Description</td>
</tr>
<tr>
<td width="27%" height="17">$_CONF['path_html']</td>
<td width="73%" height="17">Fully qualified path to your
sites public_htmk path</td>
</tr>
<tr>
<td width="27%" height="18">$_CONF['site_url']</td>
<td width="73%" height="18">Full URL to your sites
public_html directory</td>
</tr>
<tr>
<td width="27%" height="18">$_CONF['site_admin_url']</td>
<td width="73%" height="18">Full URL to your sites admin
directory</td>
</tr>
<tr>
<td width="27%" height="18">$_USER['uid']</td>
<td width="73%" height="18">Current user ID. A uid of 1 is an
anonymous user</td>
</tr>
<tr>
<td width="27%" height="18">$_TABLES['tablename']</td>
<td width="73%" height="18">A array of geeklog tables with
the site prefix defined.</td>
</tr>
</table>

== Commonly used Geeklog functions ==

The following is a list of commonly used Geeklog functions that as developers we use and recommend you become more familiar with and use in your development projects. You will find example usage of these functions throughout the Geeklog code.

<table border="1" style="border-collapse: collapse" bordercolor="#111111" width="100%" id="AutoNumber1" height="197" cellpadding="3" cellspacing="0">
<tr>
<td width="13%" bgcolor="#000000" height="18">
 Function Name</td>
<td width="73%" bgcolor="#000000" height="18">
   Description</td>
</tr>
<tr>
<td width="13%" height="16">
 COM_siteHeader</td>
<td width="73%" height="16">Display the main site header and
optionally if 'none' is passed do not display the left blocks</td>
</tr>
<tr>
<td width="13%" height="16">
 COM_siteFooter</td>
<td width="73%" height="16">Display the main site footer and
optionally if 'true' is passed display the right blocks</td>
</tr>
<tr>
<td width="13%" height="32">
 COM_startBlock</td>
<td width="73%" height="32">Formats the block title using the
selected theme - pass the title, helpfile if any and optional block theme to
apply if you do not want to use default</td>
</tr>
<tr>
<td width="13%" height="16">
 COM_endBlock</td>
<td width="73%" height="16">Formats the block footer using
the selected theme or the optional block theme if you do not want to use
default</td>
</tr>
<tr>
<td width="13%" height="12"> COM_errorLOG</td>
<td width="73%" height="12">Use to format an error message or
use for debugging - view output in <geeklog_dir>/logs/error.log</td>
</tr>
<tr>
<td width="13%" height="14">
 DB_query</td>
<td width="73%" height="14">Execute a formatted SQL query and
return the record set to an array of records (which is also an array)</td>
</tr>
<tr>
<td width="13%" height="16">
 DB_fetchArray</td>
<td width="73%" height="16">Retrieve a record as an array
from the returned record set - which DB_query returned.</td>
</tr>
<tr>
<td width="13%" height="16">
 DB_numROWS</td>
<td width="73%" height="16">Returns the number of records
retrieved by the DB_query result</td>
</tr>
<tr>
<td width="13%" height="16"> DB_getItem</td>
<td width="73%" height="16">Retrieve one record as an array.
Pass a formatted SQL stmt with WHERE clause to retrieve one record</td>
</tr>
<tr>
<td width="13%" height="15"> COM_checkHTML</td>
<td width="73%" height="15">Use to strip out $, <, > , [code]
and replace with the HTML codes</td>
</tr>
<tr>
<td width="13%" height="15"> COM_checkWords</td>
<td width="73%" height="15">Use to check passed text for any
HTML tags that are not allowed as per the site config.php setting</td>
</tr>
<tr>
<td width="13%" height="15"> SEC_inGroup</td>
<td width="73%" height="15">Used to check if user has passed
group rights. Example: SEC_inGroup('Root') - returns true if user is</td>
</tr>
<tr>
<td width="13%" height="15"> SEC_hasRights</td>
<td width="73%" height="15">Used to check if user has access
right (feature). Example: SEC_hasRights('myplugin.edit')</td>
</tr>
</table>

[[Category:Plugin_Developers_Handbook]]

[http://www.shneon.com 霓虹灯]
[http://www.junyuan.com.cn 制作网页]
[http://www.junyuan.com.cn/cnstrct 建站]
[http://www.junyuan.com.cn/design 网页设计]
[http://www.junyuan.com.cn/page 网页制作]
[http://www.junyuan.com.cn/site 网站制作]
[http://www.junyuan.com.cn/site_design 网站设计]
[http://www.junyuan.com.cn/site_con 网站建设]
[http://www.junyuan.com.cn/web 企业上网]
[http://www.junyuan.com.cn/con_site 建设网站]
[http://www.junyuan.com.cn/dsgn_pg 设计网页]
[http://www.junyuan.com.cn/mk_site 制作网站]
[http://www.junyuan.com.cn/net 网络公司]
[http://www.junyuan.com.cn/dsgn_site 设计网站]
[http://www.junyuan.com.cn/com_con 企业建站]
[http://www.junyuan.com.cn/ebiz 电子商务]
[http://www.junyuan.com.cn/database 数据库开发]
[http://www.junyuan.com.cn/dvlp_dtbs 开发数据库]
[http://www.junyuan.com.cn/program 程序开发]
[http://www.junyuan.com.cn/dvlp_prgrm 开发程序]
[http://www.junyuan.com.cn/data 数据库]
[http://www.junyuan.com.cn/e_mail 企业邮局]
[http://www.junyuan.com.cn/e_email 企业电子信箱]
[http://www.junyuan.com.cn/email 电子信箱]
[http://www.junyuan.com.cn/mailbox 邮局]
[http://www.junyuan.com.cn/flash_mk flash制作]
[http://www.junyuan.com.cn/flash_dsgn flash设计]
[http://www.junyuan.com.cn/ani_dsgn 动画设计]
[http://www.junyuan.com.cn/ani_mk 动画制作]
[http://www.junyuan.com.cn/mk_ani 制作动画]
[http://www.junyuan.com.cn/dsgn_ani 设计动画]
[http://www.junyuan.com.cn/ecard 多媒体电子名片]
[http://www.junyuan.com.cn/cdrom 多媒体设计]