rfc:cli_process_title

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
rfc:cli_process_title [2013/02/07 19:53] – [Introduction] keyurrfc:cli_process_title [2013/02/22 00:40] – Method specifications keyur
Line 1: Line 1:
 ====== Request for Comments: PHP CLI changing process title support ====== ====== Request for Comments: PHP CLI changing process title support ======
  
-  * Version: 1.0+  * Version: 1.1
   * Date: 2013-02-06   * Date: 2013-02-06
   * Author: Keyur Govande <kgovande@gmail.com>   * Author: Keyur Govande <kgovande@gmail.com>
Line 39: Line 39:
  
 $title = "This is a test title"; $title = "This is a test title";
-if (!is_cli_ps_title_available()) { +if (!cli_set_process_title($title)) { 
-    echo "Not supported on this OS\n";+    echo "Unable to set title\n";
     exit(1);     exit(1);
-} 
- 
-if (!set_cli_ps_title($title)) { 
-    echo "Unable to set title\n"; 
-    exit(2); 
 } }
  
 sleep(15); sleep(15);
 +echo cli_get_process_title() . "\n";
 </code> </code>
  
Line 57: Line 53:
   * FreeBSD 9.0: {{:rfc:fbsd_ps_title.png?200|}}   * FreeBSD 9.0: {{:rfc:fbsd_ps_title.png?200|}}
   * Windows 7: {{:rfc:windows_ps_title.png?200|}}   * Windows 7: {{:rfc:windows_ps_title.png?200|}}
 +  * OS X Lion: {{:rfc:osx_ps_title.png?200|}}
  
-===== Patch ===== 
  
-The patch (including tests) based off of 5.4.11 is [[https://gist.github.com/keyurdg/4728770#file-php_ps-patch|here]].+===== Specification =====
  
 +==== Description ====
 +
 +  bool cli_set_process_title(string $title)
 +
 +''cli_set_process_title()'' sets title of the process to //**title**// and returns TRUE if the operation succeeded. Or FALSE if it fails. On failure, a WARNING is emitted with details as to why it failed, the most common cause being the operating system is not supported.
 +
 +==== Parameters ====
 +
 +**title**
 +
 +==== Description ====
 +
 +  string cli_get_process_title()
 +
 +''cli_get_process_title()'' returns a string containing the title that was set using ''cli_set_process_title''. 
 +
 +Note that this returned string may not match what ps/top would show; for example on FreeBSD in ps, you would see the process name as "php: title (php)" where //**title**// is what was passed to ''cli_set_process_title''. 
 +
 +If the method fails for any reason, a WARNING is emitted and NULL is returned; the most common cause of failure being the operating system is not supported.
 +
 +==== Parameters ====
 +
 +None
 +
 +===== Patch =====
 +
 +The pull request (including tests) based on PHP-5.5 is [[https://github.com/php/php-src/pull/280|here]].
 ===== Voting ===== ===== Voting =====
  
 The PHP language is not changed, so a 50% + 1 majority is required. The PHP language is not changed, so a 50% + 1 majority is required.
 +
 +Voting ends March 4th, 2013.
 +
 +<doodle title="Accept modifying CLI process title in PHP?" auth="user" voteType="single" closed="false">
 +   * Yes
 +   * No
 +</doodle>
  
 ===== Changelog ===== ===== Changelog =====
  
   * 1.0 (2012-02-06): Initial draft   * 1.0 (2012-02-06): Initial draft
 +  * 1.1 (2012-02-07): Updated the introduction with more justification for why this is needed
 +  * 1.2 (2012-02-21): Added in method specifications
rfc/cli_process_title.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools