2009-07-28T18:23:15Z

Jlleblanc: New page: It's actually *not* recommended that you start PHP code by "<?php" and end with a "?>" tag. If you are embedding PHP code within HTML markup, you do need to use the closing tag or the file...

Pizza Bugs and Fun 2/Contributors List

2008-06-21T01:19:01Z

Jlleblanc: /* Contributors to the second PBF */

<noinclude>If you made a contribution to the documentation held on this site, please feel free to add your name below. Please consider adding your real name in addition to your nickname. You may, optionally, include a link to your website.</noinclude>

== Contributors to the second PBF ==

'''The people below plan to participate to PBF. Afterwards the list will be validated for the present we are planning. Those who haven't participated will be removed from this list afterward.'''

* Chris Davenport ([[Special:Contributions/Chris_Davenport|contributions]])
* Kevin Devine ([[Special:Contributions/Kevin_Devine|contributions]])
* Anthony Ferrara ([[Special:Contributions/ircmaxell|contributions]])
* Jerry Hilburn ([[Special:Contributions/Jerry_Hilburn|contributions]])
* Louis Landry ([[Special:Contributions/Louis_Landry|contributions]])
* Wilco Jansen ([[Special:Contributions/willebil|contributions]])
* Jennifer Marriott ([[Special:Contributions/MMMedia|contributions]])
* Rob Schley ([[Special:Contributions/Rob_Schley|contributions]])
* Amy Stephen ([[Special:Contributions/AmyStephen|contributions]])
* Nereyda Valentin-Macias ([[Special:Contributions/Neriv|contributions]])
* Elin Waring ([[Special:Contributions/Elin|contributions]])
* Michael Casha ([[Special:Contributions/MiCCAS|contributions]])
* Phil Taylor ([[Special:Contributions/Prazgod|contributions]])
* Marcelo Eden ([[Special:Contributions/3dentech|contributions]])
* Matt Thomas ([[Special:Contributions/betweenbrain|contributions]])
* Ross Crawford ([[Special:Contributions/RoscoHead|contributions]])
* Mickael Maison ([[Special:Contributions/Mmaison|contributions]])
* Ian MacLennan ([[Special:Contributions/ian|contributions]])
* Jaap Woltjes ([[Special:Contributions/japie1001|contributions]])
* Alan Langford ([[Special:Contributions/Instance|contributions]])
* Michael Hamanaka ([[Special:Contributions/hamanaka|contributions]])
* Joe LeBlanc ([[Special:Contributions/jlleblanc|contributions]])

Retrieving and Filtering GET and POST requests with JRequest::getVar

2008-04-21T19:31:12Z

Jlleblanc:

{{stub}}

== Summary ==

When writing any web application, it is crucial that you filter input data before using it. Joomla! provides a set of filtering libraries to help you accomplish this.

== JRequest functions ==

Under most circumstances, you will want to use member functions the JRequest class to get request variables. The most common case is when you want to use a specific variable found in either the GET or POST portion of the HTTP request. If you have a form variable named 'address', you would want to use this code to get it:

<pre>
$address = JRequest::getVar('address');
</pre>

By setting $address this way, getVar() strips out all HTML and trailing whitespace. If you want to specify a default value in the event that 'address' is not in the request or is unset, use this code:

<pre>
$address = JRequest::getVar('address', 'default value goes here');
</pre>

Frequently, you will expect your variable to be found in a specific portion of the HTTP request (POST, GET, etc...). If this is the case, you should specify which portion; this will slightly increase your extension's security. If you expect 'address' to only be in POST, use this code to enforce that:

<pre>
$address = JRequest::getVar('address', 'default value goes here', 'post');
</pre>

The fourth parameter of getVar() can be used to specify certain filters to force validation of specific value types for the variable. Here is a list of types you can validate:

*INT
*INTEGER
*FLOAT
*DOUBLE
*BOOL
*BOOLEAN
*WORD
*ALNUM
*CMD
*BASE64
*STRING
*ARRAY
*PATH
*USERNAME

Finally, there are some mask constants you can pass in as the fifth parameter that allow you to bypass portions of the filtering:

*JREQUEST_NOTRIM - prevents trimming of whitespace
*JREQUEST_ALLOWRAW - bypasses filtering
*JREQUEST_ALLOWHTML - allows most HTML. If this is not passed in, HTML is stripped out by default.

Retrieving and Filtering GET and POST requests with JRequest::getVar

2008-04-21T18:56:08Z

Jlleblanc: New page: {{stub}} {{inuse}}

How to create a system plugin

2008-04-04T13:30:49Z

Jlleblanc:

{{stub}}

== Events ==
* onAfterInitialise
* onAfterRoute
* onAfterDispatch
* onAfterRender
* onGetWebServices
* onLoginFailure

Adding JavaScript and CSS to the page

2008-04-02T14:48:19Z

Jlleblanc:

{{stub}}

To have a well-formed XHTML document, you must put all references to Javascript and CSS files within the <head> portion. Since Joomla! generates all of the HTML that makes up a page before output, it is possible to add these references to the <head> tag from your extension. To accomplish this, you first need to get a reference to the current document object:

<pre>
$document =& JFactory::getDocument();
</pre>

To add a Javascript file, use this code:
<pre>
$document->addScript($url);
</pre>

For a stylesheet, use this code:
<pre>
$document->addStyleSheet($url);
</pre>

If you want to add custom HTML to the head tag, use this code:
<pre>
$document->addCustomTag($html);
</pre>

2008-01-19T17:56:41Z

Jlleblanc:

{{inuse}}

== Basics ==

For every request in Joomla!, there is one user. Information about this user is readily available through the Joomla! framework in the form of an object. To get this object, use the following member function of JFactory:

<pre>
$user =& JFactory::getUser();
</pre>

Getting a reference through getUser() ensures that only one user object is created during any one Joomla! request, saving on memory and processing time. Most of the information about the user is available through public member variables of the user object. This code displays the current user's name, email, user name, user type, and group id:

<pre>
echo "Your name is {$user->name}, your email is {$user->email}, and your username is {$user->username}";
echo "Your usertype is {$user->usertype} which has a group id of {$user->gid}.";
</pre>

== Object Member Variables and Parameters ==

These are the relevant member variables automatically generated on a call to getUser():

<ul>
<li>id - The unique, numerical user id. Use this when referencing the user record in other database tables.</li>
<li>name - The name of the user. (e.g. Vint Cerf)</li>
<li>username - The login/screen name of the user. (e.g. shmuffin1979)</li>
<li>email - The email address of the user. (e.g. crashoverride@hackers.com)</li>
<li>password - The encrypted version of the user's password</li>
<li>password_clear - Set to the user's password only when it is being changed. Otherwise, remains blank.</li>
<li>usertype - The role of the user within Joomla!. (Super Administrator, Editor, etc...)</li>
<li>gid - Set to the user's group id, which corresponds to the usertype.</li>
<li>block - Set to '1' when the user is set to 'blocked' in Joomla!.</li>
<li>registerDate - Set to the date when the user was first registered.</li>
<li>lastvisitDate - Set to the date the user last visited the site.</li>
<li>guest - If the user is not logged in, this variable will be set to '1'. The other variables will be unset or default values.</li>
</ul>

In addition to the member variables (which are stored in the database in columns), there are parameters for the user that hold preferences. To get one of these parameters, call the getParam() member function of the user object, passing in the name of the parameter you want along with a default value in case it is blank.

<pre>
$user =& JFactory::getUser();
$language = $user->getParam('language', 'the default');

echo "Your language is set to {$language}.";
</pre>

== Determining Status ==

Frequently, you will just want to make sure the user is logged in before continuing. The 'guest' member function will be set to '1' when the current user is not logged in. When the user is authenticated, 'guest' will be set to '0'.

<pre>
$user =& JFactory::getUser();

if ($user->guest) {
echo "You must login to see the content. I want your email address.";
} else {
?>

<h1>Impromptu leftovers salad that goes well with fish</h1>
<ul>
<li>1/2 cup chopped celery</li>
<li>1/4 cup raisins</li>
<li>1 teaspoon Extra Virgin Olive Oil</li>
<li>2 tablespoons of faux Thai lemongrass marinade</li>
<li>1/4 cup shredded fresh basil</li>
<li>Sprinkling of dill weed</li>
<li>Big pinch of kosher salt</li>
<li>Several lettuce leaves</li>
</ul>

Wash the lettuce and basil and place in a salad bowl.
Get out a much smaller bowl and swish around all of the remaining ingredients. Pour this over the greens and toss.
Serves two.
<?php
}
</pre>

