[PHP-DOC] Inproving the Documentation

[Sara Golemon]

Personally, I try to follow commits on
php.cvs, bug reports, Change Log,
user notes on the online manual..
but I still have the feeling of missing
a lot of changes. After a year away from
the project, I have _no_ clue what was
added, when, and whether it was added
to our documentation or not.


With regard to new features, I've kept the NEWS file up to date (as have
most other developers) with these changes and although these entries may
not be enough for a 3rd party to decipher into manual entries, I can
certainly write up the ones with my name by them when the time comes
(see note about PHP6).

But that's just a question of features, there's also the "unicode
semantics quirks".  Some functions which act in a perhaps-unexpected
manner when used in unicode-semantics mode.  These are going to be more
difficult to track down, but I'll make an effort to catalog and document
the parts I worked on.


I know that you developers are willing
to help a lot with it, but that you cannot
manage to save the spare time needed to
do it the right way.


I admit that my additions, personally, in the past year have been left
off the documentation radar, but that's due (mostly) to the fact that
these additions have been to PHP6 and (as with PHP5) the lead time on
any release is too long to start advertising features in the manual that
don't exist (from the perspective of the end user).  Where is the
documentation team at with regards to when they feel PHP6 features
should start appearing in the manual?


That's why I would
like to propose a simple/small/timeless
change in your CVS commit messages: If
you feel that the change need to be
documented, place the @doc keyword at the
end of your message log entry.


I like that idea.  It's a nice clear, consistent flag saying "look
here!".  I'll use this from now on.


This small @doc tag could _slightly_
improve/optimize/sanitize our work on the
documentation. By adding some SQL logging
in loginfo.pl, and storing the following:

 * date: commit date
 * login: CVS account of the developer
 * branch: CVS branch
 * files: Changed files
 * commit: Commit message before @doc
 * desc : Optional developer description after @doc

 We would be able to have an interface
displaying a dynamic phpdoc TODO, with
some nice features like a search by PHP
version, extension, assignee, keywords..


Sounds sexy...


Additionally, we can imagine adding an
online help feature on the interface, by
setting a �help� flag on some hardly
understandable change, to have [EMAIL PROTECTED]
notified of our need for enlightenment.



Well, this sounds like it's more suitable for a manual process, but
however you'd like...

-Sara

[PHP-DOC] cvs: phpdoc /en/reference/pdo constants.xml

[Sara Golemon]

pollita Wed May  3 23:00:29 2006 UTC

  Modified files:  
/phpdoc/en/reference/pdoconstants.xml 
  Log:
  Document new class constants
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/pdo/constants.xml?r1=1.14&r2=1.15&diff_format=u
Index: phpdoc/en/reference/pdo/constants.xml
diff -u phpdoc/en/reference/pdo/constants.xml:1.14 
phpdoc/en/reference/pdo/constants.xml:1.15
--- phpdoc/en/reference/pdo/constants.xml:1.14  Mon Apr 24 07:41:57 2006
+++ phpdoc/en/reference/pdo/constants.xml   Wed May  3 23:00:29 2006
@@ -1,5 +1,5 @@
 
-
+
 
 
  &reftitle.constants;
@@ -771,6 +771,84 @@
 

   
+  
+   
+PDO::PARAM_EVT_ALLOC
+(integer)
+   
+   
+
+ Allocation event
+
+   
+  
+  
+   
+PDO::PARAM_EVT_FREE
+(integer)
+   
+   
+
+ Deallocation event
+
+   
+  
+  
+   
+PDO::PARAM_EVT_EXEC_PRE
+(integer)
+   
+   
+
+ Event triggered prior to execution of a prepared statement.
+
+   
+  
+  
+   
+PDO::PARAM_EVT_EXEC_POST
+(integer)
+   
+   
+
+ Event triggered subsequent to execution of a prepared statement.
+
+   
+  
+  
+   
+PDO::PARAM_EVT_FETCH_PRE
+(integer)
+   
+   
+
+ Event triggered prior to fetching a result from a resultset.
+
+   
+  
+  
+   
+PDO::PARAM_EVT_FETCH_POST
+(integer)
+   
+   
+
+ Event triggered subsequent to fetching a result from a resultset.
+
+   
+  
+  
+   
+PDO::PARAM_EVT_NORMALIZE
+(integer)
+   
+   
+
+ Event triggered during bound parameter registration
+ allowing the driver to normalize the parameter name.
+
+   
+  
  
 
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit reference.xml

[Sara Golemon]

pollita Wed Mar 29 01:40:37 2006 UTC

  Modified files:  
/phpdoc/en/reference/runkit reference.xml 
  Log:
  Add 'installation' section to runkit reference
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/runkit/reference.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/runkit/reference.xml
diff -u phpdoc/en/reference/runkit/reference.xml:1.9 
phpdoc/en/reference/runkit/reference.xml:1.10
--- phpdoc/en/reference/runkit/reference.xml:1.9Fri Sep 30 00:47:18 2005
+++ phpdoc/en/reference/runkit/reference.xmlWed Mar 29 01:40:37 2006
@@ -1,5 +1,5 @@
 
-
+
 
 
 
@@ -31,6 +31,20 @@

   
 
+  
+   &reftitle.install;
+   
+&pecl.moved;
+   
+   
+&pecl.info;
+&url.pecl.package;runkit.
+   
+   
+&pecl.windows.download;
+   
+  
+
   
&reftitle.required;

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-context-create.xml

[Sara Golemon]

pollita Mon Mar 27 21:36:59 2006 UTC

  Modified files:  
/phpdoc/en/reference/stream/functions   stream-context-create.xml 
  Log:
  Document second arg to stream_context_create()
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/stream/functions/stream-context-create.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/stream/functions/stream-context-create.xml
diff -u phpdoc/en/reference/stream/functions/stream-context-create.xml:1.4 
phpdoc/en/reference/stream/functions/stream-context-create.xml:1.5
--- phpdoc/en/reference/stream/functions/stream-context-create.xml:1.4  Thu Aug 
12 18:11:59 2004
+++ phpdoc/en/reference/stream/functions/stream-context-create.xml  Mon Mar 
27 21:36:58 2006
@@ -1,5 +1,5 @@
 
-
+
   

 stream_context_create
@@ -10,6 +10,7 @@
  
   resourcestream_context_create
   arrayoptions
+  arrayparams
  
 
  Creates and returns a stream context with any options supplied in
@@ -21,6 +22,18 @@
  $arr['wrapper']['option'] = $value.
  It defaults to an empty array.
 
+
+ params must be an associative array
+ in the format $arr['parameter'] = $value.
+ Refer to stream_context_set_params for
+ a listing of standard stream parameters.
+
+
+ 
+  The params argument
+  was added to PHP 6.0.0.
+ 
+
 
  Using stream_context_create
  

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Mon Mar 20 22:38:55 2006 UTC

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  Document user-agent's undocumented feature: Custom request headers
  
http://cvs.php.net/viewcvs.cgi/phpdoc/en/appendices/wrappers.xml?r1=1.58&r2=1.59&diff_format=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.58 
phpdoc/en/appendices/wrappers.xml:1.59
--- phpdoc/en/appendices/wrappers.xml:1.58  Tue Dec  6 14:33:50 2005
+++ phpdoc/en/appendices/wrappers.xml   Mon Mar 20 22:38:55 2006
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -365,6 +365,40 @@
 for the ssl:// transport.

   
+
+  
+   Custom headers may be sent with an HTTP request prior to
+   version 5 by taking advantage of a side-effect in the
+   handling of the user_agent INI setting.
+   Set user_agent to any valid string
+   (such as the default PHP/version setting)
+   followed by a carriage-return/line-feed pair and any
+   additional headers.
+   This method works in PHP4 and all later versions.
+  
+  
+   
+Sending custom headers with an HTTP request
+
+
+
+Results in the following request being sent:
+
+
+
+   
+  
  
 
  

[PHP-DOC] cvs: phpdoc /en/reference/hash/functions hash.xml

[Sara Golemon]

pollita Tue Dec  6 12:09:43 2005 EDT

  Modified files:  
/phpdoc/en/reference/hash/functions hash.xml 
  Log:
  Copy/Paste Error
  
http://cvs.php.net/diff.php/phpdoc/en/reference/hash/functions/hash.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/hash/functions/hash.xml
diff -u phpdoc/en/reference/hash/functions/hash.xml:1.2 
phpdoc/en/reference/hash/functions/hash.xml:1.3
--- phpdoc/en/reference/hash/functions/hash.xml:1.2 Tue Dec  6 09:52:01 2005
+++ phpdoc/en/reference/hash/functions/hash.xml Tue Dec  6 12:09:38 2005
@@ -1,9 +1,9 @@
 
-
+
 
  
   hash
-  Generate a keyed hash value using the HMAC method
+  Generate a hash value (message digest)
  
  
   &reftitle.description;

[PHP-DOC] cvs: phpdoc /en/reference/hash .cvsignore constants.xml reference.xml /en/reference/hash/functions hash-algos.xml hash-file.xml hash-final.xml hash-hmac-file.xml hash-hmac.xml hash-init.xml

[Sara Golemon]

pollita Mon Dec  5 15:39:07 2005 EDT

  Added files: 
/phpdoc/en/reference/hash   .cvsignore constants.xml reference.xml 
/phpdoc/en/reference/hash/functions hash-algos.xml hash-file.xml 
hash-final.xml 
hash-hmac-file.xml 
hash-hmac.xml hash-init.xml 
hash-update-file.xml 
hash-update-stream.xml 
hash-update.xml hash.xml 
  Log:
  Document hash extension
  
  
http://cvs.php.net/co.php/phpdoc/en/reference/hash/.cvsignore?r=1.1&p=1
Index: phpdoc/en/reference/hash/.cvsignore
+++ phpdoc/en/reference/hash/.cvsignore
functions.xml

http://cvs.php.net/co.php/phpdoc/en/reference/hash/constants.xml?r=1.1&p=1
Index: phpdoc/en/reference/hash/constants.xml
+++ phpdoc/en/reference/hash/constants.xml



 &reftitle.constants;
 &extension.constants;
 
  
   
HASH_HMAC
 (integer)
   
   

 Optional flag for hash_init.
 Indicates that the HMAC digest-keying algorithm should be
 applied to the current hashing context.

   
  
 




http://cvs.php.net/co.php/phpdoc/en/reference/hash/reference.xml?r=1.1&p=1
Index: phpdoc/en/reference/hash/reference.xml
+++ phpdoc/en/reference/hash/reference.xml



 hash Functions
 hash

 
  
   &reftitle.intro;
   
Message Digest (hash) engine.  Allows direct or incremental processing
of arbitrary length messages using a variety of hashing algorithms.
   
  
  
   &reftitle.required;
   
The Hash extension requires no external libraries and is enabled by
default as of PHP 5.1.2.  It may be explicitly disabled by using the
--disable-hash switch to configure.  Earlier versions of PHP may
incorporate the Hash extension by installing the
PECL module.
   
  

  
  &reference.hash.constants;
 
 &reference.hash.functions;




http://cvs.php.net/co.php/phpdoc/en/reference/hash/functions/hash-algos.xml?r=1.1&p=1
Index: phpdoc/en/reference/hash/functions/hash-algos.xml
+++ phpdoc/en/reference/hash/functions/hash-algos.xml



 
  hash_algos
  Return a list of registered hashing algorithms
 
 
  &reftitle.description;
  
   arrayhash_algos
   
  
 

 
  &reftitle.returnvalues;
  
   Returns a numerically indexed array containing the list of supported
   hashing algorithms.
  
 

 
  &reftitle.examples;
  
   
hash_algos

 As of PHP 5.1.2, hash_algos will return the
 following list of algorithm names.




&example.outputs;



   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/hash/functions/hash-file.xml?r=1.1&p=1
Index: phpdoc/en/reference/hash/functions/hash-file.xml
+++ phpdoc/en/reference/hash/functions/hash-file.xml




 
  hash_file
  Generate a hash value using the contents of a given 
file
 
 
  &reftitle.description;
  
   stringhash_file
   stringalgo
   stringfilename
   boolraw_output
  

 
 
  &reftitle.parameters;
  
   

 algo
 
  
   Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", 
etc..)
  
 


 filename
 
  
   URL describing location of file to be hashed; Supports fopen wrappers.
  
 


 raw_output
 
  
   When set to &true;, outputs raw binary data.
   Default value (&false;) outpus lowercase hexits.
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   Returns a string containing the calculated message digest as lowercase hexits
   unless raw_output is set to true in which case the raw
   binary representation of the message digest is returned.
  
 

 
  &reftitle.examples;
  
   
Using hash_file



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
hash
hash_hmac_file
Or hash_update_file
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/hash/functions/hash-final.xml?r=1.1&p=1
Index: phpdoc/en/reference/hash/functions/hash-final.xml
+++ phpdoc/en/reference/hash/functions/hash-final.xml



 
  hash_final
  Finalize an incremental hash and return desulting 
digest
 
 
  &reftitle.description;
  
   stringhash_final
   
resourcecontext
   boolraw_output
  

 
 
  &reftitle.parameters;
  
   

 context
 
  
   Hashing context returned by hash_init.
  
 


 raw_output
 
  
   When set to &true;, outputs raw binary data.
   Default value (&false;) outpus lowercase hexits.
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   Returns a string containing the calculated message digest as lowercase hexits
   unless raw_output is set to true in which case the raw
   binary representation of the message digest is returned.
  
 

 
  &reftitle.examples;
  
   
hash_final



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
hash_init
hash_update

[PHP-DOC] cvs: phpdoc /en language-snippets.ent /en/reference/runkit/functions runkit-function-redefine.xml runkit-function-remove.xml runkit-function-rename.xml

[Sara Golemon]

pollita Wed Nov 16 18:55:07 2005 EDT

  Modified files:  
/phpdoc/en  language-snippets.ent 
/phpdoc/en/reference/runkit/functions   runkit-function-remove.xml 
runkit-function-redefine.xml 
runkit-function-rename.xml 
  Log:
  Document runkit.internal_override INI option
  
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.159&r2=1.160&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.159 
phpdoc/en/language-snippets.ent:1.160
--- phpdoc/en/language-snippets.ent:1.159   Wed Nov  9 06:14:34 2005
+++ phpdoc/en/language-snippets.ent Wed Nov 16 18:55:03 2005
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -613,6 +613,12 @@
 See the README file included in the runkit package for more information.
 '>
 
+By default, only
+userspace functions may be removed, renamed, or modified.  In order to
+override internal functions, you must enable the
+runkit.internal_override setting in the system-wide
+php.ini file.'>
+
 
 The publickey subsystem
 is used for managing publickeys on a server to which the client is
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-function-remove.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-function-remove.xml
diff -u phpdoc/en/reference/runkit/functions/runkit-function-remove.xml:1.1 
phpdoc/en/reference/runkit/functions/runkit-function-remove.xml:1.2
--- phpdoc/en/reference/runkit/functions/runkit-function-remove.xml:1.1 Sun May 
 1 02:24:46 2005
+++ phpdoc/en/reference/runkit/functions/runkit-function-remove.xml Wed Nov 
16 18:55:06 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -14,6 +14,9 @@
boolrunkit_function_remove

stringfuncname
   
+
+  ¬e.runkit.internal-override;
+
  
 
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml
diff -u phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml:1.1 
phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml:1.2
--- phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml:1.1   
Sun May  1 02:24:46 2005
+++ phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml   Wed Nov 
16 18:55:07 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -16,6 +16,9 @@
stringarglist
stringcode
   
+
+  ¬e.runkit.internal-override;
+
  
 
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-function-rename.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-function-rename.xml
diff -u phpdoc/en/reference/runkit/functions/runkit-function-rename.xml:1.1 
phpdoc/en/reference/runkit/functions/runkit-function-rename.xml:1.2
--- phpdoc/en/reference/runkit/functions/runkit-function-rename.xml:1.1 Sun May 
 1 02:24:46 2005
+++ phpdoc/en/reference/runkit/functions/runkit-function-rename.xml Wed Nov 
16 18:55:07 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -15,6 +15,9 @@

stringfuncname
stringnewname
   
+
+  ¬e.runkit.internal-override;
+
  
 
  

[PHP-DOC] cvs: phpdoc /en/reference/runkit/functions runkit-return-value-used.xml

[Sara Golemon]

pollita Wed Nov 16 18:47:28 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-return-value-used.xml 
  Log:
  Document runkit_return_value_used()
  

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml
+++ phpdoc/en/reference/runkit/functions/runkit-return-value-used.xml



 
  runkit_return_value_used
  Determines if the current functions return value will be 
used
 
 
  &reftitle.description;
  
   boolrunkit_return_value_used
   
  

 
 
  &reftitle.returnvalues;
  
   Returns &true; if the function's return value is used by the calling scope,
   otherwise &false;
  
 

 
  &reftitle.examples;
  
   
runkit_return_value_used example



&example.outputs;



   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Mon Oct 31 00:27:07 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Documented extended parent_scope setting
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.15&r2=1.16&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.15 
phpdoc/en/reference/runkit/sandbox.xml:1.16
--- phpdoc/en/reference/runkit/sandbox.xml:1.15 Thu Sep 29 20:47:18 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Mon Oct 31 00:27:06 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -393,6 +393,20 @@

0 (Global)
   
+  
+   parent_scope
+   String
+   
+When parent_scope is set to
+a string value, it refers to a named array variable
+in the global scope.  If the named variable does not
+exist at the time of access it will be created as an
+empty array.  If the variable exists but it not an array,
+a dummy array will be created containing a reference
+to the named global variable.
+   
+   
+  
  
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit reference.xml sandbox-parent.xml sandbox.xml

[Sara Golemon]

pollita Thu Sep 29 20:47:19 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit sandbox-parent.xml 

  Modified files:  
/phpdoc/en/reference/runkit reference.xml sandbox.xml 
  Log:
  Document Runkit_Sandbox_Parent
  
  http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/reference.xml?r1=1.8&r2=1.9&ty=u
Index: phpdoc/en/reference/runkit/reference.xml
diff -u phpdoc/en/reference/runkit/reference.xml:1.8 
phpdoc/en/reference/runkit/reference.xml:1.9
--- phpdoc/en/reference/runkit/reference.xml:1.8Tue Sep 27 04:52:35 2005
+++ phpdoc/en/reference/runkit/reference.xmlThu Sep 29 20:47:18 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
 
@@ -59,6 +59,7 @@
  
 
  &reference.runkit.sandbox;
+ &reference.runkit.sandbox-parent;
 
  &reference.runkit.functions;
 
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.14&r2=1.15&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.14 
phpdoc/en/reference/runkit/sandbox.xml:1.15
--- phpdoc/en/reference/runkit/sandbox.xml:1.14 Tue Sep 27 04:52:26 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Thu Sep 29 20:47:18 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -277,28 +277,30 @@
   

 Sandbox Settings / Status Indicators
-
+
  
   
Setting
-   Visibility
+   Type
Purpose
+   Default
   
  
  
   
active
-   Read Only
+   Boolean (Read Only)

 &true; if the Sandbox is still in a usable state,
 &false; if the request is in bailout due to a
 call to die(), exit(), or because of a fatal
 error condition.

+   &true; (Initial)
   
   
output_handler
-   Read/Write
+   Callback

 When set to a valid callback, all output generated
 by the Sandbox instance will be processed through
@@ -306,6 +308,90 @@
 Sandbox output handlers follow the same calling
 conventions as the system-wide output handler.

