Register Members List Search Today's Posts Mark Forums Read

Reply
 
Article Options
[tip] Use PAPI if you're just starting out with phpinclude
filburt1
Join Date: Feb 2002
Posts: 6,144

Maryland, US
by filburt1 filburt1 is offline 19 Dec 2002

Note: this is not meant to be a plug for my mod.

PAPI (pronounced "pappy") is a mod I released: http://www.vbulletintemplates.com/mo...&threadid=2361 . Escentially it is a phpinclude swiss army knife although the name means phpinclude API. It is a set of wrapper functions designed to drastically simplify coding mods for use in the phpinclude template.

Going back a step: the phpinclude template is a template that is special in the sense that it can contain raw PHP code. It is the only template that can; the others can only contain PHP variables.

Standard vB pages are constructed in this order:
1. Execute the .php file
2. Execute the contents of phpinclude
3. Compile the final HTML to display

Therefore phpinclude can only access variables that are within a global scope and only gets executed when a template is generated.

Remember though that phpinclude is executed in any page, so you have to start accounting for that. Also you have to use vB's database reference methods to access the MySQL database. This is where PAPI starts to become useful.

Say you want to run code that only executes on forumhome (index.php). Normally you'd put this in phpinclude:

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

To those new to PHP, that tests whether the current page's path and filename contains the string "index.php".

With PAPI, this is simplified to:

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

or

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

PAPI offers a plethora of functions, but some general ones to note: actionis() returns true depending on the value of the "action" variable (i.e., index.php?action=something; actionis("something") would return true. mysqlqueryhandle (1.0.3 and later) returns the result from a MySQL query (i.e., returns $DB_site->query(query).

These may seem trivial, but it goes so far to implement mysqlmultiplequeries which can execute several queries in succession with one line of code. So

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

can be simplified to:

Block Disabled:      (Update License Status)  
Suspended or Unlicensed Members Cannot View Code.

Also, starting with PAPI 1.0.3, an internal query counter is maintained, so every time a query is executed via PAPI's wrapper functions a counter is incremented; putting $papiquerycount in your footer will display how many queries PAPI's wrapper functions have executed.

There are far more features than this, however, so check out PAPI's thread for a near-full list, or at least the features from 1.0.0. Enjoy.
Views: 2510
Reply With Quote
Comments
  #2  
Old 19 Dec 2002, 22:48
Cypher720's Avatar
Cypher720 Cypher720 is offline
 
Join Date: Aug 2002
thanks again for making this! due to my lack of time...i havent tried it yet - sorry
Reply With Quote
  #3  
Old 20 Dec 2002, 00:23
Tony G's Avatar
Tony G Tony G is offline
 
Join Date: Nov 2001
Real name: ITS A SECRET
I've taken your advice, although I wanted to learn the hard way so PAPI would be easier.

Stay tuned for somewhat of a PAPI mod by me.
Reply With Quote
  #4  
Old 20 Dec 2002, 00:29
filburt1 filburt1 is offline
 
Join Date: Feb 2002
Just be sure to use PAPI's wrappers for the MySQL stuff wherever possible because the soon-to-be-uploaded 1.0.3 includes an internal counter.
Reply With Quote
  #5  
Old 20 Dec 2002, 00:35
Tony G's Avatar
Tony G Tony G is offline
 
Join Date: Nov 2001
Real name: ITS A SECRET
I'll wait for that version then.
Reply With Quote
Reply

Similar Article
Article Author Type Replies Last Post
[release] PAPI, a phpinclude API filburt1 vBulletin 2.x Template Modifications 47 31 Jul 2003 21:19



Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Article Options

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump


New To Site? Need Help?

All times are GMT. The time now is 19:47.

Layout Options | Width: Wide Color: