PHP Cookbook/Client-Side PHP - Revision history

PHP Cookbook/Client-Side PHP - Revision history http://commons.oreilly.com/wiki/index.php?title=PHP_Cookbook/Client-Side_PHP&action=history Revision history for this page on the wiki en MediaWiki 1.11.0 Wed, 22 May 2013 10:31:18 GMT Docbook2Wiki: Initial conversion from Docbook http://commons.oreilly.com/wiki/index.php?title=PHP_Cookbook/Client-Side_PHP&diff=7332&oldid=prev <p>Initial conversion from Docbook</p> <table style="background-color: white; color:black;"> <col class='diff-marker' /> <col class='diff-content' /> <col class='diff-marker' /> <col class='diff-content' /> <tr> <td colspan='2' style="background-color: white; color:black;">←Older revision</td> <td colspan='2' style="background-color: white; color:black;">Revision as of 13:36, 7 March 2008</td> </tr> </table> Fri, 07 Mar 2008 13:36:04 GMT Docbook2Wiki http://commons.oreilly.com/wiki/index.php/Talk:PHP_Cookbook/Client-Side_PHP Evanlenz: 1 revision(s) http://commons.oreilly.com/wiki/index.php?title=PHP_Cookbook/Client-Side_PHP&diff=3143&oldid=prev <p>1 revision(s)</p> <table style="background-color: white; color:black;"> <col class='diff-marker' /> <col class='diff-content' /> <col class='diff-marker' /> <col class='diff-content' /> <tr> <td colspan='2' style="background-color: white; color:black;">←Older revision</td> <td colspan='2' style="background-color: white; color:black;">Revision as of 22:30, 6 March 2008</td> </tr> </table> Thu, 06 Mar 2008 22:30:17 GMT Evanlenz http://commons.oreilly.com/wiki/index.php/Talk:PHP_Cookbook/Client-Side_PHP Docbook2Wiki: Initial conversion from Docbook http://commons.oreilly.com/wiki/index.php?title=PHP_Cookbook/Client-Side_PHP&diff=3142&oldid=prev <p>Initial conversion from Docbook</p> <p><b>New page</b></p><div>{{PHP Cookbook/TOC}}<br /> <br /> <br /> == Introduction ==<br /> <br /> PHP was created for web programming and is still used mostly for that purpose. However, newer versions of PHP are increasingly more capable as a general-purpose scripting language. Using PHP for scripts you run from the command line is especially helpful when they share code with your web applications. If you have a discussion board on your web site, you might want to run a program every few minutes or hours to scan new postings and alert you to any messages that contain certain keywords. Writing this scanning program in PHP lets you share relevant discussion-board code with the main discussion-board application. Not only does this save you time, but also helps avoid maintenance overhead down the road.<br /> <br /> With the PHP-GTK extension, your command-line PHP programs can be full-featured GUI applications. These can also share code with PHP web applications and text-based command-line programs. Like PHP, PHP-GTK is cross-platform, so the same code runs on Unix and Windows.<br /> <br /> The same PHP binary built to be executed as a CGI program can be run from the command line. To run a script, pass the script filename as an argument:<br /> <br /> % '''php scan-discussions.php'''<br /> <br /> <br /> On Unix, you can also use the "hash-bang" syntax at the top of your scripts to run the PHP interpreter automatically. If the PHP binary is in ''/usr/local/bin'', make the first line of your script:<br /> <br /> #!/usr/local/bin/php<br /> <br /> You can then run the script just by typing its name on the command line, as long as the file has execute permission.<br /> <br /> Command-line PHP scripts almost always use the <tt>-q</tt> flag, which prevents PHP from printing HTTP response headers at the beginning of its output:<br /> <br /> % '''php -q scan-discussions.php'''<br /> <br /> <br /> You can also use this:<br /> <br /> #!/usr/local/bin/php -q<br /> <br /> Another helpful option on the command line is the <tt>-c</tt> flag, which lets you specify an alternate ''php.ini'' file to load settings from. If your default ''php.ini'' file is ''/usr/local/lib/php.ini'', it can be helpful to have a separate configuration file at ''/usr/local/lib/php-commandline.ini'' with settings such as <tt>max_execution_time = 0</tt>; this ensures that your scripts don't quit after 30 seconds. Here's how to use this alternate file:<br /> <br /> % '''php -q -c /usr/local/lib/php-commandline.ini scan-discussions.php'''<br /> <br /> <br /> You can also use this :<br /> <br /> #!/usr/local/bin/php -q -c /usr/local/lib/php-commandline.ini<br /> <br /> If it's likely that you'll use some of your classes and functions both for the web and for the command line, abstract the code that needs to react differently in those different circumstances, such as HTML versus plain-text output or access to environment variables that a web server sets up. A useful tactic is to make your code aware of a global variable called <tt>$COMMAND_LINE</tt>. Set this to <tt>true</tt> at the top of your command-line scripts. You can then branch your scripts' behavior as follows:<br /> <br /> if ($GLOBALS['COMMAND_LINE']) {<br /> print "Database error: ".mysql_error()."\n";<br /> } else {<br /> print "Database error.&lt;br>";<br /> error_log(mysql_error());<br /> }<br /> <br /> This code not only adjusts the output formatting based on the context it's executing in (<tt>\n</tt> versus <tt>&lt;br></tt>), but also where the information goes. On the command line, it's helpful to the person running the program to see the error message from MySQL, but on the Web, you don't want your users to see potentially sensitive data. Instead, the code outputs a generic error message and stores the details in the server's error log for private review.<br /> <br /> Beginning with Version 4.3, PHP builds include a command-line interface (CLI) binary.<ref>The CLI binary can be built under 4.2.x versions by explicitly configuring PHP with <tt>--enable-cli</tt>.</ref> The CLI binary is similar to the CGI binary but has some important differences that make it more shell-friendly. Some configuration directives have hardcoded values with CLI; for example, the <tt>html_errors</tt> directive is set to <tt>false</tt>, and <tt>implicit_flush</tt> is set to <tt>true</tt>. The <tt>max_execution_time</tt> directive is set to 0, allowing unlimited program runtime. Finally, <tt>register_argc_argv</tt> is set to <tt>true</tt>. This means you can look for argument information in <tt>$argv</tt> and <tt>$argc</tt> instead of in <tt>$_SERVER['argv']</tt> and <tt>$_SERVER['argc']</tt>. Argument processing is discussed in [[PHP Cookbook/Client-Side PHP#Parsing Program Arguments|Recipe 20.2]] and [[PHP Cookbook/Client-Side PHP#Parsing Program Arguments with getopt|Recipe 20.3]].<br /> <br /> The CLI binary accepts a slightly different set of arguments than the CGI binary. It doesn't accept the <tt>-q</tt> or <tt>-C</tt> flags because it does what these flags indicate by default. While <tt>-q</tt> tells the CGI binary not to print headers, the CLI binary never prints headers. Even the <tt>header( )</tt> function produces no output under CLI. Similarly, the <tt>-C</tt> flag tells the CGI binary not to change to the directory of the script being run. The CLI binary never changes to the script directory.<br /> <br /> The CLI binary also takes one new argument: <tt>-r</tt>. When followed by some PHP code without <tt><?php</tt> and <tt>?></tt> script tags, the CLI binary runs the code. For example, here's how to print the current time:<br /> <br /> % '''php -r 'print strftime("%c");''''<br /> <br /> <br /> Finally, the CLI binary defines handles to the standard I/O streams as the constants <tt>STDIN</tt>, <tt>STDOUT</tt>, and <tt>STDERR</tt>. You can use these instead of creating your own file handles with <tt>fopen( )</tt> :<br /> <br /> // read from standard in<br /> $input = fgets(STDIN,1024);<br /> <br /> // write to standard out<br /> fwrite(STDOUT,$jokebook);<br /> <br /> // write to standard error<br /> fwrite(STDERR,$error_code);<br /> <br /> If you're using the CLI binary, you can use <tt>php_sapi_name( )</tt> instead of <tt>$GLOBALS['COMMAND_LINE']</tt> to test whether a script is running in a web or command-line context:<br /> <br /> if ('cli' == php_sapi_name()) {<br /> print "Database error: ".mysql_error()."\n";<br /> } else {<br /> print "Database error.&lt;br>";<br /> error_log(mysql_error());<br /> }<br /> <br /> You can use the CLI binary or the CGI binary to run programs that use the PHP-GTK extension. This extension is an interface to the GTK+ toolkit, which is a library of widgets, screen drawing code, and other necessary functions for building a GUI application.<br /> <br /> Widgets are GUI interface elements such as buttons, scrollbars, windows, menus, and select boxes. To build a PHP-GTK application, your code must create widgets and arrange them on the screen. [[PHP Cookbook/Client-Side PHP#Displaying a GUI Widget in a Window|Recipe 20.6]] shows how to create and display a widget, [[PHP Cookbook/Client-Side PHP#Displaying Multiple GUI Widgets in a Window|Recipe 20.7]] shows how to arrange multiple widgets for display together, and [[PHP Cookbook/Client-Side PHP#Displaying Menus|Recipe 20.9]] explains how to display a menu bar.<br /> <br /> Widgets communicate with each other and with the rest of your program using signals. When something happens to a widget, it emits a signal; for example, when a button is clicked, it emits a <tt>clicked</tt> signal. [[PHP Cookbook/Client-Side PHP#Responding to User Actions|Recipe 20.8]] discusses how to capture these signals and take action when one is emitted. The sample application in [[PHP Cookbook/Client-Side PHP#Program: Displaying Weather Conditions|Recipe 20.11]] combines PHP-GTK with some SOAP function calls to display weather conditions around the world.<br /> <br /> To install PHP-GTK on Unix, download the latest version of PHP-GTK from ''http://gtk.php.net/download.php'' and the GTK+ libraries from ''http://www.gtk.org/download''. You also need ''libtool'' 1.4.2, ''automake'' 1.4, and ''autoconf'' 2.13 (available at ''http://www.gnu.org/directory/'' if they're not already installed on your system).<br /> <br /> Once you've downloaded all the necessary files and installed the support libraries and tools, unpack the PHP-GTK source distribution. In the PHP-GTK directory, run ''./buildconf'' to create configuration files, ''./configure'' to create makefiles, then ''make'' to build the PHP-GTK extension. Last, run ''make install'' to install the PHP-GTK extension in your PHP extensions directory. You can find detailed Unix installation instructions, including common build problems, at ''http://gtk.php.net/manual/en/install.unix.php''.<br /> <br /> To install PHP-GTK on Windows, no compiling is necessary. From ''http://gtk.php.net/download.php'', you can download a compiled PHP-GTK extension and supporting libraries. Once you've downloaded and unzipped the Windows distribution, copy the files in the ''php4'' subdirectory to your PHP binary directory (or create one if it doesn't already exist). Copy the files in the ''winnt\system32'' subdirectory to your ''system32'' directory (''C:\WINNT\SYSTEM32'' for Windows NT and Windows 2000; ''C:\WINDOWS\SYSTEM32'' for Windows 95 and Windows 98). If you don't already have a ''php.ini'' file in place, copy the ''winnt\php.ini'' file to your Windows directory (''C:\WINNT'' or ''C:\WINDOWS''). If you already have a ''php.ini'' file in place, add these lines to the end of it:<br /> <br /> [PHP-GTK]<br /> php-gtk.extensions = php_gtk_libglade.dll, php_gtk_sqpane.dll<br /> <br /> Detailed Windows installation instructions are at ''http://gtk.php.net/manual/en/install.win32.php''.<br /> <br /> On either platform, once you've installed the PHP-GTK extension, you need to use the <tt>dl( )</tt> function to load it in any script in which you want to use GTK functionality. On Windows:<br /> <br /> if (! class_exists('gtk')) {<br /> dl('php_gtk.dll');<br /> }<br /> <br /> On Unix:<br /> <br /> if (! class_exists('gtk')) {<br /> dl('php_gtk.so');<br /> }<br /> <br /> If you want the same script to run unaltered on Unix or Windows, you can load the PHP-GTK extension like this:<br /> <br /> if (! class_exists('gtk')) {<br /> dl('php_gtk.'. (((strtoupper(substr(PHP_OS,0,3))) == 'WIN')?'dll':'so'));<br /> }<br /> <br /> The GTK+ toolkit is large and powerful. PHP-GTK makes it easy to create and manipulate GTK+ objects, but designing and planning a GUI application is still a significant task. In addition to the comprehensive PHP-GTK documentation at ''http://gtk.php.net/manual/'', also take advantage of the GTK+ documentation itself at ''http://developer.gnome.org/doc/API/gtk/index.html''. The C class and function names in the GTK+ documentation map almost directly to their PHP equivalents. Also, the tutorial at ''http://www.gtk.org/tutorial/'' is for GTK+ 2.0 (not 1.2), but it is still a good introduction to the concepts and practices of GTK+ application building.<br /> <br /> == Parsing Program Arguments ==<br /> <br /> === Problem ===<br /> <br /> You want to process arguments passed on the command line.<br /> <br /> === Solution ===<br /> <br /> Look in <tt>$_SERVER['argc']</tt> for the number of arguments and <tt>$_SERVER['argv']</tt> for their values. The first argument, <tt>$_SERVER['argv'][0]</tt>, is the name of script that is being run:<br /> <br /> if ($_SERVER['argc'] != 2) {<br /> die("Wrong number of arguments: I expect only 1.");<br /> }<br /> <br /> $size = filesize($_SERVER['argv'][1]);<br /> <br /> print "I am $_SERVER[argv][0] and report that the size of ";<br /> print "$_SERVER[argv][1] is $size bytes.";<br /> <br /> === Discussion ===<br /> <br /> In order to set options based on flags passed from the command line, loop through <tt>$_SERVER['argv']</tt> from <tt>1</tt> to <tt>$_SERVER['argc']</tt>:<br /> <br /> for ($i = 1; $i < $_SERVER['argc']; $i++) {<br /> switch ($_SERVER['argv'][$i]) {<br /> case '-v':<br /> // set a flag<br /> $verbose = 1;<br /> break;<br /> case '-c':<br /> // advance to the next argument<br /> $i++;<br /> // if it's set, save the value<br /> if (isset($_SERVER['argv'][$i])) {<br /> $config_file = $_SERVER['argv'][$i];<br /> } else {<br /> // quit if no filename specified<br /> die("Must specify a filename after -c");<br /> }<br /> break;<br /> case '-q':<br /> $quiet = 1;<br /> break;<br /> default:<br /> die('Unknown argument: '.$_SERVER['argv'][$i]);<br /> break;<br /> }<br /> }<br /> <br /> In this example, the <tt>-v</tt> and <tt>-q</tt> arguments are flags that set <tt>$verbose</tt> and <tt>$quiet</tt>, but the <tt>-c</tt> argument is expected to be followed by a string. This string is assigned to <tt>$config_file</tt>.<br /> <br /> === See Also ===<br /> <br /> [[PHP Cookbook/Client-Side PHP#Parsing Program Arguments with getopt|Recipe 20.3]] for more parsing arguments with ''getopt''; documentation on <tt>$_SERVER['argc']</tt> and <tt>$_SERVER['argv']</tt> at <tt>http://www.php.net/reserved.variables</tt>.<br /> <br /> == Parsing Program Arguments with getopt ==<br /> <br /> === Problem ===<br /> <br /> You want to parse program options that may be specified as short or long options, or they may be grouped.<br /> <br /> === Solution ===<br /> <br /> Use PEAR's <tt>Console_Getopt</tt> class. Its <tt>getopt( )</tt> method can parse both short-style options such as <tt>-a</tt> or <tt>-b</tt> and long-style options such as <tt>--alice</tt> or <tt>--bob</tt>:<br /> <br /> <nowiki>$o = new Console_Getopt;<br /> <br /> // accepts -a, -b, and -c<br /> $opts = $o->getopt($_SERVER['argv'],'abc');<br /> <br /> // accepts --alice and --bob<br /> $opts = $o->getopt($_SERVER['argv'],'',array('alice','bob'));</nowiki><br /> <br /> === Discussion ===<br /> <br /> To parse short-style options, pass <tt>Console_Getopt::getopt( )</tt> the array of command-line arguments and a string specifying valid options. This example allows <tt>-a</tt>, <tt>-b</tt>, or <tt>-c</tt> as arguments, alone or in groups:<br /> <br /> $o = new Console_Getopt;<br /> $opts = $o->getopt($_SERVER['argv'],'abc');<br /> <br /> For the previous option string <tt>abc</tt>, these are valid sets of options to pass:<br /> <br /> % '''program.php -a -b -c'''<br /> % '''program.php -abc'''<br /> % '''program.php -ab -c'''<br /> <br /> <br /> The <tt>getopt( )</tt> method returns an array. The first element in the array is a list of all of the parsed options that were specified on the command line, along with their values. The second element is any specified command-line option that wasn't in the argument specification passed to <tt>getopt( )</tt>. For example, if the previous program is run as:<br /> <br /> % '''program.php -a -b sneeze'''<br /> <br /> <br /> then <tt>$opts</tt> is:<br /> <br /> Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => a<br /> [1] => <br /> )<br /> [1] => Array<br /> (<br /> [0] => b<br /> [1] => <br /> )<br /> )<br /> [1] => Array<br /> (<br /> [0] => program.php<br /> [1] => sneeze<br /> )<br /> )<br /> <br /> Put a colon after an option in the specification string to indicate that it requires a value. Two colons means the value is optional. So, <tt>ab:c:</tt>: means that <tt>a</tt> can't have a value, <tt>b</tt> must, and <tt>c</tt> can take a value if specified. With this specification string, running the program as:<br /> <br /> % '''program.php -a -b sneeze'''<br /> <br /> <br /> makes <tt>$opts</tt>:<br /> <br /> Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => a<br /> [1] => <br /> )<br /> [1] => Array<br /> (<br /> [0] => b<br /> [1] => sneeze<br /> )<br /> )<br /> [1] => Array<br /> (<br /> [0] => program.php<br /> )<br /> )<br /> <br /> Because <tt>sneeze</tt> is now set as the value of <tt>b</tt>, it is no longer in the array of unparsed options. Note that the array of unparsed options always contains the name of the program.<br /> <br /> To parse long-style arguments, supply <tt>getopt( )</tt> with an array that describes your desired arguments. Put each argument in an array element (leave off the leading <tt>--</tt>) and follow it with <tt>=</tt> to indicate a mandatory argument or <tt>= =</tt> to indicate an optional argument. This array is the third argument to <tt>getopt( )</tt>. The second argument (the string for short-style arguments) can be left blank or not, depending on whether you also want to parse short-style arguments. This example allows <tt>debug</tt> as an argument with no value, <tt>name</tt> with a mandatory value, and <tt>size</tt> with an optional value:<br /> <br /> <nowiki>require 'Console/Getopt.php';<br /> $o = new Console_Getopt;<br /> $opts = $o->getopt($_SERVER['argv'],'',array('debug','name=','size=='));</nowiki><br /> <br /> These are valid ways to run this program:<br /> <br /> % '''program.php --debug'''<br /> % '''program.php --name=Susannah'''<br /> % '''program.php --name Susannah'''<br /> % '''program.php --debug --size'''<br /> % '''program.php --size=56 --name=Susannah'''<br /> % '''program.php --name --debug'''<br /> <br /> <br /> The last example is valid (if counterproductive) because it treats <tt>--debug</tt> as the value of the <tt>name</tt> argument and doesn't consider the <tt>debug</tt> argument to be set. Values can be separated from their arguments on the command line by either a <tt>=</tt> or a space.<br /> <br /> For long-style arguments, <tt>getopt( )</tt> includes the leading <tt>--</tt> in the array of parsed arguments; for example, when run as:<br /> <br /> % '''program.php --debug --name=Susannah'''<br /> <br /> <br /> <tt>$opts</tt> is set to:<br /> <br /> Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => Array<br /> (<br /> [0] => --debug<br /> [1] => <br /> )<br /> [1] => Array<br /> (<br /> [0] => --name<br /> [1] => Susannah<br /> )<br /> )<br /> [1] => Array<br /> (<br /> [0] => program.php<br /> )<br /> )<br /> <br /> We've been using <tt>$_SERVER['argv']</tt> as the array of command-line arguments, which is fine by default. <tt>Console_Getopt</tt> provides a method, <tt>readPHPArgv( )</tt>, to look also in <tt>$argv</tt> and <tt>$HTTP_SERVER_VARS['argv']</tt> for command-line arguments. Use it by passing its results to <tt>getopt( )</tt>:<br /> <br /> <nowiki>require 'Console/Getopt.php';<br /> $o = new Console_Getopt;<br /> $opts = $o->getopt($o->readPHPArgv(),'',array('debug','name=','size=='));</nowiki><br /> <br /> Both <tt>getopt( )</tt> and <tt>readPHPArgv( )</tt> return a <tt>Getopt_Error</tt> object when these encounter an error; for example, having no option specified for an option that requires one. <tt>Getopt_Error</tt> extends the <tt>PEAR_Error</tt> base class, so you can use familiar methods to handle errors:<br /> <br /> <nowiki>require 'Console/Getopt.php';<br /> $o = new Console_Getopt;<br /> $opts = $o->getopt($o->readPHPArgv(),'',array('debug','name=','size=='));<br /> <br /> if (PEAR::isError($opts)) {<br /> print $opts->getMessage();<br /> } else {<br /> // process options<br /> }</nowiki><br /> <br /> === See Also ===<br /> <br /> [[PHP Cookbook/Client-Side PHP#Parsing Program Arguments|Recipe 20.2]] for parsing of program options without ''getopt''; documentation on <tt>Console_Getopt</tt> at ''http://pear.php.net/manual/en/core.console.getopt.php'' .<br /> <br /> == Reading from the Keyboard ==<br /> <br /> === Problem ===<br /> <br /> You need to read in some typed user input.<br /> <br /> === Solution ===<br /> <br /> Use <tt>fopen( )</tt> with the special filename ''php://stdin'':<br /> <br /> <nowiki>print "Type your message. Type '.' on a line by itself when you're done.\n";<br /> <br /> $fh = fopen('php://stdin','r') or die($php_errormsg);<br /> $last_line = false; $message = '';<br /> while (! $last_line) {<br /> $next_line = fgets($fp,1024);<br /> if (".\n" == $next_line) {<br /> $last_line = true;<br /> } else {<br /> $message .= $next_line;<br /> }<br /> }<br /> <br /> print "\nYour message is:\n$message\n";</nowiki><br /> <br /> If the Readline extension is installed, use <tt>readline( )</tt>:<br /> <br /> <nowiki>$last_line = false; $message = '';<br /> while (! $last_line) {<br /> $next_line = readline();<br /> if ('.' == $next_line) {<br /> $last_line = true;<br /> } else {<br /> $message .= $next_line."\n";<br /> }<br /> }<br /> <br /> print "\nYour message is:\n$message\n";</nowiki><br /> <br /> === Discussion ===<br /> <br /> Once you get a file handle pointing to ''stdin'' with <tt>fopen( )</tt>, you can use all the standard file-reading functions to process input (<tt>fread( )</tt>, <tt>fgets( )</tt>, etc.) The solution uses <tt>fgets( )</tt>, which returns input a line at a time. If you use <tt>fread( )</tt>, the input still needs to be newline-terminated to make <tt>fread( )</tt> return. For example, if you run:<br /> <br /> $fh = fopen('php://stdin','r') or die($php_errormsg);<br /> $msg = fread($fh,4);<br /> print "[$msg]";<br /> <br /> And type in <tt>tomato</tt> and then a newline, the output is <tt>[toma]</tt>. The <tt>fread( )</tt> grabs only four characters from ''stdin'', as directed, but still needs the newline as a signal to return from waiting for keyboard input.<br /> <br /> The Readline extension provides an interface to the GNU Readline library. The <tt>readline( )</tt> function returns a line at a time, without the ending newline. Readline allows Emacs and ''vi''-style line editing by users. You can also use it to keep a history of previously entered commands:<br /> <br /> $command_count = 1;<br /> while (true) {<br /> $line = readline("[$command_count]--> ");<br /> readline_add_history($line);<br /> if (is_readable($line)) {<br /> print "$line is a readable file.\n";<br /> }<br /> $command_count++;<br /> }<br /> <br /> This example displays a prompt with an incrementing count before each line. Since each line is added to the readline history with <tt>readline_add_history( )</tt> , pressing the up and down arrows at a prompt scrolls through the previously entered lines.<br /> <br /> === See Also ===<br /> <br /> Documentation on <tt>fopen( )</tt> at ''http://www.php.net/fopen'', <tt>fgets( )</tt> at ''http://www.php.net/fgets'', <tt>fread( )</tt> at ''http://www.php.net/fread'', and the Readline extension at ''http://www.php.net/readline''; the Readline library at ''http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html''.<br /> <br /> == Reading Passwords ==<br /> <br /> === Problem ===<br /> <br /> You need to read a string from the command line without it being echoed as it's typed; for example, when entering passwords.<br /> <br /> === Solution ===<br /> <br /> On Unix systems, use ''/bin/stty'' to toggle echoing of typed characters:<br /> <br /> // turn off echo<br /> `/bin/stty -echo`;<br /> <br /> // read password<br /> $password = readline();<br /> <br /> // turn echo back on<br /> `/bin/stty echo`;<br /> <br /> On Windows, use <tt>w32api_register_function( )</tt> to import <tt>_getch( )</tt> from ''msvcrt.dll'':<br /> <br /> <nowiki>// load the w32api extension and register _getch()<br /> dl('php_w32api.dll');<br /> w32api_register_function('msvcrt.dll','_getch','int');<br /> <br /> while(true) {<br /> // get a character from the keyboard<br /> $c = chr(_getch());<br /> if ( "\r" == $c || "\n" == $c ) {<br /> // if it's a newline, break out of the loop, we've got our password<br /> break;<br /> } elseif ("\x08" == $c) {<br /> /* if it's a backspace, delete the previous char from $password */<br /> $password = substr_replace($password,'',-1,1);<br /> } elseif ("\x03" == $c) {<br /> // if it's Control-C, clear $password and break out of the loop<br /> $password = NULL;<br /> break;<br /> } else {<br /> // otherwise, add the character to the password<br /> $password .= $c;<br /> }<br /> }</nowiki><br /> <br /> === Discussion ===<br /> <br /> On Unix, you use ''/bin/stty'' to control the terminal characteristics so that typed characters aren't echoed to the screen while you read a password. Windows doesn't have ''/bin/stty'', so you use the W32api extension to get access <tt>_getch( )</tt> in the Microsoft C runtime library, ''msvcrt.dll''. The <tt>_getch( )</tt> function reads a character without echoing it to the screen. It returns the ASCII code of the character read, so you convert it to a character using <tt>chr( )</tt> . You then take action based on the character typed. If it's a newline or carriage return, you break out of the loop because the password has been entered. If it's a backspace, you delete a character from the end of the password. If it's a Control-C interrupt, you set the password to <tt>NULL</tt> and break out of the loop. If none of these things are true, the character is concatenated to <tt>$password</tt>. When you exit the loop, <tt>$password</tt> holds the entered password.<br /> <br /> The following code displays <tt>Login</tt>: and <tt>Password</tt>: prompts, and compares the entered password to the corresponding encrypted password stored in ''/etc/passwd''. This requires that the system not use shadow passwords.<br /> <br /> print "Login: ";<br /> $fh = fopen('php://stdin','r') or die($php_errormsg);<br /> $username = rtrim(fgets($fh,64)) or die($php_errormsg);<br /> <br /> preg_match('/^[a-zA-Z0-9]+$/',$username) <br /> or die("Invalid username: only letters and numbers allowed");<br /> <br /> <br /> print 'Password: ';<br /> `/bin/stty -echo`;<br /> $password = rtrim(fgets($fh,64)) or die($php_errormsg);<br /> `/bin/stty echo`;<br /> print "\n";<br /> <br /> // nothing more to read from the keyboard<br /> fclose($fh);<br /> <br /> // find corresponding line in /etc/passwd <br /> $fh = fopen('/etc/passwd','r') or die($php_errormsg);<br /> $found_user = 0;<br /> while (! ($found_user || feof($fh))) {<br /> $passwd_line = fgets($fh,256);<br /> if (preg_match("/^$username:/",$passwd_line)) {<br /> $found_user = 1;<br /> }<br /> }<br /> fclose($fh);<br /> <br /> $found_user or die ("Can't find user \"$username\"");<br /> <br /> // parse the correct line from /etc/passwd <br /> $passwd_parts = split(':',$passwd_line);<br /> <br /> /* encrypt the entered password and compare it to the password in<br /> /etc/passwd */<br /> $encrypted_password = crypt($password,<br /> substr($passwd_parts[1],0,CRYPT_SALT_LENGTH));<br /> <br /> if ($encrypted_password == $passwd_parts[1]) {<br /> print "login successful";<br /> } else {<br /> print "login unsuccessful";<br /> }<br /> <br /> === See Also ===<br /> <br /> Documentation on <tt>readline( )</tt> at ''http://www.php.net/readline'', <tt>chr( )</tt> at ''http://www.php.net/chr'', on <tt>w32api_register_function( )</tt> at ''http://www.php.net/w32api-register-function'', and on <tt>_getch( )</tt> at ''http://msdn.microsoft.com/library/en-us/vccore98/HTML/_crt_ _getch.2c_._getche.asp''; on Unix, see your system's ''stty(1)'' manpage.<br /> <br /> == Displaying a GUI Widget in a Window ==<br /> <br /> === Problem ===<br /> <br /> You want to display a window with a GUI widget, such as a button, in it.<br /> <br /> === Solution ===<br /> <br /> Create the window, create the widget, and then add the widget to the window:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create the button and add it to the window<br /> $button = &new GTKButton('Click Me, Alice');<br /> $window->add($button);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> === Discussion ===<br /> <br /> First, you create a window by instantiating a new <tt>GtkWindow</tt> object. GTK objects must be created as references: <tt>&new GtkWindow( )</tt>, not <tt>new GtkWindow( )</tt>. You then create a new <tt>GtkButton</tt> object with a label "Click Me, Alice". Passing <tt>$button</tt> to the window's <tt>add( )</tt> method adds the button to the window. The <tt>show_all( )</tt> method displays the window and any widgets inside of it. The only widget inside the window in this example is the button. The next two lines ensure that the program quits when the window is closed. The <tt>shutdown( )</tt> function is a callback, as is explained later in [[PHP Cookbook/Client-Side PHP#Responding to User Actions|Recipe 20.8]].<br /> <br /> The last line is necessary in all PHP-GTK programs. Calling <tt>gtk::main( )</tt> starts the signal-handling loop. This means that the program waits for signals emitted by its GUI widgets and then responds to the signals as they occur. These signals are activities like clicking on buttons, resizing windows, and typing in text boxes. The only signal this program pays attention to is the <tt>destroy</tt> signal. When the user closes the program's main window, the <tt>destroy</tt> signal is emitted, and <tt>gtk::main_quit( )</tt> is called. This function exits the program.<br /> <br /> === See Also ===<br /> <br /> Documentation on the <tt>GtkWindow</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkwindow.php'', on <tt>GTKContainer::add( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkcontainer.method.add.php'', on <tt>GtkWidget::show_all( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkwidget.method.show_all.php'', on the <tt>GtkButton</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkbutton.php'', on <tt>gtk::main_quit( )</tt> at ''http://gtk.php.net/manual/en/gtk.method.main_quit.php'', on and <tt>gtk::main( )</tt> at ''http://gtk.php.net/manual/en/gtk.method.main.php''; the tutorial at ''http://gtk.php.net/manual/en/tutorials.hellow.php'' is a helpful introduction to basic GTK programming.<br /> <br /> == Displaying Multiple GUI Widgets in a Window ==<br /> <br /> === Problem ===<br /> <br /> You want to display more than one widget in a window.<br /> <br /> === Solution ===<br /> <br /> Add all of the widgets in a container, and then add the container in the window:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create the container - GtkVBox aligns widgets vertically<br /> $container = &new GtkVBox();<br /> <br /> // create a text entry widget and add it to the container<br /> $text_entry = &new GtkEntry();<br /> $container->pack_start($text_entry);<br /> <br /> // create a button and add it to the container<br /> $a_button = &new GtkButton('Abort');<br /> $container->pack_start($a_button);<br /> <br /> // create another button and add it to the container<br /> $r_button = &new GtkButton('Retry');<br /> $container->pack_start($r_button);<br /> <br /> // create yet another button and add it to the container<br /> $f_button = &new GtkButton('Fail');<br /> $container->pack_start($f_button);<br /> <br /> // add the container to the window<br /> $window->add($container);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> === Discussion ===<br /> <br /> A window is a container that can hold only one widget. To put multiple widgets in a window, you must place all widgets into a container that can hold more than one widget and then put that container in the window. This process can be nested: the widgets inside a container can themselves be containers.<br /> <br /> In the Solution, widgets are added to a <tt>GtkVBox</tt> container, which aligns the child widgets vertically, as shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-FIG-1|Figure 20-1]]. The <tt>add( )</tt> method adds widgets to the <tt>GtkVBox</tt>, but <tt>pack_start( )</tt> is used instead so that the size of the container is automatically updated with each new widget.<br /> <br /> <div id="phpckbk-CHP-20-FIG-1"><br /> '''Figure 20-1. Widgets in a GtkVBox'''<br /> <br /> [[Image:PHP Cookbook_I_20_tt1159.png|Widgets in a GtkVBox]]<br /> </div><br /> <br /> <tt>GtkHBox</tt> is similar to <tt>GtkVBox</tt>. It aligns its child widgets horizontally instead of vertically. [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-FIG-2|Figure 20-2]] shows the four widgets from the Solution in a <tt>CtkHBox</tt>.<br /> <br /> <div id="phpckbk-CHP-20-FIG-2"><br /> '''Figure 20-2. Widgets in a GtkHBox'''<br /> <br /> [[Image:PHP Cookbook_I_20_tt1160.png|Widgets in a GtkHBox]]<br /> </div><br /> <br /> <tt>GtkTable</tt> is a more flexible layout container; it aligns its child elements on a grid:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create the container with 3 rows and 2 columns<br /> $container = &new GtkTable(3,2);<br /> <br /> // create a text entry widget and add it to the container<br /> $text_entry = &new GtkEntry();<br /> $container->attach($text_entry,0,2,0,1);<br /> <br /> // create a button and add it to the container<br /> $a_button = &new GtkButton('Abort');<br /> $container->attach($a_button,0,1,1,2);<br /> <br /> // create another button and add it to the container<br /> $r_button = &new GtkButton('Retry');<br /> $container->attach($r_button,1,2,1,2);<br /> <br /> // create yet another button and add it to the container<br /> $f_button = &new GtkButton('Fail');<br /> $container->attach($f_button,0,2,2,3);<br /> <br /> // add the container to the window<br /> $window->add($container);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> Widgets are added to a <tt>GtkTable</tt> container with the <tt>attach( )</tt> method. The first argument to <tt>attach( )</tt> is the widget to add, and the next four arguments describe where in the grid to put the widget. The second and third arguments are the starting and ending columns for the widget. The fourth and fifth arguments are the starting and ending rows for the widget. For example:<br /> <br /> $container->attach($text_entry,0,2,0,1) <br /> <br /> means that the text-entry widget starts in column zero and ends in column two, spanning two columns. It starts at row zero and ends at row one, so it spans only one row. Rows and columns are numbered beginning with zero. The text entry and button widgets aligned in a <tt>GtkTable</tt> container are shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-FIG-3|Figure 20-3]].<br /> <br /> <div id="phpckbk-CHP-20-FIG-3"><br /> '''Figure 20-3. Widgets in a GtkTable'''<br /> <br /> [[Image:PHP Cookbook_I_20_tt1163.png|Widgets in a GtkTable]]<br /> </div><br /> <br /> === See Also ===<br /> <br /> Documentation on containers at ''http://gtk.php.net/manual/en/gtk.containers.whatare.php'', the <tt>GtkVBox</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkvbox.php'', the <tt>GtkHBox</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkhbox.php'', <tt>GtkBox::pack_start( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkbox.method.pack_start.php'', the <tt>GtkTable</tt> class at ''http://gtk.php.net/manual/en/gtk.gtktable.php'', and <tt>GtkTable::attach( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtktable.method.attach.php'' .<br /> <br /> == Responding to User Actions ==<br /> <br /> === Problem ===<br /> <br /> You want to do something when a user clicks a button, chooses an item from a dropdown list, or otherwise interacts with a GUI widget.<br /> <br /> === Solution ===<br /> <br /> Write a callback function and then associate the callback function with a signal using the <tt>connect( )</tt> method:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create a button with the current time as its label<br /> $button = &new GtkButton(strftime('%c'));<br /> <br /> // set the update_time() function as the callback for the "clicked" signal<br /> $button->connect('clicked','update_time');<br /> <br /> function update_time($b) {<br /> // the button's text is in a child of the button - a label widget<br /> $b_label = $b->child;<br /> // set the label text to the current time<br /> $b_label->set_text(strftime('%c'));<br /> }<br /> <br /> // add the button to the window<br /> $window->add($button);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> === Discussion ===<br /> <br /> The code in the Solution displays a window with a button in it. On the button is the time, rendered by <tt>strftime('%c')</tt> . When the button is clicked, its label is updated with the current time.<br /> <br /> The <tt>update_time( )</tt> function is called each time the button is clicked because <tt>$button->connect('clicked','update_time')</tt> makes <tt>update_time( )</tt> the callback function associated with the button's <tt>clicked</tt> signal. The first argument to the callback function is the widget whose signal triggered the call as its first argument. In this case, that means that <tt>$button</tt> is passed to <tt>update_time( )</tt>. You tell <tt>connect( )</tt> to pass additional arguments to the callback by passing them to <tt>connect( )</tt> after the callback function name. This example displays a window with a button and a separate label. The time is printed in the label and updated when the button is clicked:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create a container for the label and the button<br /> $container = &new GtkVBox();<br /> <br /> // create a label showing the time<br /> $label = &new GtkLabel(strftime('%c'));<br /> <br /> // add the label to the container<br /> $container->pack_start($label);<br /> <br /> // create a button<br /> $button = &new GtkButton('Update Time');<br /> <br /> /* set the update_time() function as the callback for the "clicked" signal<br /> and pass $label to the callback */<br /> $button->connect('clicked','update_time',$label);<br /> <br /> function update_time($b,$lb) {<br /> $lb->set_text(strftime('%c'));<br /> }<br /> <br /> // add the button to the container<br /> $container->pack_start($button);<br /> <br /> // add the container to the window<br /> $window->add($container);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> Because <tt>$label</tt> is on the list of arguments passed to <tt>$button->connect( )</tt>, <tt>$label</tt> is passed to <tt>update_time( )</tt>. Calling <tt>set_text( )</tt> on <tt>$label</tt> updates the text displayed in the label.<br /> <br /> === See Also ===<br /> <br /> Documentation on signals and callbacks at ''http://gtk.php.net/manual/en/gtk.signals.php'', on <tt>GtkObject::connect( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkobject.method.connect.php'', and on <tt>GtkButton</tt>'s <tt>clicked</tt> signal at ''http://gtk.php.net/manual/en/gtk.gtkbutton.signal.clicked.php''.<br /> <br /> == Displaying Menus ==<br /> <br /> === Problem ===<br /> <br /> You want to display a menu bar at the top of a GTK window.<br /> <br /> === Solution ===<br /> <br /> Create a <tt>GtkMenu</tt> . Create individual <tt>GtkMenuItem</tt> objects for each menu item you want to display and add each menu item to the <tt>GtkMenu</tt> with <tt>append( )</tt>. Then, create a root menu <tt>GtkMenuItem</tt> with the label that should appear in the menu bar (e.g., "File" or "Options"). Add the menu to the root menu with <tt>set_submenu( )</tt> . Create a <tt>GtkMenuBar</tt> and add the root menu to the menu bar with <tt>append( )</tt>. Finally, add the menu bar to the window:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create a menu<br /> $menu = &new GtkMenu();<br /> <br /> // create a menu item and add it to the menu<br /> $menu_item_1 = &new GtkMenuItem('Open');<br /> $menu->append($menu_item_1);<br /> <br /> // create another menu item and add it to the menu<br /> $menu_item_2 = &new GtkMenuItem('Close');<br /> $menu->append($menu_item_2);<br /> <br /> // create yet another menu item and add it to the menu<br /> $menu_item_2 = &new GtkMenuItem('Save');<br /> $menu->append($menu_item_2);<br /> <br /> // create a root menu and add the existing menu to it<br /> $root_menu = &new GtkMenuItem('File');<br /> $root_menu->set_submenu($menu);<br /> <br /> // create a menu bar and add the root menu to it<br /> $menu_bar = &new GtkMenuBar();<br /> $menu_bar->append($root_menu);<br /> <br /> // add the menu bar to the window<br /> $window->add($menu_bar);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> === Discussion ===<br /> <br /> A menu involves a hierarchy of quite a few objects. The <tt>GtkWindow</tt> (or another container) holds the <tt>GtkMenuBar</tt>. The <tt>GtkMenuBar</tt> holds a <tt>GtkMenuItem</tt> for each top-level menu in the menu bar (e.g., "File," "Options," or "Help"). Each top-level <tt>GtkMenuItem</tt> has a <tt>GtkMenu</tt> as a submenu. That submenu contains each <tt>GtkMenuItem</tt> that should appear under the top-level menu.<br /> <br /> As with any GTK widget, a <tt>GtkMenuItem</tt> object can have callbacks that handle signals. When a menu item is selected, it triggers the <tt>activate</tt> signal. To take action when a menu item is selected, connect its <tt>activate</tt> signal to a callback. Here's a version of the button-and-label time display from [[PHP Cookbook/Client-Side PHP#Responding to User Actions|Recipe 20.8]] with two menu items: "Update," which updates the time in the label, and "Quit," which quits the program:<br /> <br /> // create the window<br /> $window = &new GtkWindow();<br /> <br /> // create a container for the label and the button<br /> $container = &new GtkVBox();<br /> <br /> // create a menu<br /> $menu = &new GtkMenu();<br /> <br /> // create a menu item and add it to the menu<br /> $menu_item_1 = &new GtkMenuItem('Update');<br /> $menu->append($menu_item_1);<br /> <br /> // create another menu item and add it to the menu<br /> $menu_item_2 = &new GtkMenuItem('Quit');<br /> $menu->append($menu_item_2);<br /> <br /> // create a root menu and add the existing menu to it<br /> $root_menu = &new GtkMenuItem('File');<br /> $root_menu->set_submenu($menu);<br /> <br /> // create a menu bar and add the root menu to it<br /> $menu_bar = &new GtkMenuBar();<br /> $menu_bar->append($root_menu);<br /> <br /> // add the menu to the container<br /> $container->add($menu_bar);<br /> <br /> // create a label showing the time<br /> $label = &new GtkLabel(strftime('%c'));<br /> <br /> // add the label to the container<br /> $container->pack_start($label);<br /> <br /> // create a button<br /> $button = &new GtkButton('Update Time');<br /> <br /> /* set the update_time() function as the callback for the "clicked" signal<br /> and pass $label to the callback */<br /> $button->connect('clicked','update_time',$label);<br /> <br /> function update_time($b,$lb) {<br /> $lb->set_text(strftime('%c'));<br /> }<br /> <br /> // add the button to the container<br /> $container->pack_start($button);<br /> <br /> // when the Update menu item is selected, call update_time()<br /> $menu_item_1->connect('activate','update_time',$label);<br /> <br /> // when the Quit menu item is selected, quit<br /> $menu_item_2->connect('activate','shutdown');<br /> <br /> // add the container to the window<br /> $window->add($container);<br /> <br /> // display the window<br /> $window->show_all();<br /> <br /> // necessary so that the program exits properly<br /> function shutdown() { gtk::main_quit(); }<br /> $window->connect('destroy','shutdown');<br /> <br /> // start GTK's signal handling loop<br /> gtk::main();<br /> <br /> Callbacks are connected to the menu items with their <tt>connect( )</tt> methods. The callbacks are connected to the <tt>activate</tt> signals towards the end of the code because the call to <tt>$menu_item_1->connect( )</tt> passes <tt>$label</tt> to <tt>update_time( )</tt> . For <tt>$label</tt> to be successfully passed to <tt>update_time( )</tt> while the program is running, <tt>connect( )</tt> has to be called after <tt>$label</tt> is instantiated.<br /> <br /> === See Also ===<br /> <br /> Documentation on the <tt>GtkMenu</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkmenu.php'', <tt>GtkMenuShell::append( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkmenushell.method. append.php'', the <tt>GtkMenuItem</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkmenuitem. php'', <tt>GtkMenuItem::set_submenu( )</tt> at ''http://gtk.php.net/manual/en/gtk.gtkmenuitem. method.set_submenu.php'', <tt>GtkMenuItem</tt>'s <tt>activate</tt> signal at ''http://gtk.php.net/manual/en/gtk.gtkmenuitem.signal.activate.php'', and the <tt>GtkMenuBar</tt> class at ''http://gtk.php.net/manual/en/gtk.gtkmenubar.php''.<br /> <br /> == Program: Command Shell ==<br /> <br /> The ''command-shell.php'' program shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-EX-1|Example 20-1]] provides a shell-like prompt to let you execute PHP code interactively. It reads in lines using <tt>readline( )</tt> and then runs them with <tt>eval( )</tt>. By default, it runs each line after it's typed in. In multiline mode (specified with <tt>-m</tt> or <tt>--multiline</tt>), however, it keeps reading lines until you enter . on a line by itself; it then runs the accumulated code.<br /> <br /> Additionally, ''command-shell.php'' uses the Readline word-completion features to more easily enter PHP functions. Enter a few characters and hit Tab to see a list of functions that match the characters you've typed.<br /> <br /> This program is helpful for running snippets of code interactively or testing different commands. The variables, functions, and classes defined in each line of code stay defined until you quit the program, so you can test different database queries, for example:<br /> <br /> % '''php -q command-shell.php'''<br /> [1]> '''require 'DB.php';'''<br /> <br /> [2]> '''$dbh = DB::connect('mysql://user:pwd@localhost/phpc');'''<br /> <br /> [3]> '''print_r($dbh->getAssoc('SELECT sign,planet,start_day FROM zodiac WHERE element '''<br /> '''LIKE "water"'));'''<br /> Array<br /> (<br /> [Cancer] => Array<br /> (<br /> [0] => Moon<br /> [1] => 22<br /> )<br /> [Scorpio] => Array<br /> (<br /> [0] => Mars<br /> [1] => 24<br /> )<br /> [Pisces] => Array<br /> (<br /> [0] => Neptune<br /> [1] => 19<br /> )<br /> )<br /> <br /> The code for ''command-shell.php'' is in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-EX-1|Example 20-1]].<br /> <br /> <div id="phpckbk-CHP-20-EX-1"><br /> '''Example 20-1. command-shell.php'''<br /> <br /> <nowiki><br /> // Load the readline library<br /> if (! function_exists('readline')) {<br /> dl('readline.'. (((strtoupper(substr(PHP_OS,0,3))) == 'WIN')?'dll':'so'))<br /> or die("Readline library required\n");<br /> }<br /> <br /> // Load the Console_Getopt class<br /> require 'Console/Getopt.php';<br /> <br /> $o = new Console_Getopt;<br /> $opts = $o->getopt($o->readPHPArgv(),'hm',array('help','multiline'));<br /> <br /> // Quit with a usage message if the arguments are bad<br /> if (PEAR::isError($opts)) {<br /> print $opts->getMessage();<br /> print "\n";<br /> usage();<br /> }<br /> <br /> // default is to evaluate each command as it's entered<br /> $multiline = false;<br /> <br /> foreach ($opts[0] as $opt) {<br /> // remove any leading -s<br /> $opt[0] = preg_replace('/^-+/','',$opt[0]);<br /> <br /> // check the first character of the argument<br /> switch($opt[0][0]) {<br /> case 'h':<br /> // display help<br /> usage();<br /> break;<br /> case 'm':<br /> $multiline = true;<br /> break;<br /> }<br /> }<br /> <br /> // set up error display<br /> ini_set('display_errors',false);<br /> ini_set('log_errors',true);<br /> <br /> // build readline completion table<br /> $functions = get_defined_functions();<br /> foreach ($functions['internal'] as $k => $v) {<br /> $functions['internal'][$k] = "$v(";<br /> }<br /> function function_list($line) {<br /> return $GLOBALS['functions']['internal'];<br /> }<br /> readline_completion_function('function_list');<br /> <br /> $cmd = '';<br /> $cmd_count = 1;<br /> <br /> while (true) {<br /> // get a line of input from the user<br /> $s = readline("[$cmd_count]> ");<br /> // add it to the command history<br /> readline_add_history($s);<br /> // if we're in multiline mode:<br /> if ($multiline) {<br /> // if just a "." has been entered<br /> if ('.' == rtrim($s)) {<br /> // eval() the code<br /> eval($cmd);<br /> // clear out the accumulated code<br /> $cmd = '';<br /> // increment the command count<br /> $cmd_count++;<br /> // start the next prompt on a new line<br /> print "\n";<br /> } else {<br /> /* otherwise, add the new line to the accumulated code<br /> tacking on a newline prevents //-style comments from<br /> commenting out the rest of the lines entered<br /> */<br /> $cmd .= $s."\n";;<br /> }<br /> } else {<br /> // if we're not in multiline mode, eval() the line<br /> eval($s);<br /> // increment the command count<br /> $cmd_count++;<br /> // start the next prompt in a new line<br /> print "\n";<br /> }<br /> }<br /> <br /> // display helpful usage information<br /> function usage() {<br /> $my_name = $_SERVER['argv'][0];<br /> <br /> print<<<_USAGE_<br /> Usage: $my_name [-h|--help] [-m|--multiline]<br /> <br /> -h, --help: display this help<br /> -m, --multiline: execute accumulated code when "." is entered<br /> by itself on a line. The default is to execute<br /> each line after it is entered. <br /> <br /> _USAGE_;<br /> exit(-1);<br /> }</nowiki><br /> </div><br /> <br /> == Program: Displaying Weather Conditions ==<br /> <br /> The ''gtk-weather.php'' program shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-EX-2|Example 20-2]] uses SOAP and a weather web service to display weather conditions around the world. It incorporates a number of GTK widgets in its interface: menus, keyboard accelerators, buttons, a text entry box, labels, scrolled windows, and columned lists.<br /> <br /> To use ''gtk-weather.php'', first search for weather stations by typing a search term in the text-entry box and clicking the Search button. Searching for weather stations is shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-FIG-4|Figure 20-4]].<br /> <br /> <div id="phpckbk-CHP-20-FIG-4"><br /> '''Figure 20-4. Searching for weather stations'''<br /> <br /> [[Image:PHP Cookbook_I_20_tt1169.png|Searching for weather stations]]<br /> </div><br /> <br /> Once you've retrieved a list of weather stations, you can get the conditions at a specific station by selecting the station and clicking the Add button. The station code and its current conditions are added to the list at the bottom of the window. You can search again and add more stations to the list. The ''gtk-weather.php'' window with a few added stations is shown in [[PHP Cookbook/Client-Side PHP#phpckbk-CHP-20-FIG-5|Figure 20-5]].<br /> <br /> <div id="phpckbk-CHP-20-FIG-5"><br /> '''Figure 20-5. Added weather stations'''<br /> <br /> [[Image:PHP Cookbook_I_20_tt1170.png|Added weather stations]]<br /> </div><br /> <br /> The web service this program uses is called ''GlobalWeather'' ; look for more information about it at ''http://www.capescience.com/webservices/globalweather/index.shtml''.<br /> <br /> <div id="phpckbk-CHP-20-EX-2"><br /> '''Example 20-2. gtk-weather.php'''<br /> <br /> <nowiki>// Load the GTK extension<br /> dl('php_gtk.'. (((strtoupper(substr(PHP_OS,0,3))) == 'WIN')?'dll':'so'));<br /> <br /> // Load the SOAP client class<br /> require 'SOAP/Client.php';<br /> <br /> // Create the main window and set its title and size<br /> $window = &new GtkWindow();<br /> $window->set_title('PHP Cookbook GTK Demo');<br /> $window->set_default_size(500,200);<br /> <br /> // The main layout container for the window is a VBox<br /> $vbox = &new GtkVBox();<br /> $window->add($vbox);<br /> <br /> // Create a GtkAccelGroup to hold keyboard accelerators<br /> $accelgroup = &new GtkAccelGroup();<br /> $window->add_accel_group($accelgroup);<br /> <br /> // Build the menu, starting with the GtkMenuBar. The arguments to <br /> // pack_start() prevent the menu bar from expanding if the window does.<br /> $menubar = &new GtkMenuBar();<br /> $vbox->pack_start($menubar, false, false);<br /> <br /> // Create the "File" menu and its keyboard accelerator<br /> $menu_file_item = &new GtkMenuItem('_File');<br /> $menu_file_item_label = $menu_file_item->child;<br /> $menu_file_item->add_accelerator('activate',$accelgroup,<br /> $menu_file_item_label->parse_uline('_File'),<br /> GDK_MOD1_MASK,0);<br /> // Add the "File" menu to the menu bar<br /> $menubar->add($menu_file_item);<br /> <br /> // Create the submenu for the options under "File"<br /> $menu_file_submenu = &new GtkMenu();<br /> $menu_file_item->set_submenu($menu_file_submenu);<br /> <br /> // Create the "Quit" option under "File" and its accelerator<br /> // GDK_MOD1_MASK means that the accelerator is Alt-Q, not Q<br /> // GTK_ACCEL_VISIBLE means that the accelerator is displayed in the menu<br /> $menu_file_choices_quit = &new GtkMenuItem('_Quit');<br /> $menu_file_choices_quit_label = $menu_file_choices_quit->child;<br /> $menu_file_choices_quit->add_accelerator('activate',$accelgroup,<br /> $menu_file_choices_quit_label->parse_uline('_Quit'),GDK_MOD1_MASK,<br /> GTK_ACCEL_VISIBLE);<br /> <br /> // Add the "File | Quit" option to the "File" submenu<br /> $menu_file_submenu->append($menu_file_choices_quit);<br /> <br /> // Create the "Help" menu and its keyboard accelerator<br /> $menu_help_item = &new GtkMenuItem('_Help');<br /> $menu_help_item_label = $menu_help_item->child;<br /> $menu_help_item->add_accelerator('activate',$accelgroup,<br /> $menu_help_item_label->parse_uline('_Help'),<br /> GDK_MOD1_MASK,0);<br /> // Add the "Help" menu to the menu bar<br /> $menubar->add($menu_help_item);<br /> <br /> // Create the submenu for the options under "Help"<br /> $menu_help_submenu = &new GtkMenu();<br /> $menu_help_item->set_submenu($menu_help_submenu);<br /> <br /> // Create the "About" option under "Help" and its accelerator<br /> $menu_help_choices_about = &new GtkMenuItem('_About');<br /> $menu_help_choices_about_label = $menu_help_choices_about->child;<br /> $menu_help_choices_about->add_accelerator('activate',$accelgroup,<br /> $menu_help_choices_about_label->parse_uline('_About'),GDK_MOD1_MASK,<br /> GTK_ACCEL_VISIBLE);<br /> <br /> // Add the "Help | About" option to the "Help" submenu<br /> $menu_help_submenu->append($menu_help_choices_about);<br /> <br /> // Layout the weather station searching widgets in a GtkTable<br /> $table_1 = &new GtkTable(2,4);<br /> $vbox->pack_start($table_1);<br /> <br /> // Put a label on the left in the first row<br /> $label_sn = &new GtkLabel('Station Name: ');<br /> $label_sn->set_alignment(1,0.5);<br /> $table_1->attach($label_sn,0,1,0,1, GTK_FILL);<br /> <br /> // Put a text entry field in the middle of the first row<br /> // The accelerator allows you to hit "Return" in the field to submit<br /> $entry_sn = &new GtkEntry();<br /> $entry_sn->add_accelerator('activate',$accelgroup,GDK_KEY_Return,0,0);<br /> $table_1->attach($entry_sn,1,2,0,1, GTK_FILL);<br /> <br /> // Put a scrolled window in the second row of the table<br /> $scrolledwindow_1 = &new GtkScrolledWindow();<br /> $scrolledwindow_1->set_policy(GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);<br /> $table_1->attach($scrolledwindow_1,0,4,1,2, GTK_EXPAND | GTK_SHRINK | GTK_FILL,<br /> GTK_EXPAND | GTK_SHRINK | GTK_FILL);<br /> <br /> // Put a columned list in the scrolled window. By putting the list inside<br /> // the scrolled window instead of directly in the GtkTable, the window doesn't<br /> // have to grow to a huge size to let you see everything in the list<br /> $clist_sn = &new GtkCList(4,array('Code','Name','Region','Country'));<br /> $scrolledwindow_1->add($clist_sn);<br /> <br /> // Set the columns in the list to resize automatically<br /> for ($i = 0; $i < 4; $i++) { $clist_sn->set_column_auto_resize($i,true); }<br /> <br /> // Add a "Search" button to the first row<br /> $button_search =&new GtkButton('Search');<br /> $table_1->attach($button_search,2,3,0,1, GTK_FILL);<br /> <br /> // Add an "Add" button to the first row<br /> $button_add = &new GtkButton('Add');<br /> $table_1->attach($button_add,3,4,0,1, GTK_FILL);<br /> <br /> // Layout the weather conditions display widgets in another GtkTable<br /> $table_2 = &new GtkTable(2,3);<br /> $vbox->pack_start($table_2);<br /> <br /> // Add a label displaying how many stations are shown<br /> $label_st = &new GtkLabel('Stations: 0');<br /> $label_st->set_alignment(0,0.5);<br /> $table_2->attach($label_st,0,1,0,1, GTK_FILL);<br /> <br /> // Add a button to update a single station<br /> $button_update_sel = &new GtkButton('Update Selected');<br /> $table_2->attach($button_update_sel,1,2,0,1, GTK_FILL);<br /> <br /> // Add a button to update all stations<br /> $button_update_all = &new GtkButton('Update All');<br /> $table_2->attach($button_update_all,2,3,0,1, GTK_FILL);<br /> <br /> // Add a columned list to hold the weather conditions at the stations<br /> // This columned list also goes inside a scrolled window<br /> $scrolledwindow_2 = &new GtkScrolledWindow();<br /> $scrolledwindow_2->set_policy(GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);<br /> $table_2->attach($scrolledwindow_2,0,3,1,2, GTK_EXPAND | GTK_SHRINK | GTK_FILL,<br /> GTK_EXPAND | GTK_SHRINK | GTK_FILL);<br /> $clist_st = &new GtkCList(5,array('Code','Temp','Precipitation','Wind','Updated'));<br /> $scrolledwindow_2->add($clist_st);<br /> <br /> // Set the columns in the list to resize automatically<br /> for ($i = 0; $i < 5; $i++) { $clist_st->set_column_auto_resize($i,true); }<br /> <br /> // Connect signals to callbacks<br /> <br /> // Clicking on the "Search" button or hitting Return in the text entry field<br /> // searches for weather stations whose name match the entered text<br /> $button_search->connect('clicked','wx_searchByName',$entry_sn,$clist_sn,$window);<br /> $entry_sn->connect('activate','wx_searchByName',$entry_sn,$clist_sn,$window);<br /> <br /> // Clicking on the "Add" button adds the weather station to the bottom <br /> // columned list<br /> $button_add->connect('clicked','cb_add_station',$clist_sn,$clist_st,$label_st);<br /> <br /> // Clicking on the "Update Selected" button updates the bottom columned list<br /> // for a single station<br /> $button_update_sel->connect('clicked','wx_update_report',$clist_st,$label_st,<br /> 'selected');<br /> // Clicking on the "Update All" button updates all stations in the bottom<br /> // columned list<br /> $button_update_all->connect('clicked','wx_update_report',$clist_st,$label_st,<br /> 'all');<br /> <br /> // Closing the window or selecting the "File | Quit" menu item exits the program<br /> $window->connect('destroy','cb_shutdown');<br /> $menu_file_choices_quit->connect('activate','cb_shutdown');<br /> <br /> // Selecting the "Help | About" menu item shows an about box<br /> $menu_help_choices_about->connect('activate','cb_about_box',$window);<br /> <br /> // These callbacks keep track of the currently selected row (if any)<br /> // in each columned list<br /> $clist_sn->connect('select-row','cb_clist_select_row');<br /> $clist_sn->connect('unselect-row','cb_clist_unselect_row');<br /> $clist_st->connect('select-row','cb_clist_select_row');<br /> $clist_st->connect('unselect-row','cb_clist_unselect_row');<br /> <br /> // The interface has been set up and the signals we want to pay attention<br /> // to have been connected to callbacks. Time to display the window and start<br /> // the GTK signal handling loop.<br /> $window->show_all();<br /> gtk::main();<br /> <br /> /*<br /> * CALLBACKS AND OTHER SUPPORT FUNCTIONS<br /> */<br /> <br /> // use the searchByName() function over SOAP to get a list of stations<br /> // whose names match the given search term<br /> function wx_searchByName($button,$entry,$clist,$window) {<br /> // instantiate a new SOAP client<br /> $sc = new SOAP_Client('http://live.capescience.com/ccx/GlobalWeather');<br /> <br /> $search_term = trim($entry->get_text());<br /> if ($search_term) {<br /> // call the remote function if a search term is provided<br /> $res = $sc->call('searchByName',<br /> array(new SOAP_Value('name','string',$search_term)),<br /> 'capeconnect:GlobalWeather:StationInfo',<br /> 'capeconnect:GlobalWeather:StationInfo#searchByName');<br /> <br /> // pop up an error dialog if the SOAP function fails<br /> if (PEAR::isError($res)) {<br /> error_dialog($res->getMessage(),$window);<br /> return false;<br /> }<br /> // pop up an error dialog if there are no matches<br /> if (! is_array($res)) {<br /> error_dialog('No weather stations found.',$window);<br /> return false;<br /> }<br /> // add each station and its info to the columned list<br /> // wrapping the calls to append() with freeze() and thaw()<br /> // make all of the data appear at once<br /> $clist->freeze();<br /> $clist->clear();<br /> foreach ($res as $station) {<br /> $clist->append(array($station->icao,$station->name,<br /> $station->region,$station->country));<br /> }<br /> $clist->thaw();<br /> } <br /> }<br /> <br /> // use the getWeatherReport function over SOAP to get the weather conditions<br /> // at a particular station<br /> function wx_getWeatherReport($code) {<br /> $sc = new SOAP_Client('http://live.capescience.com/ccx/GlobalWeather');<br /> $res = $sc->call('getWeatherReport',<br /> array(new SOAP_Value('code','string',$code)),<br /> 'capeconnect:GlobalWeather:GlobalWeather',<br /> 'capeconnect:GlobalWeather:GlobalWeather#getWeatherReport');<br /> <br /> if (PEAR::isError($res)) {<br /> error_dialog($res->getMessage());<br /> return false;<br /> } else {<br /> return $res;<br /> }<br /> }<br /> <br /> // add the weather report in $res to the columned list $clist<br /> // if $row is null, the report is appended to the list<br /> // if $row is not null, the report replaces row $row in the list<br /> function wx_add_report($clist,$label,$res,$row = null) {<br /> <br /> // format the timestamp<br /> $timestamp = str_replace('T',' ',$res->timestamp);<br /> $timestamp = str_replace('Z',' GMT',$timestamp);<br /> $timestamp = strftime('%H:%M:%S %m/%d/%Y',strtotime($timestamp));<br /> <br /> // format the wind information<br /> $wind = sprintf("%.2f m/s from %s",<br /> $res->wind->prevailing_speed,<br /> $res->wind->prevailing_direction->compass);<br /> <br /> $clist->freeze();<br /> if (! is_null($row)) {<br /> // replace the information in row number $row<br /> $clist->set_text($row,1,$res->temperature->string);<br /> $clist->set_text($row,2,$res->precipitation->string);<br /> $clist->set_text($row,3,$wind);<br /> $clist->set_text($row,4,$timestamp);<br /> } else {<br /> // add the information to the end of the columned list<br /> $clist->append(array($res->station->icao,<br /> $res->temperature->string,<br /> $res->precipitation->string,<br /> $wind,<br /> $timestamp));<br /> <br /> // update the columned list's internal row count<br /> $rows = 1 + $clist->get_data('rows');<br /> $clist->set_data('rows',$rows);<br /> // update the label that displays a station count<br /> $label->set_text("Stations: $rows");<br /> }<br /> $clist->thaw();<br /> }<br /> <br /> // update conditions for one station or all stations, depending on $mode<br /> function wx_update_report($button,$clist,$label,$mode) {<br /> switch ($mode) {<br /> case 'selected':<br /> <br /> // if there is a row selected<br /> $selected_row = $clist->get_data('selected_row');<br /> if (($selected_row >= 0) && (! is_null($selected_row))) {<br /> $code = $clist->get_text($selected_row,0);<br /> <br /> // get the report and update the columned list<br /> if ($res = wx_getWeatherReport($code)) {<br /> wx_add_report($clist,$label,$res,$selected_row);<br /> } <br /> }<br /> break;<br /> case 'all':<br /> // for each row in the columned list<br /> for ($i = 0, $j = $clist->get_data('rows'); $i < $j; $i++) {<br /> // get the report and update the list<br /> if ($res = wx_getWeatherReport($clist->get_text($i,0))) {<br /> wx_add_report($clist,$label,$res,$i);<br /> }<br /> }<br /> break;<br /> }<br /> }<br /> <br /> // add a station to the bottom list of weather reports<br /> function cb_add_station($button,$clist,$clist_2,$label) {<br /> $selected_row = $clist->get_data('selected_row');<br /> // if there's a selected row in the top list of stations<br /> if ($selected_row >= 0) {<br /> $code = $clist->get_text($selected_row,0);<br /> // get the weather report for that station<br /> if ($res = wx_getWeatherReport($code)) {<br /> // find the row if this code is already in the list<br /> $row = null;<br /> for ($i = 0, $j = $clist_2->get_data('rows'); $i < $j; $i++) {<br /> if ($clist_2->get_text($i,0) == $code) {<br /> $row = $i;<br /> }<br /> }<br /> // add the station and its report to the bottom list of<br /> // reports (or update the existing row)<br /> wx_add_report($clist_2,$label,$res,$row);<br /> } <br /> }<br /> }<br /> <br /> // update a columned list's internal selected row value when a row is selected<br /> function cb_clist_select_row($clist,$row,$col,$e) {<br /> $clist->set_data('selected_row',$row);<br /> }<br /> <br /> // clear a columned list's internal selected row value when a row is unselected<br /> function cb_clist_unselect_row($clist) {<br /> $clist->set_data('selected_row',-1);<br /> }<br /> <br /> // display the "About Box"<br /> function cb_about_box($menu_item,$window) {<br /> $about_box = &new GtkDialog();<br /> $vbox = $about_box->vbox;<br /> $action_area = $about_box->action_area;<br /> $about_box->set_title('About');<br /> $label = &new GtkLabel("This is the PHP Cookbook PHP-GTK Demo.");<br /> $button = &new GtkButton('OK');<br /> $button->connect('clicked','cb_dialog_destroy',$about_box);<br /> $vbox->pack_start($label);<br /> $action_area->pack_start($button);<br /> $about_box->set_modal(true);<br /> $about_box->set_transient_for($window);<br /> $about_box->show_all();<br /> }<br /> <br /> // display an error dialog box<br /> function error_dialog($msg,$window) {<br /> $dialog = &new GtkDialog();<br /> $vbox = $dialog->vbox;<br /> $action_area = $dialog->action_area;<br /> $dialog->set_title('Error');<br /> $label = &new GtkLabel("Error: $msg");<br /> $button = &new GtkButton('OK');<br /> $button->connect('clicked','cb_dialog_destroy',$dialog);<br /> $vbox->pack_start($label);<br /> $action_area->pack_start($button);<br /> $dialog->set_modal(true);<br /> $dialog->set_transient_for($window);<br /> $dialog->show_all();<br /> }<br /> <br /> // close a dialog box<br /> function cb_dialog_destroy($button,$dialog) {<br /> $dialog->destroy();<br /> }<br /> <br /> // quit the main program<br /> function cb_shutdown() { gtk::main_quit(); }<br /> </nowiki><br /> </div><br /> == Notes ==<br /> <br /> <references/></div> Thu, 06 Mar 2008 22:28:45 GMT Docbook2Wiki http://commons.oreilly.com/wiki/index.php/Talk:PHP_Cookbook/Client-Side_PHP