+   None
+  
+  
+   parent_access
+   Boolean
+   
+May the sandbox use instances of the
+Runkit_Sandbox_Parent class?
+Must be enabled for other
+Runkit_Sandbox_Parent
+related settings to work.
+   
+   &false;
+  
+  
+   parent_read
+   Boolean
+   
+May the sandbox read variables in its parent's context?
+   
+   &false;
+  
+  
+   parent_write
+   Boolean
+   
+May the sandbox modify variables in its parent's context?
+   
+   &false;
+  
+  
+   parent_eval
+   Boolean
+   
+May the sandbox evaluate arbitrary code in its
+parent's context? DANGEROUS
+   
+   &false;
+  
+  
+   parent_include
+   Boolean
+   
+May the sandbox include php code files in its
+parent's context? DANGEROUS
+   
+   &false;
+  
+  
+   parent_echo
+   Boolean
+   
+May the sandbox echo data in its parent's context
+effectively bypassing its own output_handler?
+   
+   &false;
+  
+  
+   parent_call
+   Boolean
+   
+May the sandbox call functions in its
+parent's context?
+   
+   &false;
+  
+  
+   parent_die
+   Boolean
+   
+May the sandbox kill its own parent? (And thus itself)
+   
+   &false;
+  
+  
+   parent_scope
+   Integer
+   
+What scope will parental property access look at?
+0 == Global scope, 1 == Calling scope,
+2 == Scope preceeding calling scope,
+3 == The scope before that, etc..., etc...
+   
+   0 (Global)
   
  
 

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/sandbox-parent.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/sandbox-parent.xml
+++ phpdoc/en/reference/runkit/sandbox-parent.xml




 
  Runkit_Sandbox_Parent
  
   Runkit Anti-Sandbox Class
  
 
 
  &reftitle.description;

  
   voidRunkit_Sandbox_Parent::__construct
   
  

  
   Instantiating the Runkit_Sandbox_Parent
   class from within a sandbox environment created from the
   Runkit_Sandbox class provides some
   (controlled) means for a sandbox child to access its parent.
  

  ¬e.runkit.sandbox;

  
   In order for any of the Runkit_Sandbox_Parent
   features to function.  Support must be enabled on a per-sandbox basis
   by enabling the parent_access flag from the parent's
   context.
  

  
   Working with variables in a sandbox
   

   
  

 

 
  Accessing the Parent's Variables
  
   Just as with sandbox variable access, a sandbox parent's
   variables may be read from and written to as properties of
   the Runkit_Sandbox_Parent class.
   Read access to parental variables may be enabled with
   the parent_read setting (in addition
   to the base parent_access setting.

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml /en/reference/runkit/functions runkit-sandbox-output-handler.xml

[Sara Golemon]

pollita Thu Sep 22 21:11:02 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit/functions   

runkit-sandbox-output-handler.xml 
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  These need examples, but it's late...
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml
diff -u 
phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.2 
phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.3
--- phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml:1.2  
Mon Jun  6 20:44:45 2005
+++ phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml  
Thu Sep 22 21:11:01 2005
@@ -1,5 +1,5 @@
 
-
+
 
  
   runkit_sandbox_output_handler
@@ -24,6 +24,16 @@
 
   ¬e.runkit.sandbox;
 
+  
+Deprecated
+
+  As of runkit version 0.5, this function is deprecated and is scheduled to
+  be removed from the package prior to a 1.0 release.  The output handler 
for
+  a given Runkit_Sandbox instance may be read/set using the array offset 
syntax
+  shown on the Runkit_Sandbox class 
definition page.
+
+  
+
  
 
  
@@ -63,6 +73,7 @@
   
  
 
+ 
  
   &reftitle.examples;
   
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.12&r2=1.13&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.12 
phpdoc/en/reference/runkit/sandbox.xml:1.13
--- phpdoc/en/reference/runkit/sandbox.xml:1.12 Fri Jul 22 15:35:26 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Thu Sep 22 21:11:02 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -190,7 +190,7 @@
   
  
 
- 
+ 
   Calling PHP Functions
   
Any function defined within the sandbox may be called as
@@ -252,6 +252,58 @@
   
  
 
+ 
+  Changing Sandbox Settings
+  
+   As of runkit version 0.5, certain Sandbox settings may
+   be modified on the fly using ArrayAccess syntax.
+   Some settings, such as active
+   are read-only and meant to provide status information.
+   Other settings, such as output_handler
+   may be set and read much like a normal array offset.
+   Future settings may be write-only, however no such
+   settings currently exist.
+  
+
+  
+   
+Sandbox Settings / Status Indicators
+
+ 
+  
+   Setting
+   Visibility
+   Purpose
+  
+ 
+ 
+  
+   active
+   Read Only
+   
+&true; if the Sandbox is still in a usable state,
+&false; if the request is in bailout due to a
+call to die(), exit(), or because of a fatal
+error condition.
+   
+  
+  
+   output_handler
+   Read/Write
+   
+When set to a valid callback, all output generated
+by the Sandbox instance will be processed through
+the named function.
+Sandbox output handlers follow the same calling
+conventions as the system-wide output handler.
+   
+  
+ 
+
+   
+  
+ 
+
 
 
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Fri Jul 22 15:35:26 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Document additional directives
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.11&r2=1.12&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.11 
phpdoc/en/reference/runkit/sandbox.xml:1.12
--- phpdoc/en/reference/runkit/sandbox.xml:1.11 Tue Jun 14 21:16:16 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Fri Jul 22 15:35:26 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -50,6 +50,35 @@
  
 
 
+ safe_mode_gid
+ 
+  
+   If the outer script which is instantiating the
+   Runkit_Sandbox class
+   is configured with safe_mode_gid = on, then 
safe_mode_gid
+   may be turned off for the sandbox environment.  This setting can not
+   be used to enable safe_mode_gid when it's already
+   disabled in the outer script.
+  
+ 
+
+
+ safe_mode_include_dir
+ 
+  
+   If the outer script which is instantiating the
+   Runkit_Sandbox class
+   is configured with a safe_mode_include_dir,
+   then a new safe_mode_include_dir may be set for sandbox environments
+   below the currently defined value.  safe_mode_include_dir may also be
+   cleared to indicate that the bypass feature is disabled.
+   If safe_mode_include_dir was blank in the outer script, but safe_mode
+   was not enabled, then any arbitrary safe_mode_include_dir may be set
+   while turning safe_mode on.
+  
+ 
+
+
  open_basedir
  
   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-publickey-add.xml ssh2-publickey-init.xml ssh2-publickey-list.xml ssh2-publickey-remove.xml

[Sara Golemon]

pollita Fri Jul 22 15:34:26 2005 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-publickey-add.xml 
ssh2-publickey-remove.xml 
ssh2-publickey-list.xml 
ssh2-publickey-init.xml 
  Log:
  Typos and Copy/Paste issues
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.1   Thu Jul 
21 17:37:49 2005
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml   Fri Jul 22 
15:34:25 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -111,8 +111,8 @@
   

 ssh2_publickey_init
-ssh2_publickey_remote
-Or ssh2_publickey_list
+ssh2_publickey_remove
+ssh2_publickey_list

   
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.1Thu Jul 
21 17:37:49 2005
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xmlFri Jul 
22 15:34:25 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -64,7 +64,7 @@

 ssh2_publickey_init
 ssh2_publickey_add
-Or ssh2_publickey_list
+ssh2_publickey_list

   
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.1  Thu Jul 
21 17:37:49 2005
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml  Fri Jul 22 
15:34:25 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -126,7 +126,7 @@

 ssh2_publickey_init
 ssh2_publickey_add
-Or ssh2_publickey_remove
+ssh2_publickey_remove

   
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.1  Thu Jul 
21 17:37:49 2005
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml  Fri Jul 22 
15:34:25 2005
@@ -1,5 +1,5 @@
 
-
+
   

 ssh2_publickey_init
@@ -33,14 +33,19 @@
  the ssh2_publickey_init function will return &false;.
 
 
-
- See Also:
- ssh2_publickey_add,
- ssh2_publickey_remove, and
- ssh2_publickey_list
-
+   
 
+   
+&reftitle.seealso;
+
+ 
+  ssh2_publickey_add
+  ssh2_publickey_remove
+  ssh2_publickey_list
+ 
+

+
   
 
 

[PHP-DOC] cvs: phpdoc /en language-snippets.ent /en/reference/ssh2/functions ssh2-publickey-add.xml ssh2-publickey-init.xml ssh2-publickey-list.xml ssh2-publickey-remove.xml

[Sara Golemon]

pollita Thu Jul 21 17:37:49 2005 EDT

  Added files: 
/phpdoc/en/reference/ssh2/functions ssh2-publickey-add.xml 
ssh2-publickey-init.xml 
ssh2-publickey-list.xml 
ssh2-publickey-remove.xml 

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  Document ssh2 publickey subsystem
  http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.151&r2=1.152&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.151 
phpdoc/en/language-snippets.ent:1.152
--- phpdoc/en/language-snippets.ent:1.151   Wed Jun  8 21:24:28 2005
+++ phpdoc/en/language-snippets.ent Thu Jul 21 17:37:48 2005
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -587,3 +587,10 @@
 patched versions of PHP 5.0 and requires that thread safety be enabled.
 See the README file included in the runkit package for more information.
 '>
+
+
+The publickey subsystem
+is used for managing publickeys on a server to which the client is
+already authenticated.  To authenticate to a remote system
+using publickey authentication, use the 
ssh2_auth_pubkey_file
+function instead.'>

http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml




 
  ssh2_publickey_add
  
   Add an authorized publickey
  
 
 
  &reftitle.description;
  
   boolssh2_publickey_add
   resourcepkey
   stringalgoname
   stringblob
   booloverwrite
   arrayattributes
  

  ¬e.ssh2.subsystem.publickey;

 
 
  &reftitle.parameters;
  
   

 pkey
 
  
   Publickey Subsystem resource created by 
ssh2_publickey_init.
  
 


 algoname
 
  
   Publickey algorithm (e.g): ssh-dss, ssh-rsa
  
 


 blob
 
  
   Publickey blob as raw binary
  
 


 overwrite
 
  
   If the specified key already exists, should it be overwritten?
  
 


 attributes
 
  
   Associative array of attributes to assign to this public key.
   Refer to ietf-secsh-publickey-subsystem for a list of supported 
attributes.
   To mark an attribute as mandatory, preceed its name with an asterix.
   If the server is unable to support an attribute marked mandatory,
   it will abort the add process.
  
 

   
  
 
 
  &reftitle.returnvalues;
  
&return.success;
  
 

 
  &reftitle.examples;
  
   
Adding a publickey with 
ssh2_publickey_add



   
  
 

 
  &reftitle.seealso;
  
   
ssh2_publickey_init
ssh2_publickey_remote
Or ssh2_publickey_list
   
  
 






http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml


  
   
ssh2_publickey_init

 Initialize Publickey subsystem

   
   
Description

 resourcessh2_publickey_init
 
resourcesession



 Request the Publickey subsystem from an already connected SSH2 server.


¬e.ssh2.subsystem.publickey;


 This method returns an SSH2 Publickey Subsystem
 resource for use with all other ssh2_publickey_*() methods.



 The publickey subsystem allows an already connected and authenticated
 client to manage the list of authorized public keys stored on the
 target server in an implementation agnostic manner.
 If the remote server does not support the publickey subsystem,
 the ssh2_publickey_init function will return &false;.



 See Also:
 ssh2_publickey_add,
 ssh2_publickey_remove, and
 ssh2_publickey_list


   
  



http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml




 
  ssh2_publickey_list
  
   List currently authorized publickeys
  
 
 
  &reftitle.description;
  
   arrayssh2_publickey_list
   resourcepkey
  

  ¬e.ssh2.subsystem.publickey;

 
 
  &reftitle.parameters;
  
   

 pkey
 
  
   Publickey Subsystem resource
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   Returns a numericly indexed array of keys,
   each of which is an associative array containing:
   name, blob, and attrs elements.
  
  
   
Publickey elements

 
  
   Array Key
   Meaning
  
 
 
  
   name
   Name of algorithm used by this publickey, for example:
  ssh-dss or ssh-rsa.
  
  
   blob
   Publickey blob as raw binary data.
  
  
   attrs
   Attributes assigned to this publickey

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml /en/reference/runkit/functions runkit-sandbox-output-handler.xml

[Sara Golemon]

pollita Fri Jun  3 20:47:35 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   

runkit-sandbox-output-handler.xml 

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Update runkit docs for rel 0.3
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.9 
phpdoc/en/reference/runkit/sandbox.xml:1.10
--- phpdoc/en/reference/runkit/sandbox.xml:1.9  Sun May 15 23:47:13 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Fri Jun  3 20:47:34 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -168,11 +168,9 @@
a method on the sandbox object.  This also includes a few
psuedo-function language constructs:  eval,
include, include_once,
-   require, and require_once.
-   Most notably abset are the language constructs: echo,
-   print, die, and 
exit.
-   These functions are excluded out of simplicity and to avoid confusion
-   as they would mostly likely be used incorrectly.
+   require, require_once,
+   echo, print,
+   die, and exit.
   
 
   

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml
+++ phpdoc/en/reference/runkit/functions/runkit-sandbox-output-handler.xml



 
  runkit_sandbox_output_handler
  
   Specify a function to capture and/or process output from a runkit sandbox
  
 
 
  &reftitle.description;
  
   mixedrunkit_sandbox_output_handler
   objectsandbox
   mixedcallback
  
  
   Ordinarily, anything output (such as with echo
   or print will be output as though it were printed
   from the parent's scope.  Using 
runkit_sandbox_output_handler
   however, output generated by the sandbox (including errors), can be captured
   by a function outside of the sandbox.
  

  ¬e.runkit.sandbox;

 

 
  &reftitle.parameters;
  
   

 sandbox
 
  
   Object instance of Runkit_Sandbox class on which to set output handling.
  
 


 callback
 
  
   Name of a function which expects one parameter.
   Output generated by sandbox will be passed
   to this callback.  Anything returned by the callback will be displayed
   normally.  If this parameter is not passed then output handling will not 
be changed.
   If a non-truth value is passed, output handling will be disabled and 
will revert to
   direct display.
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   Returns the name of the previously defined output handler callback, or
   &false; if no handler was previously defined.
  
 

 
  &reftitle.examples;
  
   
Feeding output to a variable



&example.outputs;



   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-exec.xml

[Sara Golemon]

pollita Wed May 18 13:54:24 2005 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-exec.xml 
  Log:
  Update proto
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-exec.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-exec.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.3 
phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.4
--- phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.3Wed Dec 29 
23:24:05 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-exec.xmlWed May 18 13:54:24 2005
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -14,7 +14,11 @@
  streamssh2_exec
  
resourcesession
  
stringcommand
+ stringpty
  arrayenv
+ intwidth
+ intheight
+ intwidth_height_type
 
 
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit reference.xml sandbox.xml /en/reference/runkit/functions runkit-function-add.xml /en/reference/ssh2/functions ssh2-connect.xml

[Sara Golemon]

pollita Tue May  3 16:09:43 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit/functions   runkit-function-add.xml 
/phpdoc/en/reference/runkit reference.xml sandbox.xml 
/phpdoc/en/reference/ssh2/functions ssh2-connect.xml 
  Log:
  Doctor, the patient is coming around...
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/functions/runkit-function-add.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/runkit/functions/runkit-function-add.xml
diff -u phpdoc/en/reference/runkit/functions/runkit-function-add.xml:1.1 
phpdoc/en/reference/runkit/functions/runkit-function-add.xml:1.2
--- phpdoc/en/reference/runkit/functions/runkit-function-add.xml:1.1Sun May 
 1 02:24:46 2005
+++ phpdoc/en/reference/runkit/functions/runkit-function-add.xmlTue May 
 3 16:09:42 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -35,7 +35,7 @@
  arglist
  
   
-   Coma separated argument list
+   Comma separated argument list
   
  
 
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/reference.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/runkit/reference.xml
diff -u phpdoc/en/reference/runkit/reference.xml:1.4 
phpdoc/en/reference/runkit/reference.xml:1.5
--- phpdoc/en/reference/runkit/reference.xml:1.4Mon May  2 17:23:54 2005
+++ phpdoc/en/reference/runkit/reference.xmlTue May  3 16:09:42 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  runkit Functions
@@ -54,7 +54,7 @@
 

 The runkit.superglobal ini option may be set to a
-coma-separated list of variable names to be treated as superglobals.
+comma-separated list of variable names to be treated as superglobals.
 This value should be set in the systemwide php.ini file, but may work
 in perdir configuration contexts depending on your SAPI.

http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.5 
phpdoc/en/reference/runkit/sandbox.xml:1.6
--- phpdoc/en/reference/runkit/sandbox.xml:1.5  Tue May  3 16:06:50 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Tue May  3 16:09:42 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -69,7 +69,7 @@
  disable_functions
  
   
-   Coma separated list of functions to disable within the sandbox 
sub-interpreter.
+   Comma separated list of functions to disable within the sandbox 
sub-interpreter.
This list need not contain the names of the currently disabled 
functions,
they will remain disabled whether listed here or not.
   
@@ -79,7 +79,7 @@
  disable_classes
  
   
-   Coma separated list of classes to disable within the sandbox 
sub-interpreter.
+   Comma separated list of classes to disable within the sandbox 
sub-interpreter.
This list need not contain the names of the currently disabled classes,
they will remain disabled whether listed here or not.
   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-connect.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-connect.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.5 
phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.6
--- phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.5 Thu Jan 13 
11:41:30 2005
+++ phpdoc/en/reference/ssh2/functions/ssh2-connect.xml Tue May  3 16:09:42 2005
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -43,7 +43,7 @@
 
  kex
  
-  List of key exchange methods to advertise, coma separated
+  List of key exchange methods to advertise, comma separated
   in order of preference.
  
  
@@ -110,7 +110,7 @@

 
  crypt
- List of crypto methods to advertise, coma separated
+ List of crypto methods to advertise, comma separated
   in order of preference.
  
   [EMAIL PROTECTED],
@@ -126,7 +126,7 @@
 
 
  comp
- List of compression methods to advertise, coma separated
+ List of compression methods to advertise, comma separated
   in order of preference.
  
   zlib and

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Tue May  3 16:06:52 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Document runkit.superglobal option to Runkit_Sandbox
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.4 
phpdoc/en/reference/runkit/sandbox.xml:1.5
--- phpdoc/en/reference/runkit/sandbox.xml:1.4  Mon May  2 17:28:18 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Tue May  3 16:06:50 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -85,6 +85,16 @@
   
  
 
+
+ runkit.superglobal
+ 
+  
+   Comma separated list of variables to be treated as superglobals within 
the
+   sandbox sub-interpreter.  These variables will be used in addition to 
any
+   variables defined internally or through the global runkit.superglobal 
setting.
+  
+ 
+

   
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Mon May  2 17:28:18 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Copy/Paste typo
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.3 
phpdoc/en/reference/runkit/sandbox.xml:1.4
--- phpdoc/en/reference/runkit/sandbox.xml:1.3  Mon May  2 17:21:28 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Mon May  2 17:28:18 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -145,7 +145,7 @@
  
 
  
-  Accessing Variables
+  Calling PHP Functions
   
Any function defined within the sandbox may be called as
a method on the sandbox object.  This also includes a few

[PHP-DOC] cvs: phpdoc /en language-snippets.ent

[Sara Golemon]

pollita Mon May  2 17:26:12 2005 EDT

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  Typo - line/lint
  
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.149&r2=1.150&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.149 
phpdoc/en/language-snippets.ent:1.150
--- phpdoc/en/language-snippets.ent:1.149   Mon May  2 15:32:58 2005
+++ phpdoc/en/language-snippets.ent Mon May  2 17:26:11 2005
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -580,7 +580,7 @@
 '>
 
 Sandbox support (required for
-runkit_lint, runkit_line_file,
+runkit_lint, runkit_lint_file,
 and the Runkit_Sandbox class) is only available with PHP 5.1 or specially
 patched versions of PHP 5.0 and requires that thread safety be enabled.
 See the README file included in the runkit package for more information.

[PHP-DOC] cvs: phpdoc /en/reference/runkit reference.xml

[Sara Golemon]

pollita Mon May  2 17:23:54 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit reference.xml 
  Log:
  Don't forget the constants
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/reference.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/runkit/reference.xml
diff -u phpdoc/en/reference/runkit/reference.xml:1.3 
phpdoc/en/reference/runkit/reference.xml:1.4
--- phpdoc/en/reference/runkit/reference.xml:1.3Mon May  2 16:48:28 2005
+++ phpdoc/en/reference/runkit/reference.xmlMon May  2 17:23:54 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  runkit Functions
@@ -82,6 +82,8 @@

   
 
+  &reference.runkit.constants;
+
  
 
  &reference.runkit.sandbox;

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Mon May  2 17:21:29 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Use return value in examples
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.2 
phpdoc/en/reference/runkit/sandbox.xml:1.3
--- phpdoc/en/reference/runkit/sandbox.xml:1.2  Mon May  2 17:01:59 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Mon May  2 17:21:28 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -165,7 +165,7 @@
 str_replace('a','f','abc');
+echo $sandbox->str_replace('a','f','abc');
 ]]>

   
@@ -191,8 +191,8 @@
 
 $foo = 'bar';
 $sandbox->foo = 'baz';
-$sandbox->str_replace('a',$foo,'a');
-$sandbox->str_replace('a',$sandbox->foo,'a');
+echo $sandbox->str_replace('a',$foo,'a');
+echo $sandbox->str_replace('a',$sandbox->foo,'a');
 ]]>

   

[PHP-DOC] cvs: phpdoc /en/reference/runkit sandbox.xml

[Sara Golemon]

pollita Mon May  2 17:02:00 2005 EDT

  Modified files:  
/phpdoc/en/reference/runkit sandbox.xml 
  Log:
  Forgot to note the special requirements of Runkit_Sandbox
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/sandbox.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/runkit/sandbox.xml
diff -u phpdoc/en/reference/runkit/sandbox.xml:1.1 
phpdoc/en/reference/runkit/sandbox.xml:1.2
--- phpdoc/en/reference/runkit/sandbox.xml:1.1  Mon May  2 16:48:28 2005
+++ phpdoc/en/reference/runkit/sandbox.xml  Mon May  2 17:01:59 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  
@@ -17,6 +17,8 @@
may be restricted to a subset of what the primary interpreter can do and 
provide a
safer environment for executing user supplied code.
   
+
+  ¬e.runkit.sandbox;
  
 
  

[PHP-DOC] cvs: phpdoc /en/reference/runkit reference.xml sandbox.xml

[Sara Golemon]

pollita Mon May  2 16:48:29 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit sandbox.xml 

  Modified files:  
/phpdoc/en/reference/runkit reference.xml 
  Log:
  Document the Runkit_Sandbox class
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/reference.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/reference.xml
diff -u phpdoc/en/reference/runkit/reference.xml:1.2 
phpdoc/en/reference/runkit/reference.xml:1.3
--- phpdoc/en/reference/runkit/reference.xml:1.2Sun May  1 05:08:13 2005
+++ phpdoc/en/reference/runkit/reference.xmlMon May  2 16:48:28 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  runkit Functions
@@ -83,6 +83,9 @@
   
 
  
+
+ &reference.runkit.sandbox;
+
  &reference.runkit.functions;
 
 

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/sandbox.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/sandbox.xml
+++ phpdoc/en/reference/runkit/sandbox.xml




 
  Runkit_Sandbox
  
   Runkit Sandbox Class -- PHP Virtual Machine
  
 
 
  &reftitle.description;

  
   Instantiating the Runkit_Sandbox class creates a new thread with its own 
scope
   and program stack.  Using a set of options passed to the constructor, this 
environment
   may be restricted to a subset of what the primary interpreter can do and 
provide a
   safer environment for executing user supplied code.
  
 

 
  Constructor
  
   voidRunkit_Sandbox::__construct
   arrayoptions
  

  
   option is an associative array containing
   any combination of the special ini options listed below.
  

  
   

 safe_mode
 
  
   If the outer script which is instantiating the Runkit_Sandbox class
   is configured with safe_mode = off, then safe_mode
   may be turned on for the sandbox environment.  This setting can not
   be used to disable safe_mode when it's already enabled in the outer 
script.
  
 


 open_basedir
 
  
   open_basedir may be set to any path below the
   current setting of open_basedir.  If open_basedir is not set within the 
global scope,
   then it is assumed to be the root directory and may be set to any 
location.
  
 


 allow_url_fopen
 
  
   Like safe_mode, this setting can only be made 
more restrictive,
   in this case by setting it to &false; when it is previously set to &true;
  
 


 disable_functions
 
  
   Coma separated list of functions to disable within the sandbox 
sub-interpreter.
   This list need not contain the names of the currently disabled functions,
   they will remain disabled whether listed here or not.
  
 


 disable_classes
 
  
   Coma separated list of classes to disable within the sandbox 
sub-interpreter.
   This list need not contain the names of the currently disabled classes,
   they will remain disabled whether listed here or not.
  
 

   
  

  
   Instantiating a restricted sandbox
   

   
  
 

 
  Accessing Variables
  
   All variables in the global scope of the sandbox environment
   are accessible as properties of the sandbox object.
   The first thing to note is that because of the way memory
   between these two threads is managed, object and resource
   variables can not currently be exchanged between interpreters.
   Additionally, all arrays are deep copied and any references
   will be lost.  This also means that references between
   interpreters are not possible.
  

  
   Working with variables in a sandbox
   

   
  
  

  
 

 
  Accessing Variables
  
   Any function defined within the sandbox may be called as
   a method on the sandbox object.  This also includes a few
   psuedo-function language constructs:  eval,
   include, include_once,
   require, and require_once.
   Most notably abset are the language constructs: echo,
   print, die, and 
exit.
   These functions are excluded out of simplicity and to avoid confusion
   as they would mostly likely be used incorrectly.
  

  
   Calling sandbox functions
   

   
  
  

  

  
   When passing arguments to a sandbox function, the arguments
   are taken from the outer instance of PHP.  If you wish to pass
   arguments from the sandbox's scope, be sure to access them as
   properties of the sandbox object as illustrated above.
  

  
   Passing arguments to sandbox functions
   

   
  
  

  
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit constants.xml /en/reference/runkit/functions runkit-import.xml

[Sara Golemon]

pollita Mon May  2 15:50:54 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-import.xml 

  Modified files:  
/phpdoc/en/reference/runkit constants.xml 
  Log:
  Define runkit_import()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/runkit/constants.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/runkit/constants.xml
diff -u phpdoc/en/reference/runkit/constants.xml:1.2 
phpdoc/en/reference/runkit/constants.xml:1.3
--- phpdoc/en/reference/runkit/constants.xml:1.2Sun May  1 05:08:13 2005
+++ phpdoc/en/reference/runkit/constants.xmlMon May  2 15:50:53 2005
@@ -1,5 +1,5 @@
 
-
+
 
 
  &reftitle.constants;
@@ -12,7 +12,9 @@


 
- runkit_import flag
+ runkit_import flag indicating
+ that normal functions should be imported from the
+ specified file.
 

   
@@ -23,7 +25,9 @@


 
- runkit_import flag
+ runkit_import flag indicating
+ that class methods should be imported from the
+ specified file.
 

   
@@ -34,7 +38,10 @@


 
- runkit_import flag
+ runkit_import flag indicating
+ that class constants should be imported from the
+ specified file.  Note that this flag is only meaningful
+ in PHP versions 5.1.0 and above.
 

   
@@ -45,7 +52,9 @@


 
- runkit_import flag
+ runkit_import flag indicating
+ that class standard properties should be imported
+ from the specified file.
 

   
@@ -56,18 +65,24 @@


 
- runkit_import flag
+ runkit_import flag representing
+ a bitwise OR of the RUNKIT_IMPORT_CLASS_*
+ constants.
 

   
   

-RUNKIT_IMPORT_OVERRIDE
+RUNKIT_IMPORT_OVERRIDE 
  (integer)


 
- runkit_import flag
+ runkit_import flag indicating that
+ if any of the imported functions, methods, constants,
+ or properties already exist, they should be replaced with
+ the new definitions.  If this flag is not set, then any
+ imported definitions which already exist will be discarded.
 

   

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-import.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-import.xml
+++ phpdoc/en/reference/runkit/functions/runkit-import.xml




 
  runkit_import
  
   Process a PHP file importing function and class definitions, overwriting 
where appropriate
  
 
 
  &reftitle.description;
  
   boolrunkit_import
   stringfilename
   intflags
  
  
   Similar to include however any code residing outside
   of a function or class is simply ignored.
   Additionally, depending on the value of flags,
   any functions or classes which already exist in the currently running 
environment
   will be automatically overwritten by their new definitions.
  
 

 
  &reftitle.parameters;
  
   

 filename
 
  
   Filename to import function and class definitions from
  
 


 flags
 
  
   Bitwise OR of the RUNKIT_IMPORT_* family of 
constants.
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   &return.success;
  
 

[PHP-DOC] cvs: phpdoc /en language-snippets.ent /en/reference/runkit/functions runkit-lint-file.xml runkit-lint.xml runkit-superglobals.xml

[Sara Golemon]

pollita Mon May  2 15:32:59 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-lint.xml 
runkit-lint-file.xml 
runkit-superglobals.xml 

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  Add note about sandbox support in runkit and document runkit_lint(), 
runkit_lint_file(), and runkit_superglobals()
  
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.148&r2=1.149&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.148 
phpdoc/en/language-snippets.ent:1.149
--- phpdoc/en/language-snippets.ent:1.148   Sun May  1 13:33:08 2005
+++ phpdoc/en/language-snippets.ent Mon May  2 15:32:58 2005
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -579,3 +579,9 @@
 be used to manipulate the currently running (or chained) method.
 '>
 
+Sandbox support (required for
+runkit_lint, runkit_line_file,
+and the Runkit_Sandbox class) is only available with PHP 5.1 or specially
+patched versions of PHP 5.0 and requires that thread safety be enabled.
+See the README file included in the runkit package for more information.
+'>

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-lint.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-lint.xml
+++ phpdoc/en/reference/runkit/functions/runkit-lint.xml




 
  runkit_lint
  
   Check the PHP syntax of the specified php code
  
 
 
  &reftitle.description;
  
   boolrunkit_lint
   stringcode
  
  
   The runkit_lint function performs a syntax (lint)
   check on the specified php code testing for scripting errors.
   This is similar to using php -l from the commandline except
   runkit_lint accepts actual code rather than a filename.
  

  ¬e.runkit.sandbox;

 

 
  &reftitle.parameters;
  
   

 code
 
  
   PHP Code to be lint checked
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
runkit_lint_file
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-lint-file.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-lint-file.xml
+++ phpdoc/en/reference/runkit/functions/runkit-lint-file.xml




 
  runkit_lint_file
  
   Check the PHP syntax of the specified file
  
 
 
  &reftitle.description;
  
   boolrunkit_lint_file
   stringfilename
  
  
   The runkit_lint_file function performs a syntax (lint) 
check
   on the specified filename testing for scripting errors. This is similar to 
using php -l
   from the commandline.
  

  ¬e.runkit.sandbox;

 
 
  &reftitle.parameters;
  
   

 filename
 
  
   File containing PHP Code to be lint checked
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
runkit_lint
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-superglobals.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-superglobals.xml
+++ phpdoc/en/reference/runkit/functions/runkit-superglobals.xml




 
  runkit_superglobals
  
   Return numericly indexed array of registered superglobals
  
 
 
  &reftitle.description;
  
   arrayrunkit_superglobals
   
  
 

 
  &reftitle.returnvalues;
  
   Returns a numericly indexed array of the currently registered superglobals.
   i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES
  
 

 
  &reftitle.seealso;
  
   
Variable 
Scope
   
  
 

[PHP-DOC] cvs: phpdoc /en language-snippets.ent /en/reference/runkit/functions runkit-method-add.xml runkit-method-copy.xml runkit-method-redefine.xml runkit-method-remove.xml runkit-method-rename.xm

[Sara Golemon]

pollita Sun May  1 13:33:09 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-method-add.xml 
runkit-method-copy.xml 
runkit-method-redefine.xml 
runkit-method-remove.xml 
runkit-method-rename.xml 

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  Add runkit_method_*() functions and matching entity
  http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.147&r2=1.148&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.147 
phpdoc/en/language-snippets.ent:1.148
--- phpdoc/en/language-snippets.ent:1.147   Mon Apr 25 21:20:37 2005
+++ phpdoc/en/language-snippets.ent Sun May  1 13:33:08 2005
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -570,7 +570,12 @@
 
 
 
-
+
 This function cannot
 be used to manipulate the currently running (or chained) method.
 '>
+
+This function cannot
+be used to manipulate the currently running (or chained) method.
+'>
+

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-method-add.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-method-add.xml
+++ phpdoc/en/reference/runkit/functions/runkit-method-add.xml



 
  runkit_method_add
  Dynamically adds a new method to a given class
 
 
  &reftitle.description;
  
   boolrunkit_method_add
   
stringclassname
   
stringmethodname
   stringargs
   stringcode
   intflags
  
  &warn.experimental.func;
 
 
  &reftitle.parameters;
  
   

 classname
 
  
   The class to which this method will be added
  
 


 methodname
 
  
   The name of the method to add
  
 


 args
 
  
   Comma-delimited list of arguments for the newly-created method
  
 


 code
 
  
   The code to be evaluated when methodname
   is called
  
 


 flags
 
  
   The type of method to create, can be
   RUNKIT_ACC_PUBLIC,
   RUNKIT_ACC_PROTECTED or
   RUNKIT_ACC_PRIVATE
  
  
   
This parameter is only used as of PHP 5, because, prior to this,
all methods were public.
   
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 
 
 
  &reftitle.examples;
  
   
runkit_method_add example



&example.outputs;



   
  
 
 
  &reftitle.seealso;
  
   
runkit_method_copy
runkit_method_redefine
runkit_method_remove
runkit_method_rename
runkit_function_add
   
  
 




http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-method-copy.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-method-copy.xml
+++ phpdoc/en/reference/runkit/functions/runkit-method-copy.xml



 
  runkit_method_copy
  Copies a method from class to another
 
 
  &reftitle.description;
  
   boolrunkit_method_copy
   stringdClass
   stringdMethod
   stringsClass
   stringsMethod
  
  &warn.experimental.func;
 
 
  &reftitle.parameters;
  
   

 dClass
 
  
   Destination class for copied method
  
 


 dMethod
 
  
   Destination method name
  
 


 sClass
 
  
   Source class of the method to copy
  
 


 sMethod
 
  
   Name of the method to copy from the source class. If this parameter is
   omitted, the value of dMethod is assumed.
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 
 
 
  &reftitle.examples;
  
   
runkit_method_copy example



&example.outputs;



   
  
 
 
  &reftitle.seealso;
  
   
runkit_method_add
runkit_method_redefine
runkit_method_remove
runkit_method_rename
runkit_function_copy
   
  
 




http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-method-redefine.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-method-redefine.xml
+++ phpdoc/en/reference/runkit/functions/runkit-method-redefine.xml



 
  runkit_method_redefine
  Dynamically changes the code of the given method
 
 
  &reftitle.description;
  
   boolrunkit_method_redefine
   
stringclassname
   
stringmethodname
   stringargs
   stringcode
   intflags
  
  ¬e.runkit.selfmanipulation;
  &warn.experimental.func;
 
 
  &reftitle.parameters;
  
   

 classname
 
  
   The class in which to redefine the method
  
 


 methodname
 
  
   The name of the method to redefine
  
 


 args
 
  
   Comma-delimited list of arguments for the redefined method
  
 


 code
 
  
   The new code to be evaluated when methodname
   is called
  
 

   

[PHP-DOC] cvs: phpdoc /en/reference/runkit/functions runkit-function-add.xml runkit-function-copy.xml runkit-function-redefine.xml runkit-function-remove.xml runkit-function-rename.xml

[Sara Golemon]

pollita Sun May  1 02:24:46 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-function-add.xml 
runkit-function-copy.xml 
runkit-function-redefine.xml 
runkit-function-remove.xml 
runkit-function-rename.xml 
  Log:
  Initial Revision
  
http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-function-add.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-function-add.xml
+++ phpdoc/en/reference/runkit/functions/runkit-function-add.xml




 
  runkit_function_add
  
   Add a new function, similar to create_function
  
 

 
  &reftitle.description;
  
   boolrunkit_function_add
   stringfuncname
   stringarglist
   stringcode
  
 

 
  &reftitle.parameters;
  
   

 funcname
 
  
   Name of function to be created
  
 


 arglist
 
  
   Coma separated argument list
  
 


 code
 
  
   Code making up the function
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.examples;
  
   
A runkit_function_add example



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
create_function
runkit_function_redefine
runkit_function_copy
runkit_function_rename
runkit_function_remove
runkit_method_add
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-function-copy.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-function-copy.xml
+++ phpdoc/en/reference/runkit/functions/runkit-function-copy.xml




 
  runkit_function_copy
  
   Copy a function to a new function name
  
 
 
  &reftitle.description;
  
   boolrunkit_function_copy
   stringfuncname
   
stringtargetname
  
 

 
  &reftitle.parameters;
  
   

 funcname
 
  
   Name of existing function
  
 


 targetname
 
  
   Name of new function to copy definition to
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.examples;
  
   
A runkit_function_copy example



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
runkit_function_add
runkit_function_redefine
runkit_function_rename
runkit_function_remove
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml
+++ phpdoc/en/reference/runkit/functions/runkit-function-redefine.xml




 
  runkit_function_redefine
  
   Replace a function definition with a new implementation
  
 
 
  &reftitle.description;
  
   boolrunkit_function_redefine
   stringfuncname
   stringarglist
   stringcode
  
 

 
  &reftitle.parameters;
  
   

 funcname
 
  
   Name of function to redefine
  
 


 arglist
 
  
   New list of arguments to be accepted by function
  
 


 code
 
  
   New code implementation
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.examples;
  
   
A runkit_function_redefine example



&example.outputs;



   
  
 

 
  &reftitle.seealso;
  
   
runkit_function_add
runkit_function_copy
runkit_function_rename
runkit_function_remove
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-function-remove.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-function-remove.xml
+++ phpdoc/en/reference/runkit/functions/runkit-function-remove.xml




 
  runkit_function_remove
  
   Remove a function definition
  
 
 
  &reftitle.description;
  
   boolrunkit_function_remove
   stringfuncname
  
 

 
  &reftitle.parameters;
  
   

 funcname
 
  
   Name of function to be deleted
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
runkit_function_add
runkit_function_copy
runkit_function_redefine
runkit_function_rename
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-function-rename.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-function-rename.xml
+++ phpdoc/en/reference/runkit/functions/runkit-function-rename.xml




 
  runkit_function_rename
  
   Change a function's name
  
 
 
  &reftitle.description;
  
   boolrunkit_function_rename
   stringfuncname
   stringnewname
  
 

 
  &reftitle.parameters;
  
   

 funcname
 
  
   Current function name
  
 


 newname
 
  
   New function name
  
 

   
  
 
 
  &reftitle.retu

[PHP-DOC] cvs: phpdoc /en/reference/runkit/functions runkit-constant-add.xml runkit-constant-redefine.xml runkit-constant-remove.xml

[Sara Golemon]

pollita Sun May  1 01:03:40 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit/functions   runkit-constant-add.xml 
runkit-constant-redefine.xml 
runkit-constant-remove.xml 
  Log:
  Initial Revision
  

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-constant-add.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-constant-add.xml
+++ phpdoc/en/reference/runkit/functions/runkit-constant-add.xml




 
  runkit_constant_add
  
   Similar to define(), but allows defining in class definitions as well
  
 
 
  &reftitle.description;
  
   boolrunkit_constant_add
   mixedconstname
   mixedvalue
  
 
 
  &reftitle.parameters;
  
   

 constname
 
  
   Name of constant to declare.  Either a string to indicate a global 
constant,
   or an array to indicate a class constant.
  
 


 value
 
  
   NULL, Bool, Long, Double, String, or Resource value to store in the new 
constant.
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
define
runkit_constant_redefine
runkit_constant_remove
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-constant-redefine.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-constant-redefine.xml
+++ phpdoc/en/reference/runkit/functions/runkit-constant-redefine.xml




 
  runkit_constant_redefine
  
   
  
 
 
  &reftitle.description;
  
   boolrunkit_constant_redefine
   mixedconstname
   mixednewvalue
  
 

 
  &reftitle.parameters;
  
   

 constname
 
  
   Constant to redefine.  Either string indicating global constant,
   or array indicating class constant.
  
 


 newvalue
 
  
   New value to assign to constant.
  
 

   
  
 
 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
runkit_constant_add
runkit_constant_remove
   
  
 





http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-constant-remove.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-constant-remove.xml
+++ phpdoc/en/reference/runkit/functions/runkit-constant-remove.xml




 
  runkit_constant_remove
  
   Remove/Delete an already defined constant
  
 
 
  &reftitle.description;
  
   boolrunkit_constant_remove
   mixedconstname
  
 

 
  &reftitle.parameters;
  
   

 constname
 
  
   Name of constant to remove.  Either a string indicating a global 
constant,
   or an aray indicating a class constant.
  
 

   
  
 

 
  &reftitle.returnvalues;
  
   &return.success;
  
 

 
  &reftitle.seealso;
  
   
define
runkit_constant_add
runkit_constant_redefine
   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/runkit .cvsignore constants.xml reference.xml /en/reference/runkit/functions runkit-class-adopt.xml runkit-class-emancipate.xml

[Sara Golemon]

pollita Sun May  1 00:55:00 2005 EDT

  Added files: 
/phpdoc/en/reference/runkit constants.xml reference.xml .cvsignore 
/phpdoc/en/reference/runkit/functions   runkit-class-adopt.xml 
runkit-class-emancipate.xml 
  Log:
  Initial Revision
  
http://cvs.php.net/co.php/phpdoc/en/reference/runkit/constants.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/constants.xml
+++ phpdoc/en/reference/runkit/constants.xml




 &reftitle.constants;
 &extension.constants;
 
  
   
RUNKIT_IMPORT_FUNCTIONS
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_IMPORT_CLASS_METHODS
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_IMPORT_CLASS_CONSTS
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_IMPORT_CLASS_PROPS
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_IMPORT_CLASSES
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_IMPORT_OVERRIDE
 (integer)
   
   

 runkit_import flag

   
  
  
   
RUNKIT_ACC_PUBLIC
 (integer)
   
   

 PHP5 specific flag to runkit_method_add

   
  
  
   
RUNKIT_ACC_PROTECTED
 (integer)
   
   

 PHP5 specific flag to runkit_method_add

   
  
  
   
RUNKIT_ACC_PRIVATE
 (integer)
   
   

 PHP5 specific flag to runkit_method_add

   
  
  
   
CLASSKIT_ACC_PUBLIC
 (integer)
   
   

 PHP5 specific flag to classkit_method_add
 Only defined when classkit compatability is enabled.

   
  
  
   
CLASSKIT_ACC_PROTECTED
 (integer)
   
   

 PHP5 specific flag to classkit_method_add
 Only defined when classkit compatability is enabled.

   
  
  
   
CLASSKIT_ACC_PRIVATE
 (integer)
   
   

 PHP5 specific flag to classkit_method_add
 Only defined when classkit compatability is enabled.

   
  
  
   
CLASSKIT_AGGREGATE_OVERRIDE
 (integer)
   
   

 PHP5 specific flag to classkit_import
 Only defined when classkit compatability is enabled.

   
  
  
   
RUNKIT_VERSION
 (string)
   
   

 Defined to the current version of the runkit package.

   
  
  
   
CLASSKIT_VERSION
 (string)
   
   

 Defined to the current version of the runkit package.
 Only defined when classkit compatability is enabled.

   
  
 




http://cvs.php.net/co.php/phpdoc/en/reference/runkit/reference.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/reference.xml
+++ phpdoc/en/reference/runkit/reference.xml




 runkit Functions
 runkit

 
  
   &reftitle.intro;
   
The runkit extension provides means to modify constants,
user-defined functions, and user-defined classes.
It also provides for custom superglobal variables
and embeddable sub-interpreters via sandboxing.
   

   
&pecl.info;
&url.pecl.package;runkit.
   

   
This package is meant as a feature added replacement for the
classkit package.
When compiled with the --enable-runkit=classkit
option to ./configure, it will export classkit compatable function 
definitions
and constants.
   
  

  
   &reftitle.required;
   
Modifying Constants, Functions, Classes, and Methods
works with all releases of PHP4 and PHP5.  No special requirements are 
necessary.
   

   
Custom Superglobals are only available in PHP 4.2.0 or 
later.
   

   
Sandboxing requires PHP 5.1.0 or later, or
PHP 5.0.0 with a special TSRM patch applied.
Regardless of which version of PHP is in use it must be compiled with the
--enable-maintainer-zts option.
See the README file in the runkit package for additional 
information.
   
  

  
   Custom Superglobals

   
The runkit.superglobal ini option may be set to a
coma-separated list of variable names to be treated as superglobals.
This value should be set in the systemwide php.ini file, but may work
in perdir configuration contexts depending on your SAPI.
   

   
Custom Superglobals with runkit.superglobal=_FOO,_BAR in 
php.ini



   
  

 
 &reference.runkit.functions;