== Privileges ==

Not all authenticated users are given equal rights. For instance, a Super Administrator may be able to edit anyone's content, while a Publisher may only be able to edit their own. The authorize() member function can be used to determine if the current user has permission to do a certain task. The first parameter is used to identify which component or function we wish to authenticate against. The second represents the task. The third and fourth are optional; they further break the permissions down into record types and ownership respectively.

In Joomla! 1.5, the rights for all of the core components are stored in libraries/joomla/user/authorization.php. These are available to all extensions wherever authentication is required. If the permission scheme of the Content component suits your extension's needs, you can use code similar to the following to determine what functions to give to a specific user.

<pre>
$user =& JFactory::getUser();

if ($user->authorize('com_content', 'edit', 'content', 'all')) {
echo "You may edit all content.";
} else {
echo "You may not edit all content.";
}

if ($user->authorize('com_content', 'publish', 'content', 'own')) {
echo "You may publish your own content.";
} else {
echo "You may not publish your own content.";
}
</pre>

The permissions for core functions may not be suitable for your extension. If this is the case, you can create your own permissions. You will probably want to add this code in a place where it will always be executed, such as the beginning of the component you are building or in a systemwide plugin. First, you need to get an authorization object using the getACL() member function of JFactory. This works like getUser() in that it only creates one authorization object during any particular Joomla! request. Once you have this object, call the addACL() member function to add permissions. Pass in the name of your component or function, the task name, the string 'users', and the user type (in lowercase) respectively. If you want to also define record sets and ownership, pass those in as an additional two parameters.

Note that in Joomla! 1.5, permissions are not inherited. For example, if you give an Administrator the right to edit content, Super Administrators do not automatically get this right; you must grant it separately.

<pre>
$auth =& JFactory::getACL();

$auth->addACL('com_userinfo15', 'persuade', 'users', 'super administrator');
$auth->addACL('com_userinfo15', 'persuade', 'users', 'administrator');
$auth->addACL('com_userinfo15', 'persuade', 'users', 'manager');

$user =& JFactory::getUser();

if ($user->authorize('com_userinfo15', 'persuade')) {
echo "You may persuade the system to do what you wish.";
} else {
echo "You are not very persuasive.";
}
</pre>

== Summary ==

Information about the current user is readily available in any part of your Joomla! extension. You need only fetch the object and access the member variables. You can authorize the user against the core permissions set, or create your own to suit your needs.

Accessing the current user object

2008-01-19T17:40:44Z

Jlleblanc: New page: {{inuse}}

How to determine a package checksum

2008-01-19T17:25:34Z

Jlleblanc: /* Apple Mac OS X */

A checksum is a string of characters created by applying a mathematical algorithm to the contents of a file. It allows you to determine whether two files are identical because changing even a single bit in a file will cause the checksum to change. Although it is possible for two different files to have the same checksum it is statistically unlikely for an error introduced during a file copy to leave the checksum unchanged. Furthermore, it is extraordinarily difficult to deliberately change a file without also changing the checksum.

Although there are several different kinds of checksum available, the Joomla! project publishes the popular MD5 checksum for all full distribution and patch files. The MD5 checksum string is always exactly 32 characters long.

==Unix-style systems (such as Linux)==
From the command line use the md5sum program. For example, here we determine the MD5 checksum for a Joomla! patch file.
<pre>
md5sum Joomla_1.0.11_to_1.0.12-Stable-Patch_Package.tar.bz2
67534a24ca89b76f5ae197ed171bd75e Joomla_1.0.11_to_1.0.12-Stable-Patch_Package.tar.bz2
</pre>
Type '''man md5sum''' at the command line for full details on the md5sum program.

==Apple Mac OS X==
Marc Liyanage has a checksum tool that can be downloaded at http://www.entropy.ch/software/macosx/#checksum. Download the zip package and double click to decompress the tool. (You can drag the tool into your Applications folder in Finder for future use.) Double click the tool and click Open File, then select the file you want to checksum.

==Microsoft Windows==
Download the free File Checksum Integrity Verifier from Microsoft here http://support.microsoft.com/kb/841290

All neccessary information and help is included in the article.

How to determine a package checksum

