Tuesday, June 22, 2010

Fedex Rate Calculation

First create "xmlparser.php" page

xmlparser.php :

class xmlparser
{

    function GetChildren($vals, &$i)
    {
        $children = array();
   
   
        if (isset($vals[$i]['value']))
            $children['VALUE'] = $vals[$i]['value'];
   
   
        while (++$i < count($vals))
        {
            switch ($vals[$i]['type'])
            {
                case 'cdata':
                    if (isset($children['VALUE']))
                        $children['VALUE'] .= $vals[$i]['value'];
                    else
                        $children['VALUE'] = $vals[$i]['value'];
                    break;
   
                case 'complete':
                    if (isset($vals[$i]['attributes'])) {
                        $children[$vals[$i]['tag']][]['ATTRIBUTES'] = $vals[$i]['attributes'];
                        $index = count($children[$vals[$i]['tag']])-1;
   
                        if (isset($vals[$i]['value']))
                            $children[$vals[$i]['tag']][$index]['VALUE'] = $vals[$i]['value'];
                        else
                            $children[$vals[$i]['tag']][$index]['VALUE'] = '';
                    } else {
                        if (isset($vals[$i]['value']))
                            $children[$vals[$i]['tag']][]['VALUE'] = $vals[$i]['value'];
                        else
                            $children[$vals[$i]['tag']][]['VALUE'] = '';
            }
                    break;
   
                case 'open':
                    if (isset($vals[$i]['attributes'])) {
                        $children[$vals[$i]['tag']][]['ATTRIBUTES'] = $vals[$i]['attributes'];
                        $index = count($children[$vals[$i]['tag']])-1;
                        $children[$vals[$i]['tag']][$index] = array_merge($children[$vals[$i]['tag']][$index],$this->GetChildren($vals, $i));
                    } else {
                        $children[$vals[$i]['tag']][] = $this->GetChildren($vals, $i);
                    }
                    break;
   
                case 'close':
                    return $children;
            }
        }
    }

    function GetXMLTree($xml)
    {
        $data = $xml;
      
        $parser = xml_parser_create();
        xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
        xml_parse_into_struct($parser, $data, $vals, $index);
        xml_parser_free($parser);
       
        //print_r($index);
   
        $tree = array();
        $i = 0;
       
        if (isset($vals[$i]['attributes'])) {
        $tree[$vals[$i]['tag']][]['ATTRIBUTES'] = $vals[$i]['attributes'];
        $index = count($tree[$vals[$i]['tag']])-1;
        $tree[$vals[$i]['tag']][$index] =    array_merge($tree[$vals[$i]['tag']][$index], $this->GetChildren($vals, $i));
        }
        else
            $tree[$vals[$i]['tag']][] = $this->GetChildren($vals, $i);
       
        return $tree;
    }
   
    function printa($obj) {
        global $__level_deep;
        if (!isset($__level_deep)) $__level_deep = array();
   
        if (is_object($obj))
            print '[obj]';
        elseif (is_array($obj)) {
            foreach(array_keys($obj) as $keys) {
                array_push($__level_deep, "[".$keys."]");
                $this->printa($obj[$keys]);
                array_pop($__level_deep);
            }
        }
        else print implode(" ",$__level_deep)." = $obj\n";
    }
}
?>

==================================================


Next create "fedex.php" page

fedex.php :

require_once("xmlparser.php");

function bcdivs( $first, $second, $scale = 0 ) {
    $res = $first / $second;
    return round( $res, $scale );
}

class Fedex {
   
    // Variables
    var $server = "https://gatewaybeta.fedex.com/GatewayDC";
    var $accountNumber;
    var $meterNumber;
    var $carrierCode = "FDXG";
    var $dropoffType = "REGULARPICKUP";
    var $service;
    var $serviceName;
    var $packaging = "YOURPACKAGING";
    var $weightUnits = "LBS";
    var $weight;
    // Origin Address
    var $originStateOrProvinceCode;
    var $originPostalCode;
    var $originCountryCode;
    // Destination Address
    var $destStateOrProvinceCode;
    var $destPostalCode;
    var $destCountryCode;
    var $payorType = "SENDER";
   
    // Functions   
    function setServer($server) {
        $this->server = $server;
    }

    function setAccountNumber($accountNumber) {
        $this->accountNumber = $accountNumber;
    }

    function setMeterNumber($meterNumber) {
        $this->meterNumber = $meterNumber;
    }

    function setCarrierCode($carrierCode) {
        $this->carrierCode = $carrierCode;
    }
   
    function setDropoffType($dropoffType) {
        $this->dropoffType = $dropoffType;
    }

    function setService($service, $name) {
        $this->service = $service;
        $this->serviceName = $name;
    }

    function setPackaging($packaging) {
        $this->packaging = $packaging;
    }
   
    function setWeightUnits($units) {
        $this->weightUnits = $units;
    }
   
    function setWeight($weight) {
        $this->weight = $weight;
    }
   
    function setOriginStateOrProvinceCode($code) {
        $this->originStateOrProvinceCode = $code;
    }
   
    function setOriginPostalCode($code) {
        $this->originPostalCode = $code;
    }
   
    function setOriginCountryCode($code) {
        $this->originCountryCode = $code;
    }
   
    function setDestStateOrProvinceCode($code) {
        $this->destStateOrProvinceCode = $code;
    }
   
    function setDestPostalCode($code) {
        $this->destPostalCode = $code;
    }
   
    function setDestCountryCode($code) {
        $this->destCountryCode = $code;
    }
   
    function setPayorType($type) {
        $this->payorType = $type;
    }
   
    function getPrice() {
       
        $str = '';
        $str .= '    ';
        $str .= '        ';
        $str .= '            Express Rate';
        $str .= '            '.$this->accountNumber.'';
        $str .= '            '.$this->meterNumber.'';
        $str .= '            '.$this->carrierCode.'';
        $str .= '       
';
        $str .= '        '.$this->dropoffType.'';
        $str .= '        '.$this->service.'';
        $str .= '        '.$this->packaging.'';
        $str .= '        '.$this->weightUnits.'';
        $str .= '        '.number_format($this->weight, 1, '.', '').'';
        $str .= '        ';
        $str .= '            '.$this->originStateOrProvinceCode.'';
        $str .= '            '.$this->originPostalCode.'';
        $str .= '            '.$this->originCountryCode.'';
        $str .= '       
';
        $str .= '        ';
        $str .= '            '.$this->destStateOrProvinceCode.'';
        $str .= '            '.$this->destPostalCode.'';
        $str .= '            '.$this->destCountryCode.'';
        $str .= '       
';
        $str .= '        ';
        $str .= '            '.$this->payorType.'';
        $str .= '       
';
        $str .= '        '.ceil(bcdivs(number_format($this->weight, 1, '.', ''), '150', 3)).'';
        $str .= '   
';
      
        $header[] = "Host: canvasgrafix.com";
        $header[] = "MIME-Version: 1.0";
        $header[] = "Content-type: multipart/mixed; boundary=----doc";
        $header[] = "Accept: text/xml";
        $header[] = "Content-length: ".strlen($str);
        $header[] = "Cache-Control: no-cache";
        $header[] = "Connection: close \r\n";
        $header[] = $str;

        $ch = curl_init();
        //Disable certificate check.
        // uncomment the next line if you get curl error 60: error setting certificate verify locations
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
        // uncommenting the next line is most likely not necessary in case of error 60
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
        //-------------------------
        //curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);
        //curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
        //curl_setopt($ch, CURLOPT_CAINFO, "c:/ca-bundle.crt");
        //-------------------------
        curl_setopt($ch, CURLOPT_URL,$this->server);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_TIMEOUT, 4);
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST,'POST');
        curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
           
        $data = curl_exec($ch);       

        //print_r($data);
       
       
        if (curl_errno($ch)) {
            $this->getPrice();
        } else {
            // close curl resource, and free up system resources
            curl_close($ch);
            $xmlParser = new xmlparser();
            $array = $xmlParser->GetXMLTree($data);
            //$xmlParser->printa($array);
            if (!empty($array['FDXRATEREPLY'])) {
                if(!empty($array['FDXRATEREPLY'][0]['ERROR'])) { // If it is error
                    $error = new fedexError();
                    $error->number = $array['FDXRATEREPLY'][0]['ERROR'][0]['CODE'][0]['VALUE'];
                    $error->description = $array['FDXRATEREPLY'][0]['ERROR'][0]['MESSAGE'][0]['VALUE'];
                    $error->response = $array;
                    $this->error = $error;
                } else if (count($array['FDXRATEREPLY'][0]['ESTIMATEDCHARGES'][0]['DISCOUNTEDCHARGES'][0]['NETCHARGE'])) {
                    $price = new fedexPrice();
                    $price->rate = $array['FDXRATEREPLY'][0]['ESTIMATEDCHARGES'][0]['DISCOUNTEDCHARGES'][0]['NETCHARGE'][0]['VALUE'];
                    $price->service = $this->serviceName;
                    $price->response = $array;
                    $this->price = $price;           
                }
            }
            //print_r($this); echo " Test1: "; exit();
            return $this;
        }
    }
}
class fedexError
{
    var $number;
    var $description;
    var $response;
}
class fedexPrice
{
    var $service;
    var $rate;
    var $response;
}
?>