http://cvs.php.net/co.php/phpdoc/en/reference/runkit/.cvsignore?r=1.1&p=1
Index: phpdoc/en/reference/runkit/.cvsignore
+++ phpdoc/en/reference/runkit/.cvsignore
functions.xml

http://cvs.php.net/co.php/phpdoc/en/reference/runkit/functions/runkit-class-adopt.xml?r=1.1&p=1
Index: phpdoc/en/reference/runkit/functions/runkit-class-adopt.xml
+++ phpdoc/en/reference/runkit/functions/runkit-class-adopt.xml




 
  runkit_class_adopt
  
   Convert a base class to an inherited class, add ancestral methods when 
appropriate
  
 
 
  &reftitle.description;
  
   boolrunkit_class_adopt
   
stringclassname
   
stringparentname
  

 
 
  &reftitle.parameters;
  
   

 classname
 
  
   Name of class to be adopted
 

Re: [PHP-DOC] cvs: phpdoc /en/reference/ssh2 installation.xml

[Sara Golemon]

> Why does the ssh2 PECL extension have its own complete
> installation documentation? Rather then duplicate this
> information for every extension it would be nice to expand
> the installation.pecl docs to cover more, and refer to it,
> and only include extension specific information in
> installation.xml
>
I agree, I had several dozen users prompting me for installation 
instructions though and rather than hash out a meaningful solution like 
you're alluding to, I just solved the "right now" problem.

I'm all for working up a Grand Unified Installation document and trimming 
out ssh2's installation.xml when the time comes.

-Sara 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2 installation.xml

[Sara Golemon]

pollita Tue Mar  1 17:31:00 2005 EDT

  Modified files:  
/phpdoc/en/reference/ssh2   installation.xml 
  Log:
  Typo: Forgot --with-ssh2 parameter
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/installation.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/ssh2/installation.xml
diff -u phpdoc/en/reference/ssh2/installation.xml:1.2 
phpdoc/en/reference/ssh2/installation.xml:1.3
--- phpdoc/en/reference/ssh2/installation.xml:1.2   Mon Feb 21 21:07:11 2005
+++ phpdoc/en/reference/ssh2/installation.xml   Tue Mar  1 17:31:00 2005
@@ -1,5 +1,5 @@
 
-
+
 
  &reftitle.install;
  
@@ -86,8 +86,8 @@
download and install PECL/ssh2, you may download the tarball from
PECL.
From the root of the unpacked tarball, run:
-   phpize && ./configure && make to generate
-   ssh2.so.
+   phpize && ./configure --with-ssh2 && make
+   to generate ssh2.so.
Once built, continue the installation from step 4 above.
   
  

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Sun Feb 27 02:50:26 2005 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Document filters.encryption and change  tags to 
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.13&r2=1.14&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.13 
phpdoc/en/appendices/filters.xml:1.14
--- phpdoc/en/appendices/filters.xml:1.13   Sun Feb  6 18:48:58 2005
+++ phpdoc/en/appendices/filters.xmlSun Feb 27 02:50:25 2005
@@ -1,5 +1,5 @@
 
-
+
 
  List of Available Filters
  
@@ -233,7 +233,8 @@
   Compression Filters
 
   
-   While the  provide a way of creating
+   While the Compression Wrappers
+   provide a way of creating
gzip and bz2 compatible files on the local filesystem, they do not provide 
a 
means for generalized compression over network streams, nor do they provide 
a 
means to begin with a non-compressed stream and transition to a compressed 
one.  
@@ -279,7 +280,7 @@
 
   
 zlib.* compression filters are available with PHP as of version 
5.1.0 if
- support is enabled.  They are also available as 
a backport in version
+zlib support is enabled.  They are also 
available as a backport in version
 5.0.x by installing the zlib_filter
 package from PECL.  These filters are 
not
 available for PHP 4.
@@ -381,7 +382,7 @@
 
   
 bzip2.* compression filters are available with PHP as of version 
5.1.0 if
- support is enabled.  They are also available 
as a backport in version
+bz2 support is enabled.  They are also 
available as a backport in version
 5.0.x by installing the bz2_filter
 package from PECL.  These filters are 
not
 available for PHP 4.
@@ -418,6 +419,120 @@
   
  
 
+ 
+  Encryption Filters
+
+  
+   mcrypt.* and mdecrypt.*
+   provide symmetric encryption and decryption using libmcrypt.
+   Both sets of filters support the same algorithms available to
+   mcrypt extension in the form of
+   mcrypt.ciphername where ciphername
+   is the name of the cipher as it would be passed to
+   mcrypt_module_open.
+   The following five filter parameters are also available:
+  
+
+  
+   
+mcrypt filter parameters
+
+ 
+  
+   Parameter
+   Required?
+   Default
+   Sample Values
+  
+ 
+ 
+  
+   mode
+   Optional
+   cbc
+   cbc, cfb, ecb, nofb, ofb, stream
+  
+  
+   algorithms_dir
+   Optional
+   ini_get('mcrypt.algorithms_dir')
+   Location of algorithms modules
+  
+  
+   modes_dir
+   Optional
+   ini_get('mcrypt.modes_dir')
+   Location of modes modules
+  
+  
+   iv
+   Required
+   N/A
+   Typically 8, 16, or 32 bytes of binary data.  Depends on 
cipher
+  
+  
+   key
+   Required
+   N/A
+   Typically 8, 16, or 32 bytes of binary data.  Depends on 
cipher
+  
+ 
+
+   
+  
+
+  
+   Encrypting file output using 3DES
+   
+
+   
+  
+
+  
+   Reading an encrypted file
+   
+
+   
+  
+
+ 
+
 
 
 

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-filter-append.xml

[Sara Golemon]

pollita Tue Feb 22 01:38:48 2005 EDT

  Modified files:  
/phpdoc/en/reference/stream/functions   stream-filter-append.xml 
  Log:
  Add addition SeeAlso per usernote
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-append.xml?r1=1.13&r2=1.14&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-append.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.13 
phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.14
--- phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.13  Tue Sep 
14 00:04:00 2004
+++ phpdoc/en/reference/stream/functions/stream-filter-append.xml   Tue Feb 
22 01:38:48 2005
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_append
@@ -103,7 +103,8 @@
 
  See also
  stream_filter_register, and
- stream_filter_prepend.
+ stream_filter_prepend, and
+ stream_get_filters.
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2 installation.xml

[Sara Golemon]

pollita Mon Feb 21 21:07:12 2005 EDT

  Modified files:  
/phpdoc/en/reference/ssh2   installation.xml 
  Log:
  make test didn't catch this...
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/installation.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/installation.xml
diff -u phpdoc/en/reference/ssh2/installation.xml:1.1 
phpdoc/en/reference/ssh2/installation.xml:1.2
--- phpdoc/en/reference/ssh2/installation.xml:1.1   Mon Feb 21 19:18:16 2005
+++ phpdoc/en/reference/ssh2/installation.xml   Mon Feb 21 21:07:11 2005
@@ -1,5 +1,5 @@
 
-
+
 
  &reftitle.install;
  
@@ -38,7 +38,7 @@

 Download and install libssh2.
 Typically this means executing the following command from
-the libssh2 source tree. ./configure && make all 
install.
+the libssh2 source tree. ./configure && make all 
install.

   
 
@@ -86,7 +86,7 @@
download and install PECL/ssh2, you may download the tarball from
PECL.
From the root of the unpacked tarball, run:
-   phpize && ./configure && make to generate
+   phpize && ./configure && make to generate
ssh2.so.
Once built, continue the installation from step 4 above.
   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2 installation.xml reference.xml

[Sara Golemon]

pollita Mon Feb 21 19:18:17 2005 EDT

  Added files: 
/phpdoc/en/reference/ssh2   installation.xml 

  Modified files:  
/phpdoc/en/reference/ssh2   reference.xml 
  Log:
  Provide installation instructions
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/reference.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/ssh2/reference.xml
diff -u phpdoc/en/reference/ssh2/reference.xml:1.3 
phpdoc/en/reference/ssh2/reference.xml:1.4
--- phpdoc/en/reference/ssh2/reference.xml:1.3  Mon Feb 14 19:47:35 2005
+++ phpdoc/en/reference/ssh2/reference.xml  Mon Feb 21 19:18:16 2005
@@ -1,5 +1,5 @@
 
-
+
 
  
   Secure Shell2 Functions
@@ -14,17 +14,8 @@
  on a remote machine using a secure cryptographic transport.
 

-   
-   &reftitle.install;
-
- &pecl.info;
- &url.pecl.package;ssh2.
-
-
- You will also need version 0.4 or greater of the libssh2 library
- (possibly higher, see release notes).
-
-   
+
+   &reference.ssh2.installation;
 
&reference.ssh2.constants;
 

http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/installation.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/installation.xml
+++ phpdoc/en/reference/ssh2/installation.xml



 &reftitle.install;
 
  Windows binaries may be found at
  &url.php.snapshots;.
  To install, download php_ssh2.dll to the folder specified
  by your php.ini file's extension_dir directive.
  Enable it by adding extension=php_ssh2.dll
  to your php.ini and restarting your webserver.
 

 

 

 
  Linux, BSD, and other *nix variants
  can be compiled using the following steps:
 

 
  
   
Download and install OpenSSL.
If you install OpenSSL via your distribution's packaging system
be sure to install the development libraries as well.
This will typically be a package named openssl-dev,
openssl_devel, or some variation thereof.
   
  

  
   
Download and install libssh2.
Typically this means executing the following command from
the libssh2 source tree. ./configure && make all install.
   
  

  
   
Run the pear installer for PECL/ssh2: pear install ssh2
   
  

  
   
Copy ssh2.so from the directory indicated by the
build process to the location specified in your php.ini file under
extension_dir.
   
  

  
   
Add extension=ssh2.so to your php.ini
   
  

  
   
Restart your webserver to reload your php.ini settings.
   
  

 

 
  Development Versions
  
   There are currently no stable versions of PECL/ssh2,
   to force installation of the beta version of PECL/ssh2
   execute: pear install ssh2-beta
  
 

 
  Compiling PECL/ssh2 without using the PEAR command
  
   Rather than using pear install ssh2 to automatically
   download and install PECL/ssh2, you may download the tarball from
   PECL.
   From the root of the unpacked tarball, run:
   phpize && ./configure && make to generate
   ssh2.so.
   Once built, continue the installation from step 4 above.
  
 

 
  &pecl.info;
  &url.pecl.package;ssh2.
 
 
  
   You will need version 0.4 or greater of the libssh2 library
   (possibly higher, see release notes).
  
 

[PHP-DOC] Re: cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-hostbased-file.xml

[Sara Golemon]

> Can you please use xml_proto.php to generate your documentation ? It
> would avoid us more work..
>
I can, but I'm curious What work?

-Sara 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2 reference.xml

[Sara Golemon]

pollita Mon Feb 14 19:47:35 2005 EDT

  Modified files:  
/phpdoc/en/reference/ssh2   reference.xml 
  Log:
  Constants would be nice
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/reference.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/ssh2/reference.xml
diff -u phpdoc/en/reference/ssh2/reference.xml:1.2 
phpdoc/en/reference/ssh2/reference.xml:1.3
--- phpdoc/en/reference/ssh2/reference.xml:1.2  Fri Dec 24 22:14:39 2004
+++ phpdoc/en/reference/ssh2/reference.xml  Mon Feb 14 19:47:35 2005
@@ -1,5 +1,5 @@
 
-
+
 
  
   Secure Shell2 Functions
@@ -25,6 +25,9 @@
  (possibly higher, see release notes).
 

+
+   &reference.ssh2.constants;
+
   
  &reference.ssh2.functions;
  

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-hostbased-file.xml

[Sara Golemon]

pollita Mon Feb 14 19:04:10 2005 EDT

  Added files: 
/phpdoc/en/reference/ssh2/functions ssh2-auth-hostbased-file.xml 
  Log:
  New function
  

http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml


  
   
ssh2_auth_hostbased_file

 Authenticate using a public hostkey

   
   
Description

 boolssh2_auth_hostbased_file
 
resourcesession
 
stringusername
 
stringhostname
 
stringpubkeyfile
 
stringprivkeyfile
 stringpassphrase
 stringlocal_username



 Authenticate using a public hostkey read from a file.  If 
privkeyfile
 is encrypted (which it should be), the passphrase must be provided.
 If local_username is omitted, then the value for
 username will be used for it.



 Authentication using a public hostkey
 

 



 
  ssh2_auth_hostbased_file requires libssh2 >= 0.7 and 
PHP/SSH2 >= 0.7
 


   
  

[PHP-DOC] Re: restructurung function reference

[Sara Golemon]

On the subject of reference restructuring, I'd like to toss out the idea of 
grouping the reference sections.  We're up to 137, and with the growth of 
PECL that's only going to get bigger.

-Sara 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-sftp-rename.xml ssh2-sftp-unlink.xml

[Sara Golemon]

pollita Thu Dec 30 14:42:21 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-sftp-rename.xml 
ssh2-sftp-unlink.xml 
  Log:
  Additional documentation for: ssh2_sftp_rename() and ssh2_sftp_unlink()
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.1 Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml Thu Dec 30 
14:42:20 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,9 +17,29 @@
  stringto
 
 
-
- Renames a file on the remote filesystem
-
+
+ Renames a file on the remote filesystem.
+
+
+
+ Renaming a file via sftp
+ 
+
+ 
+
+
+
+ See Also:
+ rename
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.1 Fri Dec 24 
20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml Thu Dec 30 
14:42:20 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,9 +16,29 @@
  
stringfilename
 
 
-
+
  Deletes a file on the remote filesystem
-
+
+
+
+ Deleting a file
+ 
+
+ 
+
+
+
+ See Also:
+ unlink
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-scp-recv.xml ssh2-scp-send.xml

[Sara Golemon]

pollita Thu Dec 30 14:49:58 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-scp-send.xml 
ssh2-scp-recv.xml 
  Log:
  Additional Documentation for:
  ssh2_scp_send()
  ssh2_scp_recv()
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.1Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xmlThu Dec 30 
14:49:57 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -18,9 +18,30 @@
  intcreate_mode
 
 
-
- Copy a file from the local filesystem to the remote server.
-
+
+ Copy a file from the local filesystem to the remote server using the SCP 
protocol.
+ The file will be created with the mode specified by 
create_mode.
+
+
+
+ Uploading a file via SCP
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_scp_recv, and
+ copy
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.1Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xmlThu Dec 30 
14:49:57 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,9 +17,29 @@
  
stringlocal_file
 
 
-
- Copies a file from the remote server to the local filesystem.
-
+
+ Copy a file from the remote server to the local filesystem using the SCP 
protocol.
+
+
+
+ Downloading a file via SCP
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_scp_send, and
+ copy
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-sftp-mkdir.xml ssh2-sftp-readlink.xml ssh2-sftp-realpath.xml ssh2-sftp-rmdir.xml ssh2-sftp-symlink.xml

[Sara Golemon]

pollita Thu Dec 30 14:27:07 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-sftp-mkdir.xml 
ssh2-sftp-rmdir.xml 
ssh2-sftp-readlink.xml 
ssh2-sftp-symlink.xml 
ssh2-sftp-realpath.xml 
  Log:
  Additional Documentation for:
  ssh2_sftp_mkdir()
  ssh2_sftp_rmdir()
  ssh2_sftp_readlink()
  ssh2_sftp_symlink()
  ssh2_sftp_realpath()
  
  http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.3 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.4
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.3  Wed Dec 29 
11:06:48 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml  Thu Dec 30 
14:27:07 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -18,9 +18,36 @@
  boolrecursive
 
 
-
- Creates a directory on the remote file server
-
+
+ Creates a directory on the remote file server with permissions set to
+ mode.  If recursive is 
&true;
+ any parent directories required for dirname will
+ be automatically created as well.  
+ This function is similar to using mkdir with the
+ ssh2.sftp:// wrapper.
+
+
+
+ Creating a directory on a remote server
+ 
+
+ 
+
+
+
+ See Also:
+ mkdir, and
+ ssh2_sftp_rmdir
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml:1.1  Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml  Thu Dec 30 
14:27:07 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -13,12 +13,37 @@
 
  boolssh2_sftp_rmdir
  
resourcesftp
- 
stringfilename
+ 
stringdirname
 
 
-
- Removes a directory from the remote server's filesystem
-
+
+ Removes a directory from the remote file server.
+ This function is similar to using rmdir with the
+ ssh2.sftp:// wrapper.
+
+
+
+ Creating a directory on a remote server
+ 
+
+ 
+
+
+
+ See Also:
+ rmdir, and
+ ssh2_sftp_mkdir
+
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml:1.1   Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml   Thu Dec 30 
14:27:07 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,9 +16,31 @@
  stringlink
 
 
-
+
  Returns the target of a symbolic link.
-
+
+
+
+ Reading a symbolic link
+ 
+
+ 
+
+
+
+ See Also:
+ readlink, and
+ ssh2_sftp_symlink
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml:1.1Fri Dec 
24 20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xmlThu Dec 30 
14:27:07 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,9 +17,31 @@
  stringlink
 
 
-
- Creates a symbolic link on the remote filesystem
-
+
+ Creates a symbolic link named link on the remote 
filesystem
+ pointing to target.
+
+
+
+ Creating a symbolic link
+ 
+
+ 
+
+
+
+ See Also:
+ symlink, and
+ ssh2_sftp_readlink
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml:1.1   Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml   Thu Dec 30 
14:27:07 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,10 +16,33 @@
  
stringfilename
 
 
-
+
  Translates filename into the effective real path
  on the remote filesystem.
-
+
+
+
+ Resolvin

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-sftp-lstat.xml ssh2-sftp-stat.xml ssh2-sftp.xml

[Sara Golemon]

pollita Thu Dec 30 00:35:30 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-sftp.xml 
ssh2-sftp-stat.xml 
ssh2-sftp-lstat.xml 
  Log:
  Additional Documentation:
  ssh2_sftp(), ssh2_sftp_stat(), ssh2_sftp_lstat()
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml:1.1Fri Dec 24 
20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp.xmlThu Dec 30 00:35:30 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -15,9 +15,37 @@
  
resourcesession
 
 
-
- Request the SFTP subsystem from an already connected SSH2 server
-
+
+ Request the SFTP subsystem from an already connected SSH2 server.
+
+
+
+ This method returns an SSH2 SFTP resource for use with
+ all other ssh2_sftp_*() methods and the
+ ssh2.sftp:// fopen wrapper.
+
+
+
+ Opening a file via SFTP
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_scp_send, and
+ ssh2_scp_recv
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml:1.1   Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml   Thu Dec 30 
00:35:30 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,10 +16,42 @@
  stringpath
 
 
-
- Stats a remote file.  If the file is a symbolic link, it follows the link
- and stats its target.
-
+
+ Stats a file on the remote filesystem following any symbolic links.
+ This function is similar to using the stat function
+ with the ssh2.sftp:// wrapper in PHP5
+ and returns the same values.  See the documentation for
+ stat for details on the values which may be returned.
+
+
+
+ Stating a file via SFTP
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_sftp_lstat,
+ lstat, and
+ stat
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml:1.1  Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml  Thu Dec 30 
00:35:30 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,10 +16,43 @@
  stringpath
 
 
-
+
  Stats a symbolic link on the remote filesystem 
without
- following the link.
-
+ following the link.  This function is similar to using the
+ lstat function with the
+ ssh2.sftp:// wrapper in PHP5
+ and returns the same values.  See the documentation for
+ stat for details on the values which may be returned.
+
+
+
+ Stating a symbolic link via SFTP
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_sftp_stat,
+ lstat, and
+ stat
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-methods-negotiated.xml ssh2-shell.xml ssh2-tunnel.xml

[Sara Golemon]

pollita Thu Dec 30 00:09:31 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-methods-negotiated.xml 
ssh2-shell.xml ssh2-tunnel.xml 
  Log:
  Additional Documentation:
  ssh2_shell(), ssh2_methods_negotiated(), and ssh2_tunnel()
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml:1.1  Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml  Thu Dec 
30 00:09:31 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -15,9 +15,41 @@
  
resourcesession
 
 
-
- Return list of negotiaed methods
-
+
+ Returns list of negotiaed methods.
+
+
+
+ Determining what methods were negotiated
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_connect
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-shell.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-shell.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-shell.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-shell.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-shell.xml:1.1   Fri Dec 24 
20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-shell.xml   Thu Dec 30 00:09:31 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -20,9 +20,42 @@
  intwidth_height_type
 
 
-
- Open a shell at the remote end and allocate a stream for it
-
+
+ Open a shell at the remote end and allocate a stream for it.
+ term_type should correspond to one of the entries
+ in the target system's /etc/termcap file and defaults 
to vanilla.
+ env may be passed as an associative array of 
name/value pairs
+ to set in the target environment.
+
+
+
+ width, and height
+ define the width and height of the virtual terminal allocated for the 
shell process.
+ width_height_type should be one of
+ SSH2_TERM_UNIT_CHARS or
+ SSH2_TERM_UNIT_PIXELS.
+
+
+
+ Executing a command
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_exec,
+ ssh2_tunnel, and
+ ssh2_fetch_stream
+
 

   
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml:1.1  Fri Dec 24 
20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml  Thu Dec 30 00:09:31 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,10 +17,31 @@
  intport
 
 
-
+
  Open a socket stream to an arbitrary host/port by way of the
  currently connected SSH server.
-
+
+
+
+ Opening a tunnel to an arbitrary host
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_connect, and
+ fsockopen
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-exec.xml ssh2-fetch-stream.xml

[Sara Golemon]

pollita Wed Dec 29 23:24:05 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-exec.xml 
ssh2-fetch-stream.xml 
  Log:
  Document ssh2_exec() and ssh2_fetch_stream()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-exec.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-exec.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.2 
phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.3
--- phpdoc/en/reference/ssh2/functions/ssh2-exec.xml:1.2Wed Dec 29 
11:06:16 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-exec.xmlWed Dec 29 23:24:05 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,11 +17,31 @@
  arrayenv
 
 
-
+
  Execute a command at the remote end and allocate a channel for it.
  Returns a stream on success or &false; on failure.
-
+
 
+
+ Executing a command
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_connect,
+ ssh2_shell, and
+ ssh2_tunnel
+

   
 
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml:1.1Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xmlWed Dec 29 
23:24:05 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,9 +16,34 @@
  intstreamid
 
 
-
- Fetch an alternate substream associated with an SSH2 channel stream.
-
+
+ Fetches an alternate substream associated with an SSH2 channel stream
+ identified by streamid.  The SSH2 protocol
+ currently defines only one substream, STDERR, which has a substream ID
+ of SSH2_STREAM_STDERR (defined as 1).
+
+
+
+ Opening a shell and retreiving the stderr stream associated with 
it.
+ 
+
+ 
+
+
+
+ See Also:
+ ssh2_shell,
+ ssh2_exec, and
+ ssh2_connect
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-connect.xml

[Sara Golemon]

pollita Tue Dec 28 10:11:19 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-connect.xml 
  Log:
  Wrong group
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-connect.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-connect.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.2 
phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.3
--- phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.2 Mon Dec 27 
18:18:43 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-connect.xml Tue Dec 28 10:11:19 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -48,7 +48,7 @@
  
  
   diffie-hellman-group1-sha1,
-  diffie-hellman-group4-sha1, and
+  diffie-hellman-group14-sha1, and
   diffie-hellman-group-exchange-sha1
  
 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-pubkey-file.xml

[Sara Golemon]

pollita Mon Dec 27 22:25:39 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-auth-pubkey-file.xml 
  Log:
  Add example for ssh2_auth_pubkey_file()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml:1.1Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xmlMon Dec 
27 22:25:39 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -15,13 +15,33 @@
  
resourcesession
  
stringusername
  
stringpubkeyfile
- stringprivkeyfile
+ 
stringprivkeyfile
  stringpassphrase
 
 
-
- Authenticate using a public key read from a file.
-
+
+ Authenticate using a public key read from a file.  If 
privkeyfile
+ is encrypted (which it should be), the passphrase must be provided.
+
+
+
+ Authentication using a public key
+ 
+
+ 
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-password.xml

[Sara Golemon]

pollita Mon Dec 27 22:17:27 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-auth-password.xml 
  Log:
  Simple example for ssh2_auth_password()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml:1.1   Fri Dec 
24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml   Mon Dec 27 
22:17:27 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -17,9 +17,26 @@
  
stringpassword
 
 
-
+
  Authenticate over SSH using a plain password
-
+
+
+
+ Authenticating with a password
+ 
+
+ 
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-none.xml

[Sara Golemon]

pollita Mon Dec 27 18:47:00 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-auth-none.xml 
  Log:
  Detail and example for ssh2_auth_none()
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml:1.1   Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml   Mon Dec 27 
18:47:00 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -16,10 +16,31 @@
  
stringusername
 
 
-
- Attempt "none" authentication, returns a list of allowed methods on 
failed authentication, 
- false on utter failure, or true on success
-
+
+ Attempt "none" authentication which usually will (and should) fail.
+ As part of this failure, servers will return a list of accepted
+ authentication methods.  If the server does accept "none" as an
+ authentication method for username, this function
+ will simply return &true;
+
+
+
+ Using ssh2_auth_none to retreive
+a list of authentication methods.
+ 
+
+ 
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-fingerprint.xml

[Sara Golemon]

pollita Mon Dec 27 18:38:15 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-fingerprint.xml 
  Log:
  Flesh out ssh2_fingerprint() docs.
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml:1.1 Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml Mon Dec 27 
18:38:14 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -12,14 +12,45 @@
 Description
 
  stringssh2_fingerprint
- resourcesession
+ 
resourcesession
  intflags
 
 
-
+
  Returns a server hostkey hash from an active session
  Defaults to MD5 fingerprint encoded as ASCII hex values
-
+
+
+
+ flags may be either of
+ SSH2_FINGERPRINT_MD5 or
+ SSH2_FINGERPRINT_SHA1 logically ORed with
+ SSH2_FINGERPRINT_HEX or
+ SSH2_FINGERPRINT_RAW.
+ Defaults to SSH2_FINGERPRINT_MD5 |
+ SSH2_FINGERPRINT_HEX.
+
+
+
+ Checking the fingerprint against a known value
+ 
+
+ 
+
 

   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-connect.xml

[Sara Golemon]

pollita Mon Dec 27 18:18:44 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-connect.xml 
  Log:
  Flesh out ssh2_connect()
  http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-connect.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-connect.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-connect.xml:1.1 Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-connect.xml Mon Dec 27 18:18:43 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -18,10 +18,252 @@
  arraycallbacks
 
 
-
+
  Establish a connection to a remote SSH server and return a resource on 
success, false on error
+
+
+
+ methods may be an associative array with up to 
four parameters
+ as described below.
+
+
+
+ 
+  methods may be an associative array
+ with any or all of the following parameters.
+  
+   
+
+ Index
+ Meaning
+ Supported Values*
+
+   
+   
+
+ kex
+ 
+  List of key exchange methods to advertise, coma separated
+  in order of preference.
+ 
+ 
+  diffie-hellman-group1-sha1,
+  diffie-hellman-group4-sha1, and
+  diffie-hellman-group-exchange-sha1
+ 
+
+
+ hostkey
+ 
+  List of hostkey methods to advertise, come separated
+  in order of preference.
+ 
+ 
+  ssh-rsa and
+  ssh-dss
+ 
+
+
+ client_to_server
+ 
+  Associative array containing crypt, compression, and
+  message authentication code (MAC) method preferences
+  for messages sent from client to server.
+ 
+ 
+
+
+ server_to_client
+ 
+  Associative array containing crypt, compression, and
+  message authentication code (MAC) method preferences
+  for messages sent from client to server.
+ 
+ 
+
+   
+  
+ 
+
+
+
+ * - Supported Values are dependent on methods supported by underlying 
library.
+ See libssh2 documentation for 
additional
+ information.
+
+
+
+ 
+  
+   client_to_server and
+   server_to_client may be an associative array
+   with any or all of the following parameters.
+  
+  
+   
+
+ Index
+ Meaning
+ Supported Values*
+
+   
+   
+
+ crypt
+ List of crypto methods to advertise, coma separated
+  in order of preference.
+ 
+  [EMAIL PROTECTED],
+  aes256-cbc,
+  aes192-cbc,
+  aes128-cbc,
+  3des-cbc,
+  blowfish-cbc,
+  cast128-cbc,
+  arcfour, and
+  none**
+ 
+
+
+ comp
+ List of compression methods to advertise, coma separated
+  in order of preference.
+ 
+  zlib and
+  none
+ 
+
+
+ mac
+ List of MAC methods to advertise, come separated
+  in order of preference.
+ 
+  hmac-sha1,
+  hmac-sha1-96,
+  hmac-ripemd160,
+  [EMAIL PROTECTED], and
+  none**
+ 
+
+   
+  
+ 
+
+
+
+ Crypt and MAC method "none" 
+ 
+  For security reasons, none is disabled by the 
underlying
+  libssh2 library unless explicitly 
enabled
+  during build time by using the appropriate ./configure options.  See 
documentation
+  for the underlying library for more information.
+ 
+
+
+
+ 
+  callbackss may be an associative array
+ with any or all of the following parameters.
+  
+   
+
+ Index
+ Meaning
+ Prototype
+
+   
+   
+
+ ignore
+ 
+  Name of function to call when an 
+  SSH2_MSG_IGNORE
+  packet is received
+ 
+ void ignore_cb($message)
+
+
+ debug
+ 
+  Name of function to call when an 
+  SSH2_MSG_DEBUG
+  packet is received
+ 
+ void debug_cb($message, $language, $always_display)
+
+
+ macerror
+ 
+  Name of function to call when a
+  packet is received but the message authentication
+  code failed.  If the callback returns &true;,
+  the mismatch will be ignored, otherwise the
+  connection will be terminated.
+ 
+ bool macerror_cb($packet)
+
+
+ disconnect
+ 
+  Name of function to call when an 
+  SSH2_M

[PHP-DOC] cvs: phpdoc / manual.xml.in /en/reference/ssh2 reference.xml

[Sara Golemon]

pollita Fri Dec 24 22:14:39 2004 EDT

  Modified files:  
/phpdoc manual.xml.in 
/phpdoc/en/reference/ssh2   reference.xml 
  Log:
  Put the SSH2 chapter into manual.xml.in and fix title
  
http://cvs.php.net/diff.php/phpdoc/manual.xml.in?r1=1.199&r2=1.200&ty=u
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.199 phpdoc/manual.xml.in:1.200
--- phpdoc/manual.xml.in:1.199  Tue Dec 21 12:23:23 2004
+++ phpdoc/manual.xml.inFri Dec 24 22:14:39 2004
@@ -2,7 +2,7 @@
 
+
 
 
 
@@ -224,6 +224,7 @@
   &reference.qtdom.reference;
   &reference.rar.reference;
   &reference.regex.reference;
+  &reference.ssh2.reference;
   &reference.sem.reference;
   &reference.sesam.reference;
   &reference.session.reference;
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/reference.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/reference.xml
diff -u phpdoc/en/reference/ssh2/reference.xml:1.1 
phpdoc/en/reference/ssh2/reference.xml:1.2
--- phpdoc/en/reference/ssh2/reference.xml:1.1  Fri Dec 24 20:03:17 2004
+++ phpdoc/en/reference/ssh2/reference.xml  Fri Dec 24 22:14:39 2004
@@ -1,8 +1,8 @@
 
-
+
 
  
-  ssh2 Functions
+  Secure Shell2 Functions
   ssh2
 
   

[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-sftp-mkdir.xml

[Sara Golemon]

pollita Fri Dec 24 22:16:14 2004 EDT

  Modified files:  
/phpdoc/en/reference/ssh2/functions ssh2-sftp-mkdir.xml 
  Log:
  typo
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.1 
phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml:1.1  Fri Dec 24 
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml  Fri Dec 24 
22:16:14 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -13,7 +13,7 @@
 
  boolssh2_sftp_mkdir
  
resourcesftp
- 
stringdirname
+ 
stringdirname
  intmode
  intrecursive
 

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Fri Dec 24 20:33:50 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  Document ssh2 fopen wrappers
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.46&r2=1.47&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.46 
phpdoc/en/appendices/wrappers.xml:1.47
--- phpdoc/en/appendices/wrappers.xml:1.46  Mon Nov 22 10:50:06 2004
+++ phpdoc/en/appendices/wrappers.xml   Fri Dec 24 20:33:49 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -760,6 +760,237 @@

   
  
+ 
+  Secure Shell 2
+  
+   ssh2.shell://
+   ssh2.exec://
+   ssh2.tunnel://
+   ssh2.sftp://
+   ssh2.scp://
+   PHP 4.3.0 and up (PECL)
+  
+
+  
+   ss2.shell://user:[EMAIL 
PROTECTED]:22/xterm
+   ss2.exec://user:[EMAIL 
PROTECTED]:22/usr/local/bin/somecmd
+   ss2.tunnel://user:[EMAIL 
PROTECTED]:22/192.168.0.1:14
+   ss2.sftp://user:[EMAIL 
PROTECTED]:22/path/to/filename
+  
+
+  
+   This wrapper is not enabled by default
+   
+In order to use the ssh2.*:// wrappers you must 
install
+the SSH2 extension
+available from PECL.
+   
+  
+
+  
+   In addition to accepting traditional URI login details, the ssh2 wrappers
+   will also reuse open connections by passing the connection resource in the
+   host portion of the URL.
+  
+
+  
+   Opening a stream from an active connection
+   
+
+   
+  
+  
+   
+Wrapper Summary
+
+ 
+  
+   Attribute
+   ssh2.shell
+   ssh2.exec
+   ssh2.tunnel
+   ssh2.sftp
+   ssh2.scp
+  
+ 
+ 
+  
+   Restricted by allow_url_fopen.
+   Yes
+   Yes
+   Yes
+   Yes
+   Yes
+  
+  
+   Allows Reading
+   Yes
+   Yes
+   Yes
+   Yes
+   Yes
+  
+  
+   Allows Writing
+   Yes
+   Yes
+   Yes
+   Yes
+   No
+  
+  
+   Allows Appending
+   No
+   No
+   No
+   Yes (When supported by server)
+   No
+  
+  
+   Allows Simultaneous Reading and Writing
+   Yes
+   Yes
+   Yes
+   Yes
+   No
+  
+  
+   Supports stat
+   No
+   No
+   No
+   Yes
+   No
+  
+  
+   Supports unlink
+   No
+   No
+   No
+   Yes
+   No
+  
+  
+   Supports rename
+   No
+   No
+   No
+   Yes
+   No
+  
+  
+   Supports mkdir
+   No
+   No
+   No
+   Yes
+   No
+  
+  
+   Supports rmdir
+   No
+   No
+   No
+   Yes
+   No
+  
+ 
+
+   
+  
+
+  
+   
+Context options
+
+ 
+  
+   Name
+   Usage
+   Default
+  
+ 
+ 
+  
+   session
+   Preconnected ssh2 resource to be reused
+   
+  
+  
+   sftp
+   Preallocated sftp resource to be reused
+   
+  
+  
+   methods
+   Key exchange, hostkey, cipher, compression, and MAC methods to 
use
+   
+  
+  
+   callbacks
+   
+   
+  
+  
+   username
+   Username to connect as
+   
+  
+  
+   password
+   Password to use with password authentication
+   
+  
+  
+   pubkey_file
+   Name of public key file to use for authentication
+   
+  
+  
+   privkey_file
+   Name of private key file to use for authentication
+   
+  
+  
+   env
+   Associate array of environment variables to set
+   
+  
+  
+   term
+   Terminal emulation type to request when allocating a pty
+   
+  
+  
+   term_width
+   Width of terminal requested when allocating a pty
+   
+  
+  
+   term_height
+   Height of terminal requested when allocating a pty
+   
+  
+  
+   term_units
+   Units to use with term_width and term_height
+   SSH2_TERM_UNIT_CHARS
+  
+ 
+
+   
+  
+
+
+ 
+
  
   Audio Streams
   ogg:// PHP 4.3.0 and up (PECL) 

[PHP-DOC] cvs: phpdoc /en/reference/ssh2 constants.xml reference.xml /en/reference/ssh2/functions ssh2-auth-none.xml ssh2-auth-password.xml ssh2-auth-pubkey-file.xml ssh2-connect.xml ssh2-exec.xml ssh2-fetch-stream.xml ssh2-fingerprint.xml ssh2-methods-negotiated.xml ssh2-scp-recv.xml ssh2-scp-send.xml ssh2-sftp-lstat.xml ssh2-sftp-mkdir.xml ssh2-sftp-readlink.xml ssh2-sftp-realpath.xml ssh2-sftp-rename.xml ssh2-sftp-rmdir.xml ssh2-sftp-stat.xml ssh2-sftp-symlink.xml ssh2-sftp-unlink.xml ssh2-sftp.xml ssh2-shell.xml ssh2-tunnel.xml /entities global.ent

[Sara Golemon]

pollita Fri Dec 24 20:03:18 2004 EDT

  Added files: 
/phpdoc/en/reference/ssh2   reference.xml constants.xml 
/phpdoc/en/reference/ssh2/functions ssh2-auth-none.xml 
ssh2-auth-password.xml 
ssh2-auth-pubkey-file.xml 
ssh2-connect.xml ssh2-exec.xml 
ssh2-fetch-stream.xml 
ssh2-fingerprint.xml 
ssh2-methods-negotiated.xml 
ssh2-scp-recv.xml 
ssh2-scp-send.xml 
ssh2-sftp-lstat.xml 
ssh2-sftp-mkdir.xml 
ssh2-sftp-readlink.xml 
ssh2-sftp-realpath.xml 
ssh2-sftp-rename.xml 
ssh2-sftp-rmdir.xml 
ssh2-sftp-stat.xml 
ssh2-sftp-symlink.xml 
ssh2-sftp-unlink.xml 
ssh2-sftp.xml ssh2-shell.xml 
ssh2-tunnel.xml 

  Modified files:  
/phpdoc/entitiesglobal.ent 
  Log:
  Initial documentation of ssh2 extension
  http://cvs.php.net/diff.php/phpdoc/entities/global.ent?r1=1.210&r2=1.211&ty=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.210 phpdoc/entities/global.ent:1.211
--- phpdoc/entities/global.ent:1.210Wed Dec 22 11:55:55 2004
+++ phpdoc/entities/global.ent  Fri Dec 24 20:03:17 2004
@@ -1,6 +1,6 @@
 

 
  ssh2 Functions
  ssh2

  
   
   &reftitle.intro;

 Bindings to the libssh2 library which
 provide access to resources (shell, remote exec, tunneling, file transfer)
 on a remote machine using a secure cryptographic transport.

   
   
   &reftitle.install;

 &pecl.info;
 &url.pecl.package;ssh2.


 You will also need version 0.4 or greater of the libssh2 library
 (possibly higher, see release notes).

   
  
 &reference.ssh2.functions;
 


http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/constants.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/constants.xml
+++ phpdoc/en/reference/ssh2/constants.xml




 &reftitle.constants;
 &extension.constants;
 
  
   
SSH2_FINGERPRINT_MD5
 (integer)
   
   

 Flag to ssh2_fingerprint requesting hostkey
 fingerprint as an MD5 hash.

   
  
  
   
SSH2_FINGERPRINT_SHA1
 (integer)
   
   

 Flag to ssh2_fingerprint requesting hostkey
 fingerprint as an SHA1 hash.

   
  
  
   
SSH2_FINGERPRINT_HEX
 (integer)
   
   

 Flag to ssh2_fingerprint requesting hostkey
 fingerprint as a string of hexits.

   
  
  
   
SSH2_FINGERPRINT_RAW
 (integer)
   
   

 Flag to ssh2_fingerprint requesting hostkey
 fingerprint as a raw string of 8-bit characters.

   
  
  
   
SSH2_TERM_UNIT_CHARS
 (integer)
   
   

 Flag to ssh2_shell specifying that
 width and height
 are provided as character sizes.

   
  
  
   
SSH2_TERM_UNIT_PIXELS
 (integer)
   
   

 Flag to ssh2_shell specifying that
 width and height
 are provided in pixel units.

   
  
  
   
SSH2_DEFAULT_TERM_WIDTH
 (integer)
   
   

 Default terminal width requested by ssh2_shell.

   
  
  
   
SSH2_DEFAULT_TERM_HEIGHT
 (integer)
   
   

 Default terminal height requested by ssh2_shell.

   
  
  
   
SSH2_DEFAULT_TERM_UNIT
 (integer)
   
   

 Default terminal units requested by ssh2_shell.

   
  
  
   
SSH2_STREAM_STDIO
 (integer)
   
   

 Flag to ssh2_fetch_stream requesting STDIO subchannel.

   
  
  
   
SSH2_STREAM_STDERR
 (integer)
   
   

 Flag to ssh2_fetch_stream requesting STDERR 
subchannel.

   
  
  
   
SSH2_DEFAULT_TERMINAL
 (string)
   
   

 Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested
 by ssh2_shell.

   
  
 




http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml



  
   
ssh2_auth_none

 Authenticate as "none"

   
   
Description

 arrayssh2_auth_none
 
resourcesession
 
stringusername



 Attempt "none" authentication, returns a list of allowed methods on failed 
authentication, 
 false on utter failure, or true on success


   
  



http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml?r=1.1

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-filter-append.xml stream-filter-prepend.xml stream-filter-remove.xml

[Sara Golemon]

pollita Tue Sep 14 00:04:01 2004 EDT

  Added files: 
/phpdoc/en/reference/stream/functions   stream-filter-remove.xml 

  Modified files:  
/phpdoc/en/reference/stream/functions   stream-filter-append.xml 
stream-filter-prepend.xml 
  Log:
  Document stream_filter_remove()
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-append.xml?r1=1.12&r2=1.13&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-append.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.12 
phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.13
--- phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.12  Tue Jul 27 
00:48:55 2004
+++ phpdoc/en/reference/stream/functions/stream-filter-append.xml   Tue Sep 14 
00:04:00 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_append
@@ -8,7 +8,7 @@

 Description
  
-  boolstream_filter_append
+  resourcestream_filter_append
   resourcestream
   stringfiltername
   intread_write
@@ -35,6 +35,13 @@
  STREAM_FILTER_WRITE, and/or
  STREAM_FILTER_ALL can also be passed to the
  read_write parameter to override this behavior.
+
+
+ As of PHP 5.1.0, this function returns a resource which
+ can be used to refer to this filter instance during a call
+ to stream_filter_remove.
+ Prior to PHP 5.1.0, this function returns &true; on success
+ or &false; on failure.
 
 
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-prepend.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-prepend.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.10 
phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.11
--- phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.10 Tue Jul 27 
00:48:55 2004
+++ phpdoc/en/reference/stream/functions/stream-filter-prepend.xml  Tue Sep 14 
00:04:00 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_prepend
@@ -8,7 +8,7 @@

 Description
  