2008-01-19T17:19:35Z

Jlleblanc: /* Apple Mac OS X */

A checksum is a string of characters created by applying a mathematical algorithm to the contents of a file. It allows you to determine whether two files are identical because changing even a single bit in a file will cause the checksum to change. Although it is possible for two different files to have the same checksum it is statistically unlikely for an error introduced during a file copy to leave the checksum unchanged. Furthermore, it is extraordinarily difficult to deliberately change a file without also changing the checksum.

Although there are several different kinds of checksum available, the Joomla! project publishes the popular MD5 checksum for all full distribution and patch files. The MD5 checksum string is always exactly 32 characters long.

==Unix-style systems (such as Linux)==
From the command line use the md5sum program. For example, here we determine the MD5 checksum for a Joomla! patch file.
<pre>
md5sum Joomla_1.0.11_to_1.0.12-Stable-Patch_Package.tar.bz2
67534a24ca89b76f5ae197ed171bd75e Joomla_1.0.11_to_1.0.12-Stable-Patch_Package.tar.bz2
</pre>
Type '''man md5sum''' at the command line for full details on the md5sum program.

==Apple Mac OS X==
Marc Liyanage has a checksum tool that can be downloaded at http://www.entropy.ch/software/macosx/#checksum. Download the zip package and double click to decompress the tool. (You can drag the tool into your Applications folder in Finder for future use.) Double click the tool and click Open File, the select the file you want to checksum.

==Microsoft Windows==
Download the free File Checksum Integrity Verifier from Microsoft here http://support.microsoft.com/kb/841290

All neccessary information and help is included in the article.

Unpacking a package file

2008-01-19T16:40:01Z

Jlleblanc: /* Apple Mac OS X */

Package files are generally distributed in one of three formats that are supported by Joomla! These can be distinguished by the file extension used and are briefly described below.

==Package file types==
===.zip===
These files are packed using the proprietary ZIP file format. This is the most widely used compression format on Microsoft Windows systems, but it can also be used on Unix-style systems. For more information see [[wikipedia:ZIP (file format)|ZIP (file format) on Wikipedia]]
===.tar.gz===
These files are packed using the TAR (for "tape archive") format, then compressed using the open source Gnu Zip file format. This is the primary compression method used on Unix-style systems, but is also supported on other platforms. For more information see [[wikipedia:gzip|gzip on Wikipedia]]
===.tar.bz2===
These files are packed using the TAR (for "tape archive") format, then compressed using the open source bzip2 file format. This is an increasingly popular compression method on Unix-style systems, but is also supported on other platforms. For more information see [[wikipedia:bzip2|bzip2 on Wikipedia]]

==Programs available to unpack a package file==
How you go about unpacking a package file depends largely on what platform you are running on. Listed below are some of the major platforms and some suggested programs that you can use to unpack package files. See also [[wikipedia:Comparison of file archivers|Comparison of file archivers on Wikipedia]].

===Unix-style systems (such as Linux)===
* The command line '''unzip''' program can be used to unpack .zip files. Enter ''man unzip'' at the command prompt for details. The man page can also be read online [http://linux.die.net/man/1/unzip here].
* The command line '''gunzip''' program can be used to unpack .tar.gz and .tar.bz2 files. Enter ''man gunzip'' at the command prompt for details. The man page can also be read online [http://linux.die.net/man/1/gunzip here].
* The Gnome '''File Roller''' application can be used to unpack all three package file formats. See [[wikipedia:File Roller|File Roller on Wikipedia]].
* The KDE '''Ark''' application acts as a front-end for various command line programs including unzip and gunzip. See [[wikipedia:Ark (computing)|Ark on Wikipedia]].

===Microsoft Windows===
XP users can right-click the downloaded zip package and select 'Extract all' from the menu. This opens the 'Extraction Wizard' which, by default, creates a new folder for the extracted data when the user continually clicks the 'Next' button followed by 'Finish'.

For more control over the zip process, XP users can download and install [[wikipedia:7zip 7zip]], a widely-used open source compression utility.

<Can someone please do Vista Instructions???>

===Apple Mac OS X===
Apple OS X users can double-click the downloaded .zip, .tar.gz, or .tar.bz2 archive. This will automatically create a folder with the decompressed files. You can also use the "Unix-style systems" instructions.