==================================================

Next create "rate.php" page

rate.php : 


function ship_rate() {
        $dest_state = strtoupper($dest_state);
       
        require_once('fedex.php');

        $fedex = new Fedex;
        $fedex->setServer("https://gatewaybeta.fedex.com/GatewayDC");
        $fedex->setAccountNumber(#######); // You need your own
        $fedex->setMeterNumber(########);    // You need your own
        $fedex->setCarrierCode("FDXG");
        $fedex->setDropoffType("REGULARPICKUP");
        $fedex->setService('FEDEXGROUND', 'FedEx Ground');
        $fedex->setPackaging("YOURPACKAGING");
        $fedex->setWeightUnits("LBS");
        $fedex->setWeight("3.33");
        $fedex->setOriginStateOrProvinceCode("MO");
        $fedex->setOriginPostalCode(63110);
        $fedex->setOriginCountryCode("US");
        $fedex->setDestStateOrProvinceCode("MA");
        $fedex->setDestPostalCode("02116");
        $fedex->setDestCountryCode("US");
        $fedex->setPayorType("SENDER");

        $price = $fedex->getPrice();

        $rate = ($price->price->rate + ($price->price->rate*1.00));
       
        $rate = round($rate,2);
        return $rate;

    }
    echo "Price : $".$vals=ship_rate();
?>



Now the Result will come from FEDEX.. Enjoy with this code..

libcurl-errors

NAME

libcurl-errors - error codes in libcurl

DESCRIPTION

This man page includes most, if not all, available error codes in libcurl. Why they occur and possibly what you can do to fix the problem are also included.

CURLcode

Almost all "easy" interface functions return a CURLcode error code. No matter what, using the curl_easy_setopt(3) option CURLOPT_ERRORBUFFER is a good idea as it will give you a human readable error string that may offer more details about the cause of the error than just the error code. curl_easy_strerror(3) can be called to get an error string from a given CURLcode number.
CURLcode is one of the following:
CURLE_OK (0)
All fine. Proceed as usual.
CURLE_UNSUPPORTED_PROTOCOL (1)
The URL you passed to libcurl used a protocol that this libcurl does not support. The support might be a compile-time option that you didn't use, it can be a misspelled protocol string or just a protocol libcurl has no code for.
CURLE_FAILED_INIT (2)
Very early initialization code failed. This is likely to be an internal error or problem.
CURLE_URL_MALFORMAT (3)
The URL was not properly formatted.
CURLE_COULDNT_RESOLVE_PROXY (5)
Couldn't resolve proxy. The given proxy host could not be resolved.
CURLE_COULDNT_RESOLVE_HOST (6)
Couldn't resolve host. The given remote host was not resolved.
CURLE_COULDNT_CONNECT (7)
Failed to connect() to host or proxy.
CURLE_FTP_WEIRD_SERVER_REPLY (8)
After connecting to a FTP server, libcurl expects to get a certain reply back. This error code implies that it got a strange or bad reply. The given remote server is probably not an OK FTP server.
CURLE_REMOTE_ACCESS_DENIED (9)
We were denied access to the resource given in the URL. For FTP, this occurs while trying to change to the remote directory.
CURLE_FTP_WEIRD_PASS_REPLY (11)
After having sent the FTP password to the server, libcurl expects a proper reply. This error code indicates that an unexpected code was returned.
CURLE_FTP_WEIRD_PASV_REPLY (13)
libcurl failed to get a sensible result back from the server as a response to either a PASV or a EPSV command. The server is flawed.
CURLE_FTP_WEIRD_227_FORMAT (14)
FTP servers return a 227-line as a response to a PASV command. If libcurl fails to parse that line, this return code is passed back.
CURLE_FTP_PRET_FAILED (84)
The FTP server does not understand the PRET command at all or does not support the given argument. Be careful when using CURLOPT_CUSTOMREQUEST, a custom LIST command will be sent with PRET CMD before PASV as well. (Added in 7.20.0)
CURLE_FTP_CANT_GET_HOST (15)
An internal failure to lookup the host used for the new connection.
CURLE_FTP_COULDNT_SET_TYPE (17)
Received an error when trying to set the transfer mode to binary or ASCII.
CURLE_PARTIAL_FILE (18)
A file transfer was shorter or larger than expected. This happens when the server first reports an expected transfer size, and then delivers data that doesn't match the previously given size.
CURLE_FTP_COULDNT_RETR_FILE (19)
This was either a weird reply to a 'RETR' command or a zero byte transfer complete.
CURLE_QUOTE_ERROR (21)
When sending custom "QUOTE" commands to the remote server, one of the commands returned an error code that was 400 or higher (for FTP) or otherwise indicated unsuccessful completion of the command.
CURLE_HTTP_RETURNED_ERROR (22)
This is returned if CURLOPT_FAILONERROR is set TRUE and the HTTP server returns an error code that is >= 400.
CURLE_WRITE_ERROR (23)
An error occurred when writing received data to a local file, or an error was returned to libcurl from a write callback.
CURLE_UPLOAD_FAILED (25)
Failed starting the upload. For FTP, the server typically denied the STOR command. The error buffer usually contains the server's explanation for this.
CURLE_READ_ERROR (26)
There was a problem reading a local file or an error returned by the read callback.
CURLE_OUT_OF_MEMORY (27)
A memory allocation request failed. This is serious badness and things are severely screwed up if this ever occurs.
CURLE_OPERATION_TIMEDOUT (28)
Operation timeout. The specified time-out period was reached according to the conditions.
CURLE_FTP_PORT_FAILED (30)
The FTP PORT command returned error. This mostly happens when you haven't specified a good enough address for libcurl to use. See CURLOPT_FTPPORT.
CURLE_FTP_COULDNT_USE_REST (31)
The FTP REST command returned error. This should never happen if the server is sane.
CURLE_RANGE_ERROR (33)
The server does not support or accept range requests.
CURLE_HTTP_POST_ERROR (34)
This is an odd error that mainly occurs due to internal confusion.
CURLE_SSL_CONNECT_ERROR (35)
A problem occurred somewhere in the SSL/TLS handshake. You really want the error buffer and read the message there as it pinpoints the problem slightly more. Could be certificates (file formats, paths, permissions), passwords, and others.
CURLE_BAD_DOWNLOAD_RESUME (36)
The download could not be resumed because the specified offset was out of the file boundary.
CURLE_FILE_COULDNT_READ_FILE (37)
A file given with FILE:// couldn't be opened. Most likely because the file path doesn't identify an existing file. Did you check file permissions?
CURLE_LDAP_CANNOT_BIND (38)
LDAP cannot bind. LDAP bind operation failed.
CURLE_LDAP_SEARCH_FAILED (39)
LDAP search failed.
CURLE_FUNCTION_NOT_FOUND (41)
Function not found. A required zlib function was not found.
CURLE_ABORTED_BY_CALLBACK (42)
Aborted by callback. A callback returned "abort" to libcurl.
CURLE_BAD_FUNCTION_ARGUMENT (43)
Internal error. A function was called with a bad parameter.
CURLE_INTERFACE_FAILED (45)
Interface error. A specified outgoing interface could not be used. Set which interface to use for outgoing connections' source IP address with CURLOPT_INTERFACE.
CURLE_TOO_MANY_REDIRECTS (47)
Too many redirects. When following redirects, libcurl hit the maximum amount. Set your limit with CURLOPT_MAXREDIRS.
CURLE_UNKNOWN_TELNET_OPTION (48)
An option set with CURLOPT_TELNETOPTIONS was not recognized/known. Refer to the appropriate documentation.
CURLE_TELNET_OPTION_SYNTAX (49)
A telnet option string was Illegally formatted.
CURLE_PEER_FAILED_VERIFICATION (51)
The remote server's SSL certificate or SSH md5 fingerprint was deemed not OK.
CURLE_GOT_NOTHING (52)
Nothing was returned from the server, and under the circumstances, getting nothing is considered an error.
CURLE_SSL_ENGINE_NOTFOUND (53)
The specified crypto engine wasn't found.
CURLE_SSL_ENGINE_SETFAILED (54)
Failed setting the selected SSL crypto engine as default!
CURLE_SEND_ERROR (55)
Failed sending network data.
CURLE_RECV_ERROR (56)
Failure with receiving network data.
CURLE_SSL_CERTPROBLEM (58)
problem with the local client certificate.
CURLE_SSL_CIPHER (59)
Couldn't use specified cipher.
CURLE_SSL_CACERT (60)
Peer certificate cannot be authenticated with known CA certificates.
CURLE_BAD_CONTENT_ENCODING (61)
Unrecognized transfer encoding.
CURLE_LDAP_INVALID_URL (62)
Invalid LDAP URL.
CURLE_FILESIZE_EXCEEDED (63)
Maximum file size exceeded.
CURLE_USE_SSL_FAILED (64)
Requested FTP SSL level failed.
CURLE_SEND_FAIL_REWIND (65)
When doing a send operation curl had to rewind the data to retransmit, but the rewinding operation failed.
CURLE_SSL_ENGINE_INITFAILED (66)
Initiating the SSL Engine failed.
CURLE_LOGIN_DENIED (67)
The remote server denied curl to login (Added in 7.13.1)
CURLE_TFTP_NOTFOUND (68)
File not found on TFTP server.
CURLE_TFTP_PERM (69)
Permission problem on TFTP server.
CURLE_REMOTE_DISK_FULL (70)
Out of disk space on the server.
CURLE_TFTP_ILLEGAL (71)
Illegal TFTP operation.
CURLE_TFTP_UNKNOWNID (72)
Unknown TFTP transfer ID.
CURLE_REMOTE_FILE_EXISTS (73)
File already exists and will not be overwritten.
CURLE_TFTP_NOSUCHUSER (74)
This error should never be returned by a properly functioning TFTP server.
CURLE_CONV_FAILED (75)
Character conversion failed.
CURLE_CONV_REQD (76)
Caller must register conversion callbacks.
CURLE_SSL_CACERT_BADFILE (77)
Problem with reading the SSL CA cert (path? access rights?)
CURLE_REMOTE_FILE_NOT_FOUND (78)
The resource referenced in the URL does not exist.
CURLE_SSH (79)
An unspecified error occurred during the SSH session.
CURLE_SSL_SHUTDOWN_FAILED (80)
Failed to shut down the SSL connection.
CURLE_AGAIN (81)
Socket is not ready for send/recv wait till it's ready and try again. This return code is only returned from curl_easy_recv(3) and curl_easy_send(3) (Added in 7.18.2)
CURLE_SSL_CRL_BADFILE (82)
Failed to load CRL file (Added in 7.19.0)
CURLE_SSL_ISSUER_ERROR (83)
Issuer check failed (Added in 7.19.0)
CURLE_FTP_PRET_FAILED (84)
PRET command failed
CURLE_RTSP_CSEQ_ERROR (85)
Mismatch of RTSP CSeq numbers.
CURLE_RTSP_SESSION_ERROR (86)
Mismatch of RTSP Session Identifiers.
CURLE_FTP_BAD_FILE_LIST (87)
Unable to parse FTP file list (during FTP wildcard downloading).
CURLE_CHUNK_FAILED (88)
Chunk callback reported error.
CURLE_OBSOLETE*
These error codes will never be returned. They were used in an old libcurl version and are currently unused.

CURLMcode

This is the generic return code used by functions in the libcurl multi interface. Also consider curl_multi_strerror(3).
CURLM_CALL_MULTI_PERFORM (-1)
This is not really an error. It means you should call curl_multi_perform(3) again without doing select() or similar in between.
CURLM_OK (0)
Things are fine.
CURLM_BAD_HANDLE (1)
The passed-in handle is not a valid CURLM handle.
CURLM_BAD_EASY_HANDLE (2)
An easy handle was not good/valid. It could mean that it isn't an easy handle at all, or possibly that the handle already is in used by this or another multi handle.
CURLM_OUT_OF_MEMORY (3)
You are doomed.
CURLM_INTERNAL_ERROR (4)
This can only be returned if libcurl bugs. Please report it to us!
CURLM_BAD_SOCKET (5)
The passed-in socket is not a valid one that libcurl already knows about. (Added in 7.15.4)
CURLM_UNKNOWN_OPTION (6)
curl_multi_setopt() with unsupported option (Added in 7.15.4)

CURLSHcode

The "share" interface will return a CURLSHcode to indicate when an error has occurred. Also consider curl_share_strerror(3).
CURLSHE_OK (0)
All fine. Proceed as usual.
CURLSHE_BAD_OPTION (1)
An invalid option was passed to the function.
CURLSHE_IN_USE (2)
The share object is currently in use.
CURLSHE_INVALID (3)
An invalid share object was passed to the function.
CURLSHE_NOMEM (4)
Not enough memory was available. (Added in 7.12.0)

Saturday, June 5, 2010

Porter Stemmer


Porter Stemmer

A PHP5 only class to faciliate the stemming of word. This is the process of removing suffixs from words to produce their "stems", eg national -> nation, running -> run, adoption -> adopt. This class, as the name might suggest, implements the algorithm by Martin Porter.

Usage

The public API is very simple, consisting of one function. The function takes two arguments, one being the word you wish to stem, and the optional second being whether to use the built in cache or not. Only use the cache if you know you might be stemming the same word multiple times.
    $stem PorterStemmer::Stem("nationalize");?>A difference from the published code, is that this version also removes English suffixes, eg "ise" as well as "ize".

FileIterator


FileIterator

A truly superb addition to PHP5 was the ability for a foreach() loop to loop over objects in a user definable way, assuming they implement the Iterator interface. This means you can create custom objects that handle a common loop operation, and use foreach() to perform the loop in your code.
The FileIterator class takes advantage of this to enable you to very easily loop over each line of a file, without having to write the same code over and over again. If that didn't mean much to you, have a look at this...

The "old" way

    $fp fopen('myFile.txt''rb');
  
    if (
$fp) {
        while (!
feof($fp)) {
            
$line fgets($fp1024);
          
            
// Do stuff with $line...
        
}
    }
?>

The "new" way

    foreach (new FileIterator('myFile.txt') as $line) {
        
// Do stuff with $line...
    
}?>
How goddamn sexy is that? FYI, you can if you wish specify a read buffer size to the constructor, which the calls to fgets() will use.

PEAR::DB database replacement


PEAR::DB database replacement



EAR::DB is all well and good if you want to connect to multiple databases (I assume, I've never actually used it with anything other than mysql) but it is somewhat hefty on the bad side of 60k. Not a good thing if you're not using some sort of accelerator and have a high traffic site. Here's a class which replicates the PEAR::DB API (the bits that I use anyhoo) and weighs in at a much nicer ~11k. Sweet. Grab it from the download section.
Documentation
The documentation for the API (if you're using PEaR::DB then you probably know most of it already) is in the archive.

RGrid for PHP: Datagrid class for PHP & MySQL


RGrid for PHP: Datagrid class for PHP & MySQL


Introduction

This is a PHP datagrid class which can show the MySQL result set which you pass to it as a paged list. It can be completely styled using CSS (which looking at the examples, I'm sure you'll be grateful for). A quick example:

/**
    * Include the RGrid code
    */
    require_once('RGrid.php');
    
    $params['hostname'] = 'localhost';
    $params['username'] = 'root';
    $params['password'] = '[PASSWORD]';
    $params['database'] = 'phpguru';

    $sql = "SELECT cm_id,
                   ne_title,
                   cm_author,
                   cm_datetime,
                   cm_status,
                   cm_neid
              FROM comments,
                   news
             WHERE cm_status = 'ACTIVE'
               AND cm_neid = ne_id
          ORDER BY cm_id DESC";

    /**
    * Create the datagrid with the connection parameters and SQL query
    * defined above. You MUST specify an ORDER BY
    * clause (with ASC/DESC direction indicator) - if not then ordering
    * will be disabled.
    */
    $grid = RGrid::Create($params, $sql);
    
    $grid->Display();
?>
This will show a bare bones list of comments from this website. You will probably want to customise this quite a bit (appearance wise), which you can do with CSS, and with the various methods available to you (eg.SetDisplayNames()).

Features

  • Order by any of the columns in both ascending and descending directions
  • Tailored to MySQL
  • Allows any HTML in the columns (eg. Pictures)
  • Easily change the look and feel by using CSS
  • Friendly column names
  • Alternative column or row color for easy reading
  • Customisable mouse over highlight
  • You can hide columns
  • Automatic record paging (defaults to 25 records per page)
  • Fully supports all browsers: Internet Explorer, Firefox, Chrome, Safari and Opera
  • Handles large database recordsets.

Examples

Below is an IFRAME showing one of the example scripts which you can get from the download area. Bear in mind that the example scripts look more complicated than would be typical as they show off everything (or try to) and the HTML and CSS are in the same file as the PHP.

Example 1 :: Example 2 :: Example 3 :: Example 4 :: Example 5 :: Example 6 :: Example 7 :: Example 8Example 9 


Customisation

You can customise the "look and feel" using CSS. The grid uses a single table, which has the class datagrid. The headers are inside a tag, and the paging correspondingly in a tag. Using CSS you can then create corresponding CSS rules for them:

.datagrid thead th {
    background-color: #ddd;
    border-top: 2px solid #bbb;
    padding-left: 5px;
    text-align: left;
}
Naturally the body of the table uses a along with cells.

Structure

The tag structure of the datagrid is explained by this picture. Consider it "nice" structure, as it should be. The table has a class attribute of datagrid, the headers are in cells, which themselves are in a tag. The body rows are in cells, and a tag. And the footer is in a tag.
Doing it this way allows finer grained control over the style. eg: .datagrid thead th is the CSS selector that you would use to change the style of the headers.

Method reference

What follows is a list of public methods and what they do. You will probably be able to guess from their names though. They're in no particular order.

Static methods

  • RGrid::CreateFromArray($array)
    Returns an RGrid object created using the (associative) array that you pass to it (called statically).
  • RGrid::Create($connection[, $sql])
    Returns an RGrid object based on the parameters that you pass to it. $connection can either be a MySQL connection and the second an SQL query which provides the desired results. Or $connection can be an (associative) array (and the second argument omitted) to create a datagrid based on that.

Regular methods

  • Constructor (eg $grid = new RGrid($connection[, $resultset]))
    Creates a new RGrid object. You should pass it your MySQL connection ($connection) and the result set that was returned from your call to mysql_query(). The result set is what the datagrid will show. If you want an array based datagrid then you can pass an array as the first argument and no second argument. There's no real difference between using the second method versus the static shortcut methods above. 
  • $grid->SetDisplayNames($names)
    This function sets the display names of the columns. You should pass it an associative array of column names (the actual column name as the index, and the desired name as the value). See the example scripts for an example. 
  • $grid->HideColumn('column', ...)
    Specifies the given column names (actual names) as hidden - ie not displayed. Give one or more column names. 
  • $grid->NoSpecialChars('column', ...)
    Specifies that the given column names will not have htmlspecialchars() applied to them. You need to use this if you want to have HTML in your column. 
  • $grid->NoSort('column', ...)
    Specifies the given column names cannot be sorted (ie they're not linked). Give the function one or more column names. 
  • $grid->GetPageCount()
    Returns the number of pages in the dataset. 
  • $grid->GetRowCount()
    Returns the number of rows in the result set. 
  • $grid->GetResultset()
    Returns the underlying MySQL result set. 
  • $grid->GetConnection()
    Returns the under lying MySQL connection. 
  • $grid->SetHeaderHTML($html)
    Sets the header HTML that is displayed above the actual datagrid. This is not related to the column headers - it is displayed above the actual datagrid. 
  • $grid->SetConnection($connection)
    Sets the MySQL connection. Not that you should need to, but here it is. 
  • $grid->SetPerPage($num)
    Sets the amount of rows that are displayed per page. 
  • $grid->SetResultset($resultset)
    Sets the MySQL result set that is used to make the datagrid. 
  • $grid->AddCallback($function)
    This is what you can use to customise the datagrid. The argument is the name of a function that is called for every row in the datagrid. The function is passed the row as the only argument. Specify the argument to be passed by reference. Like this:




    $grid->AddCallback('RowCallback');
    
    function RowCallback(&$row)
    {
        if ($row['status'] == 'PASS') {
            $row['status'] = 'PASS';
        } else {
            $row['status'] = 'FAIL';
        }
    }

  • $grid->Display()
    Shows the datagrid. If you want it assigned to a variable, then you can use output buffering (ob_start() etc).