-  boolstream_filter_prepend
+  resourcestream_filter_prepend
   resourcestream
   stringfiltername
   intread_write
@@ -37,6 +37,13 @@
  read_write parameter to override this behavior.
  See stream_filter_append for an example of
  using this parameter.
+
+
+ As of PHP 5.1.0, this function returns a resource which
+ can be used to refer to this filter instance during a call
+ to stream_filter_remove.
+ Prior to PHP 5.1.0, this function returns &true; on success
+ or &false; on failure.
 
 
  When using custom (user) filters

http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-filter-remove.xml?r=1.1&p=1
Index: phpdoc/en/reference/stream/functions/stream-filter-remove.xml
+++ phpdoc/en/reference/stream/functions/stream-filter-remove.xml


  
   
stream_filter_remove
Remove a filter from a stream 
   
   
Description
 
  boolstream_filter_append
  
resourcestream_filter
 

 Removes a stream filter previously added to a stream
 with stream_filter_prepend or
 stream_filter_append.  Any data
 remaining in the filter's internal buffer will be flushed
 through to the next filter before removing it.


 
  Dynamicly refiltering a stream
  

  
 


 See also
 stream_filter_register,
 stream_filter_append, and
 stream_filter_prepend.

   
  

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-wrapper-restore.xml stream-wrapper-unregister.xml

[Sara Golemon]

pollita Fri Sep 10 17:14:23 2004 EDT

  Added files: 
/phpdoc/en/reference/stream/functions   stream-wrapper-restore.xml 
stream-wrapper-unregister.xml 
  Log:
  New Functions
  

http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-wrapper-restore.xml?r=1.1&p=1
Index: phpdoc/en/reference/stream/functions/stream-wrapper-restore.xml
+++ phpdoc/en/reference/stream/functions/stream-wrapper-restore.xml


  
   
stream_wrapper_restore
Restores a previously unregistered built-in wrapper
   
   
Description

 boolstream_wrapper_restore
 stringprotocol


 Restores a built-in wrapper previously unregistered with
 stream_wrapper_unregister.

   
  




http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-wrapper-unregister.xml?r=1.1&p=1
Index: phpdoc/en/reference/stream/functions/stream-wrapper-unregister.xml
+++ phpdoc/en/reference/stream/functions/stream-wrapper-unregister.xml


  
   
stream_wrapper_unregister
Unregister a URL wrapper
   
   
Description

 boolstream_wrapper_unregister
 stringprotocol


 stream_wrapper_unregister allows you to
 disable an already defined stream wrapper.  Once the wrapper
 has been disabled you may override it with a user-defined wrapper
 using stream_wrapper_register or
 reenable it later on with stream_wrapper_restore.

   
  

[PHP-DOC] cvs: phpdoc /en/appendices transports.xml

[Sara Golemon]

pollita Fri Sep 10 14:53:01 2004 EDT

  Modified files:  
/phpdoc/en/appendices   transports.xml 
  Log:
  Typo
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/transports.xml?r1=1.11&r2=1.12&ty=u
Index: phpdoc/en/appendices/transports.xml
diff -u phpdoc/en/appendices/transports.xml:1.11 
phpdoc/en/appendices/transports.xml:1.12
--- phpdoc/en/appendices/transports.xml:1.11Fri Sep 10 11:43:57 2004
+++ phpdoc/en/appendices/transports.xml Fri Sep 10 14:53:00 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Socket Transports
  
@@ -39,8 +39,8 @@
tcp://www.example.com
udp://www.example.com
ssl://www.example.com
-   ssl2://www.example.com
-   ssl3://www.example.com
+   sslv2://www.example.com
+   sslv3://www.example.com
tls://www.example.com
   
 
@@ -84,8 +84,8 @@
   
ssl:// will attempt to negotiate an SSL V2,
or SSL V3 connection depending on the capabilities and preferences
-   of the remote host.  ssl2:// and 
-   ssl3:// will select the SSL V2 or SSL V3
+   of the remote host.  sslv2:// and 
+   sslv3:// will select the SSL V2 or SSL V3
protocol explicitly.
   
 

[PHP-DOC] cvs: phpdoc /en/appendices transports.xml

[Sara Golemon]

pollita Fri Sep 10 11:43:58 2004 EDT

  Modified files:  
/phpdoc/en/appendices   transports.xml 
  Log:
  Document ssl2:// and ssl3:// transports
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/transports.xml?r1=1.10&r2=1.11&ty=u
Index: phpdoc/en/appendices/transports.xml
diff -u phpdoc/en/appendices/transports.xml:1.10 
phpdoc/en/appendices/transports.xml:1.11
--- phpdoc/en/appendices/transports.xml:1.10Tue Aug 10 12:30:13 2004
+++ phpdoc/en/appendices/transports.xml Fri Sep 10 11:43:57 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Socket Transports
  
@@ -18,7 +18,11 @@
 
  
   Internet Domain: TCP, UDP, SSL, and TLS
-  PHP 3, PHP 4, PHP 5. ssl:// & 
tls:// since PHP 4.3
+  
+   PHP 3, PHP 4, PHP 5.
+   ssl:// & tls:// since PHP 4.3.0
+   sslv2:// & sslv3:// since PHP 5.0.2
+  
 
   

@@ -35,6 +39,8 @@
tcp://www.example.com
udp://www.example.com
ssl://www.example.com
+   ssl2://www.example.com
+   ssl3://www.example.com
tls://www.example.com
   
 
@@ -69,10 +75,18 @@
   
The ssl:// and tls:// transports 
(available only when openssl support is compiled into PHP) are extensions 
-   of the tcp:// transport which includes SSL encryption.
+   of the tcp:// transport which include SSL encryption.
Since PHP 4.3.0 OpenSSL support must be statically 
compiled into PHP, since PHP 5.0.0
it may be compiled as a module or statically.
+  
+
+  
+   ssl:// will attempt to negotiate an SSL V2,
+   or SSL V3 connection depending on the capabilities and preferences
+   of the remote host.  ssl2:// and 
+   ssl3:// will select the SSL V2 or SSL V3
+   protocol explicitly.
   
 
   

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Tue Sep  7 15:33:45 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  Document http/protocol_version context option and handling of chunked transfer 
encoding
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.42&r2=1.43&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.42 phpdoc/en/appendices/wrappers.xml:1.43
--- phpdoc/en/appendices/wrappers.xml:1.42  Thu Sep  2 13:31:41 2004
+++ phpdoc/en/appendices/wrappers.xml   Tue Sep  7 15:33:45 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -155,6 +155,15 @@
Since PHP 4.3.0, the headers are available using
stream_get_meta_data.
   
+  
+   Transfer-Encoding: chunked
+   
+As of PHP 5.1.0, if the remote server sends 
+Transfer-Encoding: chunked in the response
+headers, PHP will automatically apply a chunked decode filter
+to the content returned.
+   
+  
   
HTTP connections are read-only; you cannot write data or copy
files to an HTTP resource.
@@ -238,6 +247,13 @@
 any other HTTP method supported by the remote server.

GET
+  
+  
+   protocol_version PHP >= 5.1.0
+   HTTP protocol version (typically 1.0
+or 1.1 to send with the request line.
+   
+   1.0
   
   
header

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Thu Sep  2 13:31:42 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  Document ogg/vorbis
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.41&r2=1.42&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.41 phpdoc/en/appendices/wrappers.xml:1.42
--- phpdoc/en/appendices/wrappers.xml:1.41  Tue Aug 10 12:30:13 2004
+++ phpdoc/en/appendices/wrappers.xml   Thu Sep  2 13:31:41 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -760,6 +760,160 @@

   
  
+ 
+  Audio Streams
+  ogg:// PHP 4.3.0 and up (PECL) 
+
+  
+   ogg://soundfile.ogg
+   
ogg:///path/to/soundfile.ogg
+   
ogg://http://www.example.com/path/to/soundstream.ogg
+  
+
+  
+   This wrapper is not enabled by default
+   
+In order to use the ogg:// wrapper you must install
+the OGG/Vorbis extension
+available from PECL.
+   
+  
+
+  
+   Files opened for reading via the ogg:// wrapper
+   are treated as compressed audio encoded using the OGG/Vorbis codec.
+   Similarly, files opened for writing or appending via the 
+   ogg:// wrapper are writen as compressed audio data.
+   stream_get_meta_data, when used on an OGG/Vorbis
+   file opened for reading will return various details about the stream
+   including the vendor tag, any included
+   comments, the number of 
+   channels, the sampling rate, 
+   and the encoding rate range described by: 
+   bitrate_lower, bitrate_upper,
+   bitrate_nominal, and bitrate_window.
+  
+
+  
+   
+Wrapper Summary
+
+ 
+  
+   Attribute
+   Supported
+  
+ 
+ 
+  
+   Restricted by allow_url_fopen.
+   No
+  
+  
+   Allows Reading
+   Yes
+  
+  
+   Allows Writing
+   Yes
+  
+  
+   Allows Appending
+   Yes
+  
+  
+   Allows Simultaneous Reading and Writing
+   No
+  
+  
+   Supports stat
+   No
+  
+  
+   Supports unlink
+   No
+  
+  
+   Supports rename
+   No
+  
+  
+   Supports mkdir
+   No
+  
+  
+   Supports rmdir
+   No
+  
+ 
+
+   
+  
+  
+   
+Context options
+
+ 
+  
+   Name
+   Usage
+   Default
+   Mode
+  
+ 
+ 
+  
+   pcm_mode
+   
+PCM encoding to apply while reading, one of:
+OGGVORBIS_PCM_U8, OGGVORBIS_PCM_S8,
+OGGVORBIS_PCM_U16_BE, 
OGGVORBIS_PCM_S16_BE,
+OGGVORBIS_PCM_U16_LE, and 
OGGVORBIS_PCM_S16_LE.
+(8 vs 16 bit, signed or unsigned, big or little endian)
+   
+   OGGVORBIS_PCM_S16_LE
+   Read
+  
+  
+   rate
+   
+Sampling rate of input data, expressed in Hz
+   
+   44100
+   Write/Append
+  
+  
+   bitrate
+   
+When given as an integer, the fixed bitrate at which to encode. (16000 to 
131072)
+When given as a float, the variable bitrate quality to use. (-1.0 to 1.0)
+   
+   128000
+   Write/Append
+  
+  
+   channels
+   
+The number of audio channels to encode, typically 1 (Mono), or 2 (Stero).
+May range as high as 16.
+   
+   2
+   Write/Append
+  
+  
+   comments
+   
+An array of string values to encode into the track header.
+   
+   
+   Write/Append
+  
+ 
+
+   
+  
+ 
+
 
 
 

[PHP-DOC] cvs: phpdoc /en/reference/openal functions.xml

[Sara Golemon]

pollita Tue Aug 31 21:55:02 2004 EDT

  Removed files:   
/phpdoc/en/reference/openal functions.xml 
  Log:
  This doesn't belong here...
  

[PHP-DOC] cvs: phpdoc /en/reference/parsekit .cvsignore

[Sara Golemon]

pollita Thu Aug 26 15:52:47 2004 EDT

  Added files: 
/phpdoc/en/reference/parsekit   .cvsignore 
  Log:
  Ignore functions dir
  

http://cvs.php.net/co.php/phpdoc/en/reference/parsekit/.cvsignore?r=1.1&p=1
Index: phpdoc/en/reference/parsekit/.cvsignore
+++ phpdoc/en/reference/parsekit/.cvsignore
functions.xml

[PHP-DOC] cvs: phpdoc / manual.xml.in /en/reference/parsekit/functions parsekit-compile-file.xml parsekit-compile-string.xml parsekit-func-arginfo.xml

[Sara Golemon]

pollita Thu Aug 26 15:51:14 2004 EDT

  Modified files:  
/phpdoc manual.xml.in 
/phpdoc/en/reference/parsekit/functions parsekit-compile-file.xml 
parsekit-compile-string.xml 
parsekit-func-arginfo.xml 
  Log:
  Add parsekit to manual.xml.in and fix a few syntax errors in new function files.
  
http://cvs.php.net/diff.php/phpdoc/manual.xml.in?r1=1.186&r2=1.187&ty=u
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.186 phpdoc/manual.xml.in:1.187
--- phpdoc/manual.xml.in:1.186  Tue Aug 24 00:55:57 2004
+++ phpdoc/manual.xml.inThu Aug 26 15:51:14 2004
@@ -2,7 +2,7 @@
 
+
 
 
 
@@ -203,6 +203,7 @@
   &reference.ovrimos.reference;
   &reference.outcontrol.reference;
   &reference.overload.reference;
+  &reference.parsekit.reference;
   &reference.pdf.reference;
   &reference.pfpro.reference;
   &reference.info.reference;
http://cvs.php.net/diff.php/phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xml
diff -u phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xml:1.1 
phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xml:1.2
--- phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xml:1.1Thu 
Aug 26 15:45:42 2004
+++ phpdoc/en/reference/parsekit/functions/parsekit-compile-file.xmlThu Aug 26 
15:51:14 2004
@@ -1,5 +1,5 @@
 
-
+
 
  
   parsekit_compile_file
@@ -63,6 +63,7 @@

 parsekit_compile_file example
 
+
http://cvs.php.net/diff.php/phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml
diff -u phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml:1.1 
phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml:1.2
--- phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml:1.1  Thu 
Aug 26 15:45:42 2004
+++ phpdoc/en/reference/parsekit/functions/parsekit-compile-string.xml  Thu Aug 26 
15:51:14 2004
@@ -1,5 +1,5 @@
 
-
+
 
  
   parsekit_compile_string
@@ -62,7 +62,7 @@

 parsekit_compile_string example
 
-http://cvs.php.net/diff.php/phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xml
diff -u phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xml:1.1 
phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xml:1.2
--- phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xml:1.1Thu 
Aug 26 15:45:42 2004
+++ phpdoc/en/reference/parsekit/functions/parsekit-func-arginfo.xmlThu Aug 26 
15:51:14 2004
@@ -1,5 +1,5 @@
 
-
+
 
  
   parsekit_func_arginfo
@@ -41,6 +41,7 @@

 parsekit_func_arginfo example
 
+

[PHP-DOC] cvs: phpdoc /en/reference/parsekit configure.xml constants.xml functions.xml reference.xml /en/reference/parsekit/functions parsekit-compile-file.xml parsekit-compile-string.xml parsekit-func-arginfo.xml

[Sara Golemon]

pollita Thu Aug 26 15:45:42 2004 EDT

  Added files: 
/phpdoc/en/reference/parsekit   constants.xml configure.xml 
functions.xml reference.xml 
/phpdoc/en/reference/parsekit/functions parsekit-compile-file.xml 
parsekit-compile-string.xml 
parsekit-func-arginfo.xml 
  Log:
  Document parsekit extension
  
  
http://cvs.php.net/co.php/phpdoc/en/reference/parsekit/constants.xml?r=1.1&p=1
Index: phpdoc/en/reference/parsekit/constants.xml
+++ phpdoc/en/reference/parsekit/constants.xml



 &reftitle.constants;
 &extension.constants;
 
  
   

 PARSEKIT_QUIET
 (int)


 
  Return full detail, but without unnecessary NULL extries.
 

   

   

 PARSEKIT_SIMPLE
 (int)


 
  Return shorthand opcode notation.
 

   

   

 PARSEKIT_EXTENDED_VALUE
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_CONST
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_EA_TYPE
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_JMP_ADDR
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_OPARRAY
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_OPLINE
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_RESULT_VAR
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_USAGE_UNKNOWN
 (int) 


 
  Opnode Flag
 

   

   

 PARSEKIT_ZEND_INTERNAL_CLASS
 (int) 


 
  Class Type
 

   

   

 PARSEKIT_ZEND_USER_CLASS
 (int) 


 
  Class Type
 

   

   

 PARSEKIT_ZEND_EVAL_CODE
 (int) 


 
  Function Type
 

   

   

 PARSEKIT_ZEND_INTERNAL_FUNCTION
 (int) 


 
  Function Type
 

   

   

 PARSEKIT_ZEND_OVERLOADED_FUNCTION
 (int) 


 
  Function Type
 

   

   

 PARSEKIT_ZEND_OVERLOADED_FUNCTION_TEMPORARY
 (int) PHP >= 5.0.0


 
  Function Type
 

   

   

 PARSEKIT_ZEND_USER_FUNCTION
 (int) 


 
  Function Type
 

   

   

 PARSEKIT_IS_CONST
 (int) 


 
  Node Type
 

   

   

 PARSEKIT_IS_TMP_VAR
 (int) 


 
  Node Type
 

   

   

 PARSEKIT_IS_UNUSED
 (int) 


 
  Node Type
 

   

   

 PARSEKIT_IS_VAR
 (int) 


 
  Node Type
 

   

   

 PARSEKIT_ZEND_ADD
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ADD_ARRAY_ELEMENT
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ADD_CHAR
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ADD_INTERFACE
 (int) PHP >= 5.0.0


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ADD_STRING
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ADD_VAR
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_ADD
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_BW_AND
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_BW_OR
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_BW_XOR
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_CONCAT
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_DIM
 (int) PHP >= 5.0.0


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_DIV
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_MOD
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_MUL
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_OBJ
 (int) PHP >= 5.0.0


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_REF
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_SL
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_SR
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_ASSIGN_SUB
 (int) 


 
  Opcode
 

   

   

 PARSEKIT_ZEND_BEGIN_SILENCE
 (in

Re: [PHP-DOC] cvs: phpdoc /en/reference/classkit .cvsignore configure.xml constants.xml ini.xml reference.xml /en/reference/classkit/functions classkit-method-add.xml classkit-method-redefine.xml classkit-method-remove.xml classkit-method-rename.xml

[Sara Golemon]

> Also, the docs suggest this can only be shared; can't
> it instead be compiled into PHP as well?  On a related
> note we need a faq on using phpize.  Anyone? :)
>
Yep.  Like any other extension you can untar it under ext, run ./buildconf
and do a normal ./configure --enable-classkit to build it staticly in.

[PHP-DOC] cvs: phpdoc /en language-snippets.ent

[Sara Golemon]

pollita Thu Aug 12 15:14:02 2004 EDT

  Modified files:  
/phpdoc/en  language-snippets.ent 
  Log:
  .
  
http://cvs.php.net/diff.php/phpdoc/en/language-snippets.ent?r1=1.118&r2=1.119&ty=u
Index: phpdoc/en/language-snippets.ent
diff -u phpdoc/en/language-snippets.ent:1.118 phpdoc/en/language-snippets.ent:1.119
--- phpdoc/en/language-snippets.ent:1.118   Sat Aug  7 15:18:24 2004
+++ phpdoc/en/language-snippets.ent Thu Aug 12 15:14:02 2004
@@ -1,4 +1,4 @@
-
+
 
 
 
@@ -419,25 +419,24 @@
 currently help in our work or provided a great amount of help to the project
 in the past. There are a lot of unnamed people who help out with their user
 notes on manual pages, which continually get included in the references, the
-work of whom we are also very thankful. All the lists provided below are in
+work of whom we are also very thankful for. All the lists provided below are in
 alphabetical order.
 '>
 
 
 
-
-
-
+
+
+
 
 
 
-
+
 
 
+into managing user notes:'>
 
 

Re: [PHP-DOC] Not an active author?

[Sara Golemon]

> >>>Let me rephrase:  I take exception to the adjective "inactive".  It
> >>>minimizes my efforts to bridge the gap between development and
> >>>documentation.
> >>
> >>Excuse me, but I don't undestand what you mean here.
> >
> > I'll put it bluntly then:   If I'm seen as inactive, then perhaps I
should
> > just live up to that reputation.
>
> Once again, please excuse me, but being a foreign English speaker, I am
> not much proficient in allusions and politics when written in English.
> Does your the 'live up' statement means that *you are not* going to be
> active in the future as you are not regarded being active for the past
> half year, or does that mean *you are* going to be active to get onto
> the list (as Philip done so :)
>
It's an implication that I would cease being active.  It's also the result
of being in a very foul mood when it was written.

It's saying that if my contributions aren't important then what the hell am
I bothering for?

> The list of active authors contains authors active in the *past half
> year*, not the *next half year*, so if someone is not listed there, it
> does not mean he is not going to be.
>
I understand that.  My point is that saying that I havn't been active is an
insult.  One I am quite pissed about.  I read "Although not currently
active, ..." as saying, unambiguously, that the people listed below havn't
contributed lately.  As saying "What little the following people have done
is not worth mentioning."

That's insulting to me.  Looking again and seeing Wez's name on that list I
should think it'd be insulting to him too (while he's not done much content,
his livedocs contributions have been significant).

> Just pick an example, like Hartmut, who has been in here for a damn long
> time, authored quite some docs and done a tremendous amount of editing.
> Yet he is not listed on the frontpage, since he has not been active
> around here in the past months, and therefore does not fit into the
> active role. This does not mean that his contributions have not been
> valuable. In fact if he would not have been around here, the manual
> would be far behind. This however does not mean that he is active. These
> are two separate things.
>
You're telling me that inactive people should be labeled inactive.  Sure
enough, I agree.

> The list of 'currently not that active' people was not meant to put
> those to shame, but rather to value their contributions done in the
> past, regardless that they are not able to contribute that much amount
> of work daily done by those listed on the frontpage currently. *All* the
> lists are kind of 'toplists' done by contribution *amount* currently,
> since we found no way to make lists based on contribution *value*.
>
This will sound flippant, but what the hell, I've already done a good job of
making myself sound like a petulant child...

Which would you have me do:

(A) Commit piccune little whitespace and spelling fixes to get my count up.
(B) Stop participating entirely.
(C) Commit useful updates covering changes in behavior, new features, and
other things that readers actually look to the manual for.  Then smile like
a good girl when I'm told that I've done nothing over the past six months.

Oh, and call a spade a spade "currently not that active" is not what's
up there and you know it.

> Do you think that it is a shame to be on the 'currently not active' list?
>
It's not a shame to be listed as someone who's done work in the past.  It's
a shame and an insult to have current work disregarded as meaningless.

Re: [PHP-DOC] Not an active author?

[Sara Golemon]

> > Let me rephrase:  I take exception to the adjective "inactive".  It
> > minimizes my efforts to bridge the gap between development and
> > documentation.
>
> Excuse me, but I don't undestand what you mean here.
>
I'll put it bluntly then:   If I'm seen as inactive, then perhaps I should
just live up to that reputation.

-Sara

Re: [PHP-DOC] Not an active author?

[Sara Golemon]

> > I'm resisting the urge to move my name from "Inactive authors" to the
main
> > page.  More curious what criteria was used to determine who's active and
who
> > isn't.
>
> There was a limit on the *last half year* activity of people. I see
> around 90 letters from you (including CVS commits and bug actions) in my
> local phpdoc mailbox (which contains letters for the complete last
> year).
>
Yes fine, but what criteria was used to gague "activity"?  I know it's not
raw number of commits because I followed the thread closely enough to know
that we weren't being so silly as to include 2 character spelling
corrections.

Let me rephrase:  I take exception to the adjective "inactive".  It
minimizes my efforts to bridge the gap between development and
documentation.

[PHP-DOC] Not an active author?

[Sara Golemon]

I'm resisting the urge to move my name from "Inactive authors" to the main
page.  More curious what criteria was used to determine who's active and who
isn't.

-Sara

[PHP-DOC] cvs: phpdoc /en/reference/network/functions inet-ntop.xml inet-pton.xml

[Sara Golemon]

pollita Sat Aug  7 01:13:16 2004 EDT

  Added files: 
/phpdoc/en/reference/network/functions  inet-ntop.xml inet-pton.xml 
  Log:
  Document inet_pton() and inet_aton()
  

http://cvs.php.net/co.php/phpdoc/en/reference/network/functions/inet-ntop.xml?r=1.1&p=1
Index: phpdoc/en/reference/network/functions/inet-ntop.xml
+++ phpdoc/en/reference/network/functions/inet-ntop.xml


  
   
inet_ntop

  Converts a packed internet address to a human readable representation
 
   
   
Description
 
  stringinet_ntop
  stringin_addr
 

 This function converts a 32bit IPv4, or 128bit IPv6 address (if PHP
 was built with IPv6 support enabled) into an address family appropriate 
 string representation.  Returns &false; on failure.


 inet_ntop Example
 

 



 See also long2ip,
 inet_pton, and
 ip2long.

   
  



http://cvs.php.net/co.php/phpdoc/en/reference/network/functions/inet-pton.xml?r=1.1&p=1
Index: phpdoc/en/reference/network/functions/inet-pton.xml
+++ phpdoc/en/reference/network/functions/inet-pton.xml


  
   
inet_pton

  Converts a human readable IP address to its packed in_addr representation
 
   
   
Description
 
  stringinet_pton
  stringaddress
 

 This function converts a human readable IPv4 or IPv6 address (if PHP
 was built with IPv6 support enabled) into an address family appropriate
 32bit or 128bit binary structure.


 inet_pton Example
 

 



 See also ip2long,
 inet_ntop, and
 long2ip.

   
  

[PHP-DOC] cvs: phpdoc /en/reference/network/functions checkdnsrr.xml dns-get-record.xml

[Sara Golemon]

pollita Fri Aug  6 15:39:06 2004 EDT

  Modified files:  
/phpdoc/en/reference/network/functions  dns-get-record.xml 
checkdnsrr.xml 
  Log:
  A6 support added
  
http://cvs.php.net/diff.php/phpdoc/en/reference/network/functions/dns-get-record.xml?r1=1.18&r2=1.19&ty=u
Index: phpdoc/en/reference/network/functions/dns-get-record.xml
diff -u phpdoc/en/reference/network/functions/dns-get-record.xml:1.18 
phpdoc/en/reference/network/functions/dns-get-record.xml:1.19
--- phpdoc/en/reference/network/functions/dns-get-record.xml:1.18   Thu Dec 18 
09:14:34 2003
+++ phpdoc/en/reference/network/functions/dns-get-record.xmlFri Aug  6 15:39:06 
2004
@@ -1,5 +1,5 @@
 
-
+
   
 
  dns_get_record
@@ -86,7 +86,7 @@
   DNS_NS, DNS_PTR, 
   DNS_SOA, DNS_TXT, 
   DNS_, DNS_SRV,
-  DNS_NAPTR,
+  DNS_NAPTR, DNS_A6,
   DNS_ALL or DNS_ANY.
   The default is DNS_ANY.  
   
@@ -196,6 +196,17 @@
   
   
ipv6: IPv6 address
+  
+ 
+ 
+  A6(PHP >= 5.1.0)
+  
+   masklen: Length (in bits) to inherit from the target
+   specified by chain.
+   ipv6: Address for this specific record to merge with
+   chain.
+   chain: Parent record to merge with 
+   ipv6 data.
   
  
  
http://cvs.php.net/diff.php/phpdoc/en/reference/network/functions/checkdnsrr.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/network/functions/checkdnsrr.xml
diff -u phpdoc/en/reference/network/functions/checkdnsrr.xml:1.6 
phpdoc/en/reference/network/functions/checkdnsrr.xml:1.7
--- phpdoc/en/reference/network/functions/checkdnsrr.xml:1.6Wed Nov  5 18:13:37 
2003
+++ phpdoc/en/reference/network/functions/checkdnsrr.xmlFri Aug  6 15:39:06 
2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -24,7 +24,7 @@
 
 
  type may be any one of: A, MX, NS, SOA,
- PTR, CNAME, , or ANY.  The default is MX.
+ PTR, CNAME, , A6, SRV, NAPTR or ANY.  The default is MX.
 
 
  Host may either be the IP address in

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Sat Jul 24 00:07:06 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  Document ftp proxy context option
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.39&r2=1.40&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.39 phpdoc/en/appendices/wrappers.xml:1.40
--- phpdoc/en/appendices/wrappers.xml:1.39  Wed Jul 21 17:51:11 2004
+++ phpdoc/en/appendices/wrappers.xml   Sat Jul 24 00:07:06 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -447,6 +447,15 @@
 Applies to read mode (downloading) only.

0 (Beginning of File)
+  
+  
+   proxy(PHP 5.1.0 or greater)
+   
+Proxy FTP request via http proxy server.
+Applies to file read operations only.
+Ex: tcp://squid.example.com:8000
+   
+   
   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-context-get-default.xml

[Sara Golemon]

pollita Thu Jul 22 17:33:22 2004 EDT

  Modified files:  
/phpdoc/en/reference/stream/functions   
stream-context-get-default.xml 
  Log:
  typo
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-context-get-default.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/stream/functions/stream-context-get-default.xml
diff -u phpdoc/en/reference/stream/functions/stream-context-get-default.xml:1.1 
phpdoc/en/reference/stream/functions/stream-context-get-default.xml:1.2
--- phpdoc/en/reference/stream/functions/stream-context-get-default.xml:1.1 Thu 
Jul 22 11:19:06 2004
+++ phpdoc/en/reference/stream/functions/stream-context-get-default.xml Thu Jul 22 
17:33:22 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_context_get_default
@@ -16,7 +16,7 @@
  (fopen, file_get_contents, etc...)
  are called without a context parameter.  Options for the default context
  can optionally be specified with this function using the same syntax as
- stream_context_cretae.
+ stream_context_create.
 
 
  options must be an associative 

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-socket-enable-crypto.xml

[Sara Golemon]

pollita Thu Jul 22 17:19:00 2004 EDT

  Added files: 
/phpdoc/en/reference/stream/functions   
stream-socket-enable-crypto.xml 
  Log:
  Document new function
  

http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-socket-enable-crypto.xml?r=1.1&p=1
Index: phpdoc/en/reference/stream/functions/stream-socket-enable-crypto.xml
+++ phpdoc/en/reference/stream/functions/stream-socket-enable-crypto.xml


  
   
stream_socket_enable_crypto

 Turns encryption on/off on an already connected socket.
 
   
   
Description
 
  resourcestream_socket_enable_crypto
  resourcestream
  boolenable
  intcrypto_type
  resourcesession_stream
 


 When called with the crypto_type parameter,
 stream_socket_enable_crypto will setup
 encryption on the stream using the specified method.



 Valid values for crypto_type
 
  
STREAM_CRYPTO_METHOD_SSLv2_CLIENT
  
STREAM_CRYPTO_METHOD_SSLv3_CLIENT
  
STREAM_CRYPTO_METHOD_SSLv23_CLIENT
  
STREAM_CRYPTO_METHOD_TLS_CLIENT
  
STREAM_CRYPTO_METHOD_SSLv2_SERVER
  
STREAM_CRYPTO_METHOD_SSLv3_SERVER
  
STREAM_CRYPTO_METHOD_SSLv23_SERVER
  
STREAM_CRYPTO_METHOD_TLS_SERVER
 



 Once the crypto settings are established, cryptography can be turned
 on and off dynamically by passing &true; or &false; in the
 enable parameter.



 If this stream should be seeded with settings from an already established
 crypto enabled stream, pass that stream's resource variable
 in the fourth parameter.



 &return.success;



 stream_socket_enable_crypto Example
 

 



 , and
 

   
  

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-context-get-default.xml

[Sara Golemon]

pollita Thu Jul 22 11:19:07 2004 EDT

  Added files: 
/phpdoc/en/reference/stream/functions   
stream-context-get-default.xml 
  Log:
  Document new function
  

http://cvs.php.net/co.php/phpdoc/en/reference/stream/functions/stream-context-get-default.xml?r=1.1&p=1
Index: phpdoc/en/reference/stream/functions/stream-context-get-default.xml
+++ phpdoc/en/reference/stream/functions/stream-context-get-default.xml


  
   
stream_context_get_default
Retreive the default streams context 
   
   
Description
 
  resourcestream_context_get_default
  arrayoptions
 

 Returns the default stream context which is used whenever file operations
 (fopen, file_get_contents, etc...)
 are called without a context parameter.  Options for the default context
 can optionally be specified with this function using the same syntax as
 stream_context_cretae.


 options must be an associative 
 array of associative arrays in the format 
 $arr['wrapper']['option'] = $value.


 Using stream_context_get_default
 

 


 See also
 stream_context_create, and
 Listing of supported wrappers with context options ().

   
  

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Wed Jul 21 17:51:11 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  filemtime() support added to ftp/stat()
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.38&r2=1.39&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.38 phpdoc/en/appendices/wrappers.xml:1.39
--- phpdoc/en/appendices/wrappers.xml:1.38  Mon May 24 14:10:40 2004
+++ phpdoc/en/appendices/wrappers.xml   Wed Jul 21 17:51:11 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -390,9 +390,10 @@
Supports stat
No

-filesize, filetype, 
-file_exists, is_file,
-and is_dir elements only.
+As of 5.0.0: filesize, 
+filetype, file_exists,
+is_file, and is_dir elements only.
+As of 5.1.0: filemtime.

   
   

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Wed Jul 21 00:06:43 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Note bzip2.* filters built into 5.1
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.9 phpdoc/en/appendices/filters.xml:1.10
--- phpdoc/en/appendices/filters.xml:1.9Mon Jul 19 21:27:19 2004
+++ phpdoc/en/appendices/filters.xmlWed Jul 21 00:06:43 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Available Filters
  
@@ -379,14 +379,13 @@
to perform decompression in a minimal memory footprint at the cost of speed.
   
 
-  
-   
-The bzip2.* filters are not currently built into the PHP core.  To enable these 
filters
-in PHP 5, install the bz2_filter
+  
+bzip2.* compression filters are available with PHP as of version 
5.1.0 if
+ support is enabled.  They are also available as a 
backport in version
+5.0.x by installing the bz2_filter
 package from PECL.  These filters are 
not
 available for PHP 4.
-   
-  
+  
 
   

Re: [PHP-DOC] I have uptodate commiter stats

[Sara Golemon]

> > i'm pretty sure that i have commited more that 9 times to php, not
> > that i care too much;-)
>
> Check yourself on bonsai. Here is you "all time commits" list for phpdoc:
>
>
http://bonsai.php.net/cvsquery.cgi?treeid=default&module=phpdoc&branch=HEAD&branchtype=match&dir=&file=&filetype=match&who=thies&whotype=match&sortby=Date&hours=2&date=all&mindate=&maxdate=&cvsroot=%2Frepository
>
> It is exactly nine commits.
>
If you believe Bonsai.  Unfortunately Bonsai has gaps.  Big gaps.

For example, if you believe bonsai you'd swear I hadn't touched phpdoc since
Feb 2004.  (And that ain't true)

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Fri Jul 16 20:15:21 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Update availability of zlib.* compression filters
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.7 phpdoc/en/appendices/filters.xml:1.8
--- phpdoc/en/appendices/filters.xml:1.7Fri Apr 23 09:12:15 2004
+++ phpdoc/en/appendices/filters.xmlFri Jul 16 20:15:21 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Available Filters
  
@@ -277,14 +277,13 @@

   
 
-  
-   
-The zlib.* filters are not currently built into the PHP core.  To enable these 
filters
-in PHP 5, install the zlib_filter
+  
+zlib.* compression filters are available with PHP as of version 
5.1.0 if
+ support is enabled.  They are also available as a backport 
in version
+5.0.x by installing the zlib_filter
 package from PECL.  These filters are 
not
 available for PHP 4.
-   
-  
+  
 
   

[PHP-DOC] cvs: phpdoc /en/reference/ftp/functions ftp-chdir.xml ftp-login.xml

[Sara Golemon]

pollita Thu Jun 24 12:20:31 2004 EDT

  Modified files:  
/phpdoc/en/reference/ftp/functions  ftp-login.xml ftp-chdir.xml 
  Log:
  Spell it out.
  
http://cvs.php.net/diff.php/phpdoc/en/reference/ftp/functions/ftp-login.xml?r1=1.6&r2=1.7&ty=u
Index: phpdoc/en/reference/ftp/functions/ftp-login.xml
diff -u phpdoc/en/reference/ftp/functions/ftp-login.xml:1.6 
phpdoc/en/reference/ftp/functions/ftp-login.xml:1.7
--- phpdoc/en/reference/ftp/functions/ftp-login.xml:1.6 Fri Dec 19 09:40:54 2003
+++ phpdoc/en/reference/ftp/functions/ftp-login.xml Thu Jun 24 12:20:30 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -19,6 +19,7 @@
 
 
  &return.success;
+ If login fails, PHP will also throw a warning.
 
 
  ftp_login example
http://cvs.php.net/diff.php/phpdoc/en/reference/ftp/functions/ftp-chdir.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/ftp/functions/ftp-chdir.xml
diff -u phpdoc/en/reference/ftp/functions/ftp-chdir.xml:1.7 
phpdoc/en/reference/ftp/functions/ftp-chdir.xml:1.8
--- phpdoc/en/reference/ftp/functions/ftp-chdir.xml:1.7 Fri Dec 19 09:40:54 2003
+++ phpdoc/en/reference/ftp/functions/ftp-chdir.xml Thu Jun 24 12:20:30 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -18,6 +18,7 @@
 
 
  &return.success;
+ If changing directory fails, PHP will also throw a warning.
 
 
  ftp_chdir example

[PHP-DOC] Re: PHP "-like" website --user notes

[Sara Golemon]

> > 3. Do you have any statistics on how many people uses the
> > manual (on php.net -- not the mirros) and how many
> > maintainers are needed to check the notes contributed by
> > users? -- Is it a worth the effort, or is there too much
> > noise ? We do not have very many resources and would find
> > it difficult to spen more than 2 or 3 hours a week in the
> > upkeep of the user notes.
>
> We don't have any stats. It depends on how many people is interested in
> your manual.
>
Not formal stats no, but if you look at nntp://news.php.net/php.notes you'll
see what amounts to a history of notes posted/edited/rejected.   Technically
anyone with CVS access can modify the notes (maybe it's just people with
phpdoc karma, but if that's not everyone then it's darn close), but
historically it's usually no more than a half dozen primary watchdogs at any
given point in time.

As for general usage:  Let me put it this way:  When the server load exceeds
10, users are redirected to a local country mirror.Users are OFTEN
redirected.

-Sara

[PHP-DOC] cvs: phpdoc /en/reference/array/functions shuffle.xml

[Sara Golemon]

pollita Tue May 11 01:35:15 2004 EDT

  Modified files:  
/phpdoc/en/reference/array/functionsshuffle.xml 
  Log:
  Proto fix
  
http://cvs.php.net/diff.php/phpdoc/en/reference/array/functions/shuffle.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/array/functions/shuffle.xml
diff -u phpdoc/en/reference/array/functions/shuffle.xml:1.9 
phpdoc/en/reference/array/functions/shuffle.xml:1.10
--- phpdoc/en/reference/array/functions/shuffle.xml:1.9 Fri Mar  5 07:12:57 2004
+++ phpdoc/en/reference/array/functions/shuffle.xml Tue May 11 01:35:15 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -9,7 +9,7 @@

 Description
  
-  voidshuffle
+  boolshuffle
   arrayarray
  
 

[PHP-DOC] Re: documentating an extension, XML->HTML

[Sara Golemon]

> now, i've got the XML sheets. is there any XSLT sheets or utils to
> generate the proper HTML code from this?
>
Are you documenting a PEAR extension or a core extension?

Checkout the appropriate doc module (peardoc / phpdoc) and put your
documentation in the corresponding location (en/package/category/packagename
oren/reference/extname) and add a suitable entry to manual.xml.in.  Then
run autoconf && ./configure && make html(or make html_xsl).

-Sara

[PHP-DOC] cvs: phpdoc /en/appendices wrappers.xml

[Sara Golemon]

pollita Sun Apr 25 00:54:40 2004 EDT

  Modified files:  
/phpdoc/en/appendices   wrappers.xml 
  Log:
  This usage should be implied but
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/wrappers.xml?r1=1.36&r2=1.37&ty=u
Index: phpdoc/en/appendices/wrappers.xml
diff -u phpdoc/en/appendices/wrappers.xml:1.36 phpdoc/en/appendices/wrappers.xml:1.37
--- phpdoc/en/appendices/wrappers.xml:1.36  Thu Feb 19 11:06:55 2004
+++ phpdoc/en/appendices/wrappers.xml   Sun Apr 25 00:54:40 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Supported Protocols/Wrappers
  
@@ -101,8 +101,10 @@
 
   
http://example.com
+   
http://example.com/file.php?var1=val1&var2=val2
http://user:[EMAIL 
PROTECTED]
https://example.com
+   
https://example.com/file.php?var1=val1&var2=val2
https://user:[EMAIL 
PROTECTED]
   
 

[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions fopen.xml

[Sara Golemon]

pollita Fri Apr 23 14:23:08 2004 EDT

  Modified files:  
/phpdoc/en/reference/filesystem/functions   fopen.xml 
  Log:
  wrong param type
  
http://cvs.php.net/diff.php/phpdoc/en/reference/filesystem/functions/fopen.xml?r1=1.23&r2=1.24&ty=u
Index: phpdoc/en/reference/filesystem/functions/fopen.xml
diff -u phpdoc/en/reference/filesystem/functions/fopen.xml:1.23 
phpdoc/en/reference/filesystem/functions/fopen.xml:1.24
--- phpdoc/en/reference/filesystem/functions/fopen.xml:1.23 Wed Apr 14 01:28:54 
2004
+++ phpdoc/en/reference/filesystem/functions/fopen.xml  Fri Apr 23 14:23:08 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -12,7 +12,7 @@
   resourcefopen
   stringfilename
   stringmode
-  intuse_include_path
+  booluse_include_path
   resourcezcontext
  
 

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Fri Apr 16 00:07:28 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Document bzip2 filters
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.5 phpdoc/en/appendices/filters.xml:1.6
--- phpdoc/en/appendices/filters.xml:1.5Thu Apr 15 20:20:56 2004
+++ phpdoc/en/appendices/filters.xmlFri Apr 16 00:07:28 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Available Filters
  
@@ -236,7 +236,7 @@
While the  provide a way of creating
gzip and bz2 compatable files on the local filesystem, they do not provide a 
means for generalized compression over network streams, nor do they provide a 
-   means begin with a non-compressed stream and transition to a compressed one.  
+   means to begin with a non-compressed stream and transition to a compressed one.  
For this, a compression filter may be applied to any stream resource at any time.
   
 
@@ -353,6 +353,71 @@

   
 
+  
+   bzip2.compress and
+   bzip2.decompress
+   work in the same manner as the zlib filters described above.
+
+   The bzip2.compress filter accepts up to two parameters given as 
+   elements of an associative array: 
+
+   blocks is an integer value
+   from 1 to 9 specifying the number of 100kbyte blocks of memory to allocate for
+   workspace. 
+
+   work is also an integer value ranging from
+   0 to 250 indicating how much effort to expend using the normal compression method
+   before falling back on a slower, but more reliable method.  Tuning this parameter
+   effects only compression speed.  Neither size of compressed output nor memory usage
+   are changed by this setting.  A work factor of 0 instructs the bzip library to use
+   an internal default.   
+
+   The bzip2.decompress filter only accepts one parameter,
+   which can be passed as either an ordinary boolean value as the 
+   small element of an associative array.
+
+   small, when set to a &true; value, instructs the bzip 
library
+   to perform decompression in a minimal memory footprint at the cost of speed.
+  
+
+  
+   
+The bzip2.* filters are not currently built into the PHP core.  To enable these 
filters
+in PHP 5, install the bz2_filter
+package from PECL.  These filters are 
not
+available for PHP 4.
+   
+  
+
+  
+   
+bzip2.compress and
+bzip2.decompress
+   
+   
+
+   
+  
  
 
 

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Thu Apr 15 20:20:56 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Document zlib filters
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.4 phpdoc/en/appendices/filters.xml:1.5
--- phpdoc/en/appendices/filters.xml:1.4Thu Apr 15 11:38:49 2004
+++ phpdoc/en/appendices/filters.xmlThu Apr 15 20:20:56 2004
@@ -1,7 +1,7 @@
 
-
+
 
- List of Built-In Filters
+ List of Available Filters
  
   The following is a list of a few built-in stream filters for
   use with stream_filter_append.
@@ -229,6 +229,132 @@
   
  
 
+ 
+  Compression Filters
+
+  
+   While the  provide a way of creating
+   gzip and bz2 compatable files on the local filesystem, they do not provide a 
+   means for generalized compression over network streams, nor do they provide a 
+   means begin with a non-compressed stream and transition to a compressed one.  
+   For this, a compression filter may be applied to any stream resource at any time.
+  
+
+  
+   
+Compression filters do not generate headers and trailers
+used by commandline utilites such as gzip.  They only compress
+and decompress the payload portions of compressed data streams.
+   
+  
+
+  
+   zlib.deflate (compression) and
+   zlib.inflate (decompression) are implementations of
+   the compression methods described in RFC 1951.
+   The deflate filter takes up to three parameters passed as
+   an associative array.  
+
+   level describes the compression
+   strength to use (1-9).  Higher numbers will generally yield smaller payloads at
+   the cost of additional processing time.  Two special compression levels also exist:
+   0 (for no compression at all), and -1 (zlib internal default -- currently 6).
+
+   window is the base-2 log of the compression loopback window 
size.
+   Higher values (up to 15 -- 32768 bytes) yield better compression at a cost of 
memory,
+   while lower values (down to 9 -- 512 bytes) yield worse compression in a smaller 
memory footprint.
+   Default window size is currently 15.
+
+   memory is a scale indicating how much work memory should be 
allocated.
+   Valid values range from 1 (minimal allocation) to 9 (maximum allocation).  This 
memory allocation
+   affects speed only and does not impact the size of the generated payload.
+  
+
+  
+   
+Because compression level is the most commonly used parameter, it may be 
alternatively
+provided as a simple integer value (rather than an array element).
+   
+  
+
+  
+   
+The zlib.* filters are not currently built into the PHP core.  To enable these 
filters
+in PHP 5, install the zlib_filter
+package from PECL.  These filters are 
not
+available for PHP 4.
+   
+  
+
+  
+   
+zlib.deflate and
+zlib.inflate
+   
+   
+
+   
+  
+
+  
+   
+zlib.deflate simple
+   
+   
+
+   
+  
+
+ 
+
 
 
 

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Thu Apr 15 11:38:50 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Minor typos
  
http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.3 phpdoc/en/appendices/filters.xml:1.4
--- phpdoc/en/appendices/filters.xml:1.3Wed Apr 14 01:37:43 2004
+++ phpdoc/en/appendices/filters.xmlThu Apr 15 11:38:49 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Built-In Filters
  
@@ -164,7 +164,10 @@
chunk_split.
   
   
-   convert.base64_encode
+   
+convert.base64-encode &
+convert.base64-decode
+   

 

[PHP-DOC] cvs: phpdoc /en/appendices filters.xml

[Sara Golemon]

pollita Wed Apr 14 01:37:43 2004 EDT

  Modified files:  
/phpdoc/en/appendices   filters.xml 
  Log:
  Refactor
  
  http://cvs.php.net/diff.php/phpdoc/en/appendices/filters.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/appendices/filters.xml
diff -u phpdoc/en/appendices/filters.xml:1.2 phpdoc/en/appendices/filters.xml:1.3
--- phpdoc/en/appendices/filters.xml:1.2Wed Apr  7 08:57:35 2004
+++ phpdoc/en/appendices/filters.xmlWed Apr 14 01:37:43 2004
@@ -1,5 +1,5 @@
 
-
+
 
  List of Built-In Filters
  
@@ -45,60 +45,97 @@
the corresponding function.
   
 
-  
-   
-
- String Filters
-
-
- 
-  
-   Name
-   PHP Function equivalent
-   Since Version
-   Parameters
-  
- 
- 
-  
-   string.rot13
-   
-str_rot13
-   
-   PHP 4.3.0
-   None
-  
-  
-   string.toupper
-   
-strtoupper
-   
-   PHP 5.0.0
-   None
-  
-  
-   string.tolower
-   
-strtolower
-   
-   PHP 5.0.0
-   None
-  
-  
-   string.strip_tags
-   
-strip_tags
-   
-   PHP 5.0.0
-   
-String containing allowable tags, similar to second parameter of 
strip_tags.
-May also be an array containing list of tags (excluding <> symbols).
-   
-  
- 
-
-   
-  
+  
+   string.rot13
+   (since PHP 4.3.0)
+   Use of this filter is equivalent to processing all stream data through
+   the str_rot13 function.
+  
+  
+   string.rot13
+   
+
+   
+  
+
+  
+   string.toupper
+   (since PHP 5.0.0)
+   Use of this filter is equivalent to processing all stream data through
+   the strtoupper function.
+  
+  
+   string.toupper
+   
+
+   
+  
+
+  
+   string.tolower
+   (since PHP 5.0.0)
+   Use of this filter is equivalent to processing all stream data through
+   the strtolower function.
+  
+  
+   string.tolower
+   
+
+   
+  
+
+  
+   string.strip_tags
+   (since PHP 5.0.0)
+   Use of this filter is equivalent to processing all stream data through
+   the strip_tags function.
+   It accepts parameters in one of two forms:
+   Either as a string containing a list of tags similar to the
+   second parameter of the strip_tags function,
+   or as an array of tag names.
+  
+  
+   string.strip_tags
+   
+
+   
+  
+   
  
 
  
@@ -106,77 +143,84 @@
 
   
Like the string.* filters, the convert.* filters perform actions
-   similar to their names.
+   similar to their names.  The convert filters were added with
+   PHP 5.0.0.
For more information on a given filter, refer to the manual page for
the corresponding function.
   
 
-  
-   
-
- Convert Filters
-
-
- 
-  
-   Name
-   PHP Function equivalent
-   Since Version
-   Parameters
-  
- 
- 
-  
-   convert.base64-encode
-   
-base64_encode
-   
-   PHP 5.0.0
-   
-If parameters are provided as an associative array, 
-convert.base64-encode will insert the value of
-$parameters['line-break-chars'] every 
$parameters['line-length']
-characters of base64 output.  This allow automatic formatting of encoded 
output 
-otherwise achieved using chunk_split.
-   
-  
-  
-   convert.base64-decode
-   
-base64_decode
-   
-   PHP 5.0.0
-   None
-  
-  
-   convert.quoted-printable-encode
-   
-None.  This is the counterpart to quoted-printable-decode.
-   
-   PHP 5.0.0
-   
-line-break-chars and line-length are 
supported
-in the same manner as convert.base64-encode above.  In 
addition,
-binary and force-encode-first are 
supported as
-boolean values which default to &false;.
-   
-  
-  
-   convert.quoted-printable-decode
-   
-quoted_printable_decode
-   
-   PHP 5.0.0
-   
-If line-break-chars were specified during the encoding 
process,
-they should be specified here again in order to be stripped out for a 
successful decode.
-   
-  
- 
-
-   
-  
+  
+   convert.base64-encode and
+   convert.base64-decode
+   Use of these filters are equivalent to processing all stream data through
+   the base64_encode and base64_decode
+   functions respectively.
+   convert.base64-encode supports parameters given as
+   an associative array.  If line-length is given, the
+   base64 output will be split into chunks of line-length
+   characters each.  If line-braek-chars is given, each
+   chunk will be delimted by the characters given.  These parameters give the
+   same effect as using base64_encode with
+   chunk_split.
+  
+  
+   convert.base64_encode
+   
+
+   
+  
 
+  
+   convert.quoted-printable-encode and
+   convert.quoted-printable-decode
+   Use of the decode version of this filter is equivalent to processing all stream 
+   data through the

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-filter-register.xml

[Sara Golemon]

pollita Mon Apr 12 13:43:40 2004 EDT

  Modified files:  
/phpdoc/en/reference/stream/functions   stream-filter-register.xml 
  Log:
  Studly Caps
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-register.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-register.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.7 
phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.8
--- phpdoc/en/reference/stream/functions/stream-filter-register.xml:1.7 Mon Jan 19 
09:56:45 2004
+++ phpdoc/en/reference/stream/functions/stream-filter-register.xml Mon Apr 12 
13:43:40 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_register
@@ -94,7 +94,7 @@
 
 
 
- voidoncreate
+ voidonCreate
  
 
 
@@ -105,7 +105,7 @@
 
 
  When your filter is first instantiated, and 
- yourfilter->oncreate() is called, a number of properties
+ yourfilter->onCreate() is called, a number of properties
  will be available as shown in the table below.
 
 
@@ -136,14 +136,14 @@
 
 
 
- voidonclose
+ voidonClose
  
 
 
  This method is called upon filter shutdown (typically, this is also
  during stream shutdown), and is executed after
  the flush method is called.  If any resources
- were allocated or initialzed during oncreate
+ were allocated or initialzed during onCreate
  this would be the time to destroy or dispose of them.
 
 
@@ -231,7 +231,7 @@
 return PSFS_PASS_ON;
   }
 
-  function oncreate() 
+  function onCreate() 
   {
 if ($this->filtername == 'str.toupper') {
   $this->mode = 1;

[PHP-DOC] Re: Basic-autorization

[Sara Golemon]

> Good day.
>
> I have some notes for chapter:
http://www.php.net/manual/ru/features.remote-files.php
> Next part of it:
> -
> To connect as a user other than 'anonymous', you need to specify the
> username (and possibly password) within the URL, such as
> 'ftp://user:[EMAIL PROTECTED]/path/to/file'. (You can use the
> same sort of syntax to access files via HTTP when they require Basic
authentication.)
> -
> Need new note, because Microsoft in latest patch-s disable this
> feature (passing Basic authentication).
>
Not true.

MS disabled this feature within Internet Explorer.  This change bears no
effect on the ability of webservers (including IIS) to deal with
authorization sent from PHP or any other client which still supports this
syntax.

Internally, what happens is that PHP takes apart the URL looking for
username/password combinations and sends them in a separate format (not in
the actual URL).

For HTTP (expressed as PHP equivalent syntax):
fwrite($socket, 'Authorization: basic ' . base64_encode($user . ':' . $pass)
. "\r\n");

For FTP:
fwrite($socket, "USER $user\r\n");
fwrite($socket, "PASS $pass\r\n");

-Sara

[PHP-DOC] cvs: phpdoc / manual.xml.in /en/appendices filters.xml

[Sara Golemon]

pollita Tue Apr  6 18:54:03 2004 EDT

  Added files: 
/phpdoc/en/appendices   filters.xml 

  Modified files:  
/phpdoc manual.xml.in 
  Log:
  Document built-in filters and their accepted parameters.
  
  
http://cvs.php.net/diff.php/phpdoc/manual.xml.in?r1=1.166&r2=1.167&ty=u
Index: phpdoc/manual.xml.in
diff -u phpdoc/manual.xml.in:1.166 phpdoc/manual.xml.in:1.167
--- phpdoc/manual.xml.in:1.166  Sun Mar 28 05:08:24 2004
+++ phpdoc/manual.xml.inTue Apr  6 18:54:03 2004
@@ -258,6 +258,7 @@
   &appendices.reserved;
   &appendices.resources;
   &appendices.wrappers;
+  &appendices.filters;
   &appendices.transports;
   &appendices.comparisons;
   &appendices.tokens;

http://cvs.php.net/co.php/phpdoc/en/appendices/filters.xml?r=1.1&p=1
Index: phpdoc/en/appendices/filters.xml
+++ phpdoc/en/appendices/filters.xml



 List of Built-In Filters
 
  The following is a list of a few built-in stream filters for
  use with stream_filter_append.
  Your version of PHP may have more filters (or fewer) than those
  listed here.
 

 
  It is worth noting a slight asymmetry between 
  stream_filter_append
  and stream_filter_prepend.  
  Every PHP stream contains a small read buffer
  where it stores blocks of data retrieved from the
  filesystem or other resource in order to process data
  in the most efficient manner.  As soon as data is pulled
  from the resource into the stream's internal buffer, it
  is immediately processed through any attached filters whether
  the PHP application is actually ready for the data or not.
  If data is sitting in the read buffer when a filter is 
  appended, this data will be immediately
  processed through that buffer making the fact that is was
  sitting in the buffer seem transparent.  However, if data is
  sitting in the read buffer when a filter is 
  prepended, this data will NOT
  be processed through that filter.  It will instead wait until
  the next block of data is retrieved from the resource.
 

 
  For a list of filters installed in your version of
  PHP use stream_get_filters.
 

 
  String Filters

  
   Each of these filters does precisely what their name implies and
   correspond to the behavior of a built-in php string handling function.
   For more information on a given filter, refer to the manual page for
   the corresponding function.
  

  
   

 String Filters


 
  
   Name
   PHP Function equivalent
   Since Version
   Parameters
  
 
 
  
   string.rot13
   
str_rot13
   
   PHP 4.3.0
   None
  
  
   string.toupper
   
strtoupper
   
   PHP 5.0.0
   None
  
  
   string.tolower
   
strtolower
   
   PHP 5.0.0
   None
  
  
   string.strip_tags
   
strip_tags
   
   PHP 5.0.0
   
String containing allowable tags, similar to second parameter of 
strip_tags.
May also be an array containing list of tags (excluding <> symbols).
   
  
 

   
  
 

 
  Conversion Filters

  
   Like the string.* filters, the convert.* filters perform actions
   similar to their names.
   For more information on a given filter, refer to the manual page for
   the corresponding function.
  

  
   

 Convert Filters


 
  
   Name
   PHP Function equivalent
   Since Version
   Parameters
  
 
 
  
   convert.base64-encode
   
base64_encode
   
   PHP 5.0.0
   
If parameters are provided as an associative array, 
convert.base64-encode will insert the value of
$parameters['line-break-chars'] every 
$parameters['line-length']
characters of base64 output.  This allow automatic formatting of encoded 
output 
otherwise acheived using chunk_split.
   
  
  
   convert.base64-decode
   
base64_decode
   
   PHP 5.0.0
   None
  
  
   convert.quoted-printable-encode
   
None.  This is the counterpart to quoted-pritnable-decode.
   
   PHP 5.0.0
   
line-break-chars and line-length are 
supported
in the same manner as convert.base64-encode above.  In 
addition,
binary and force-encode-first are 
supported as
boolean values which default to &false;.
   
  
  
   convert.quoted-printable-decode
   
quoted_printable_decode
   
   PHP 5.0.0
   
If line-break-chars were specified during the encoding 
process,
they should be specified here again in order to be stripped out for a 
successful decode.
   
  
 

   
  

 

[PHP-DOC] cvs: phpdoc /en/reference/stream/functions stream-filter-append.xml stream-filter-prepend.xml

[Sara Golemon]

pollita Wed Mar 31 22:57:39 2004 EDT

  Modified files:  
/phpdoc/en/reference/stream/functions   stream-filter-prepend.xml 
stream-filter-append.xml 
  Log:
  Document how filters treat internal read buffer.
  
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-prepend.xml?r1=1.7&r2=1.8&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-prepend.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.7 
phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.8
--- phpdoc/en/reference/stream/functions/stream-filter-prepend.xml:1.7  Sat Sep 13 
22:33:42 2003
+++ phpdoc/en/reference/stream/functions/stream-filter-prepend.xml  Wed Mar 31 
22:57:39 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_prepend
@@ -45,6 +45,17 @@
   in order to register the desired user filter to 
filtername.
  
 
+
+ 
+  Stream data is read from resources (both local and remote) in chunks,
+  with any unconsumed data kept in internal buffers.  When a new
+  filter is prepended to a stream, data in the internal buffers,
+  which has already been processed through other filters will 
+  not be reprocessed through the new filter
+  at that time.  This differs from the behavior of
+  stream_filter_append.
+ 
+
 
  See also
  stream_filter_register, and
http://cvs.php.net/diff.php/phpdoc/en/reference/stream/functions/stream-filter-append.xml?r1=1.9&r2=1.10&ty=u
Index: phpdoc/en/reference/stream/functions/stream-filter-append.xml
diff -u phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.9 
phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.10
--- phpdoc/en/reference/stream/functions/stream-filter-append.xml:1.9   Mon Dec 15 
11:53:49 2003
+++ phpdoc/en/reference/stream/functions/stream-filter-append.xml   Wed Mar 31 
22:57:39 2004
@@ -1,5 +1,5 @@
 
-
+
   

 stream_filter_append
@@ -84,6 +84,15 @@
   in order to register the desired user filter to 
filtername.
  
 
+
+ 
+  Stream data is read from resources (both local and remote) in chunks,
+  with any unconsumed data kept in internal buffers.  When a new
+  filter is appended to a stream, data in the internal buffers is processed 
through
+  the new filter at that time.  This differs from the behavior of
+  stream_filter_prepend.
+ 
+
 
  See also
  stream_filter_register, and

[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions fread.xml

[Sara Golemon]

pollita Wed Mar 24 15:39:40 2004 EDT

  Modified files:  
/phpdoc/en/reference/filesystem/functions   fread.xml 
  Log:
  Fix example 3.  Remove erroneous note.
  
http://cvs.php.net/diff.php/phpdoc/en/reference/filesystem/functions/fread.xml?r1=1.15&r2=1.16&ty=u
Index: phpdoc/en/reference/filesystem/functions/fread.xml
diff -u phpdoc/en/reference/filesystem/functions/fread.xml:1.15 
phpdoc/en/reference/filesystem/functions/fread.xml:1.16
--- phpdoc/en/reference/filesystem/functions/fread.xml:1.15 Mon Dec 15 11:49:45 
2003
+++ phpdoc/en/reference/filesystem/functions/fread.xml  Wed Mar 24 15:39:40 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -62,7 +62,7 @@
  
   When reading from network streams or pipes, such as those returned when
   reading remote files or from
-  popen and proc_open, reading
+  popen and fsockopen, reading
   will stop after a packet is available.  This means that you should
   collect the data together in chunks as shown in the example below.
  
@@ -73,14 +73,10 @@
 
@@ -89,13 +85,6 @@
 
 
  
-  The example above has better performance than the traditional approach
-  using while(!feof), as we are saving the overhead
-  of a function call per iteration.
- 
-
-
- 
   If you just want to get the contents of a file into a string, use
   file_get_contents as it has much better performance
   than the code above.

[PHP-DOC] cvs: phpdoc /en/chapters tutorial.xml

[Sara Golemon]

pollita Fri Feb 20 18:12:50 2004 EDT

  Modified files:  
/phpdoc/en/chapters tutorial.xml 
  Log:
   tags don't do it here.
  
http://cvs.php.net/diff.php/phpdoc/en/chapters/tutorial.xml?r1=1.30&r2=1.31&ty=u
Index: phpdoc/en/chapters/tutorial.xml
diff -u phpdoc/en/chapters/tutorial.xml:1.30 phpdoc/en/chapters/tutorial.xml:1.31
--- phpdoc/en/chapters/tutorial.xml:1.30Fri Feb 20 13:05:32 2004
+++ phpdoc/en/chapters/tutorial.xml Fri Feb 20 18:12:50 2004
@@ -1,5 +1,5 @@
 
-
+
  
   A simple tutorial
 
@@ -440,7 +440,7 @@
 
 
  A simple XForms search form
- 
+ 
 
- 
+ 
 
 
  The above form displays a text input box (named q),
@@ -486,7 +486,7 @@
 
 
  Using an XForm to populate $_POST
- 
+ 
 
- 
+ 
 
 
  

[PHP-DOC] cvs: phpdoc /en/reference/filesystem/functions mkdir.xml

[Sara Golemon]

pollita Fri Feb 20 18:02:15 2004 EDT

  Modified files:  
/phpdoc/en/reference/filesystem/functions   mkdir.xml 
  Log:
  Missing optional parameter.
  
http://cvs.php.net/diff.php/phpdoc/en/reference/filesystem/functions/mkdir.xml?r1=1.13&r2=1.14&ty=u
Index: phpdoc/en/reference/filesystem/functions/mkdir.xml
diff -u phpdoc/en/reference/filesystem/functions/mkdir.xml:1.13 
phpdoc/en/reference/filesystem/functions/mkdir.xml:1.14
--- phpdoc/en/reference/filesystem/functions/mkdir.xml:1.13 Wed Jan 28 19:35:26 
2004
+++ phpdoc/en/reference/filesystem/functions/mkdir.xml  Fri Feb 20 18:02:13 2004
@@ -1,5 +1,5 @@
 
-
+
 
   

@@ -12,6 +12,7 @@
   boolmkdir
   stringpathname
   intmode
+  boolrecursive
   resourcecontext
  
 
@@ -56,7 +57,8 @@
 
 
  
-  The context parameter was added as of PHP 
5.0.0.
+  The recursive and context 
parameters
+  were added as of PHP 5.0.0.
  
 
 ¬e.sm.uidcheck.dir;