[PHP-DOC] #41895 [Bgs->Opn]: State that no implicit print of objects

[phpbugs at localpin dot com]

 ID:  41895
 User updated by: phpbugs at localpin dot com
 Reported By: phpbugs at localpin dot com
-Status:  Bogus
+Status:  Open
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

The problem with the documentation is not that the information does not
exist; the problem is that it is not presented in as clear a way as
possible.


Previous Comments:


[2007-08-16 12:50:27] [EMAIL PROTECTED]

"print $foo" is mentioned in the example of __toString().



[2007-07-04 15:32:05] phpbugs at localpin dot com

Description:

State explicitly in it's own bullet that "print $myObject" breaks in
5.2.



Reproduce code:
---
On the Backward Incompatible Changes page
(http://be.php.net/manual/en/migration52.incompatible.php), it is not
obvious to someone having a problem with "print $myObject" having broken
that the solution lies in the section about "__toString()".

I think it would be worth stating as a separate bullet point the
following

* "print $myObject" no longer works implicitly.
You will need to define a "__toString()" method to any class which you
wish to print directly.  See below the section on __toString() for more
details.

This would save people (like me) who are looking for the
answer/solution to this problem a lot of time.  The problem is not
noticed by people having a "__toString()" method, and so the info about
"__toString()" does not initially appear relevant.  The description
should relate more directly to the most likely place where such a
problem occurs, i.e. why the "print $myObject" has suddenly stopped
working.






-- 
Edit this bug report at http://bugs.php.net/?id=41895&edit=1

[PHP-DOC] #37105 [Opn->Csd]: "new self;" feature not properly documented

[vrana]

 ID:   37105
 Updated by:   [EMAIL PROTECTED]
 Reported By:  [EMAIL PROTECTED]
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Irrelevant
 PHP Version:  Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

new opeator: "In the class context, it is possible to create a new
object by new self and new parent."


Previous Comments:


[2006-04-17 13:07:11] [EMAIL PROTECTED]

Well, "$instance = new parent;" would have to be documented too.

Regards



[2006-04-17 13:02:20] [EMAIL PROTECTED]

Description:

The oop5 manual never talks about the ability to instanciate a class
inside itself using "$instance = new self;".

The only occurence of this behavior is in a user comment in the
reflection manual. It would be nice to have this stated somewhere.

Putting it in "The Basics"  under the "new" section would be a
possibility:

Do you have any suggestion?








-- 
Edit this bug report at http://bugs.php.net/?id=37105&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 basic.xml

[Jakub Vrana]

vrana   Fri Aug 17 06:17:58 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5basic.xml 
  Log:
  new self (bug #37105)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/basic.xml?r1=1.23&r2=1.24&diff_format=u
Index: phpdoc/en/language/oop5/basic.xml
diff -u phpdoc/en/language/oop5/basic.xml:1.23 
phpdoc/en/language/oop5/basic.xml:1.24
--- phpdoc/en/language/oop5/basic.xml:1.23  Mon Aug  6 08:41:56 2007
+++ phpdoc/en/language/oop5/basic.xml   Fri Aug 17 06:17:58 2007
@@ -1,5 +1,5 @@
 
-
+
 
  http://docbook.org/ns/docbook";>
   The Basics
@@ -146,6 +146,10 @@
 


+In the class context, it is possible to create a new object by
+new self and new parent.
+   
+   
 When assigning an already created instance of a class to a new variable, 
the new variable
 will access the same instance as the object that was assigned. This
 behaviour is the same when passing instances to a function. A copy

Re: [PHP-DOC] phpdoc conventions on methods

[Philip Olson]

You could send a file, or two, to the list and have people check it
out for you...


Thanks, the docs I'm talking about are in
http://cvs.php.net/viewvc.cgi/pecl/intl/doc/intl/


I don't have the time to check it out at the moment, hopefully someone
else will :]


Looks pretty good so far, but all filenames should be lowercased and  
use - instead of _. A few in phpdoc differentiate from this but they  
are old and it doesn't feel worth the trouble to lose CVS history by  
fixing them.


Please keep asking any and all questions because it'll help make for  
an improved doc howto.


Regards,
Philip

[PHP-DOC] #38237 [WFx]: Add PHP5 Reflection* Class documentation to main "Function Reference" docs

[sean]

 ID:   38237
 Updated by:   [EMAIL PROTECTED]
 Reported By:  phpbugs at majiclab dot com
 Status:   Wont fix
 Bug Type: Documentation problem
 Operating System: n/a
 PHP Version:  Irrelevant
 New Comment:

There /are/ anchor tags. See:
http://php.net/reflection#language.oop5.reflection.reflectionexception
for example.

S



Previous Comments:


[2007-08-17 05:46:53] phpbugs at majiclab dot com

I can accept #1, but as for #2, I agree long pages can be more
practical... However, without anchor tags being used, it makes that one
long page very unfriendly.  It'd be great if you could add links at the
top of the page that jump down to each class' section.



[2007-08-17 05:09:11] [EMAIL PROTECTED]

1. Reflection methods don't have/need separate documentation.
2. Long pages are practical.



[2006-07-27 16:54:40] phpbugs at majiclab dot com

Description:

Could the Reflection Class documentation be moved or added to the main
function reference for PHP?  I see two big improvements from this:

1. Reflection methods/etc. would be searchable in the "function list"
search method.
2. Documentation would be split up over several pages rather than all
one page.






-- 
Edit this bug report at http://bugs.php.net/?id=38237&edit=1

[PHP-DOC] #38237 [WFx]: Add PHP5 Reflection* Class documentation to main "Function Reference" docs

[phpbugs at majiclab dot com]

 ID:   38237
 User updated by:  phpbugs at majiclab dot com
 Reported By:  phpbugs at majiclab dot com
 Status:   Wont fix
 Bug Type: Documentation problem
 Operating System: n/a
 PHP Version:  Irrelevant
 New Comment:

I can accept #1, but as for #2, I agree long pages can be more
practical... However, without anchor tags being used, it makes that one
long page very unfriendly.  It'd be great if you could add links at the
top of the page that jump down to each class' section.


Previous Comments:


[2007-08-17 05:09:11] [EMAIL PROTECTED]

1. Reflection methods don't have/need separate documentation.
2. Long pages are practical.



[2006-07-27 16:54:40] phpbugs at majiclab dot com

Description:

Could the Reflection Class documentation be moved or added to the main
function reference for PHP?  I see two big improvements from this:

1. Reflection methods/etc. would be searchable in the "function list"
search method.
2. Documentation would be split up over several pages rather than all
one page.






-- 
Edit this bug report at http://bugs.php.net/?id=38237&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 05:00:11 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  invoke() accepts variable number of arguments (bug #41569)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.28&r2=1.29&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.28 
phpdoc/en/language/oop5/reflection.xml:1.29
--- phpdoc/en/language/oop5/reflection.xml:1.28 Fri Aug 17 04:55:56 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 05:00:11 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -166,7 +166,7 @@
 public int getEndLine()
 public string getDocComment()
 public array getStaticVariables()
-public mixed invoke(mixed args)
+public mixed invoke([mixed args [, ...]])
 public mixed invokeArgs(array args)
 public bool returnsReference()
 public ReflectionParameter[] getParameters()
@@ -552,7 +552,7 @@
 public void __construct(mixed class, string name)
 public string __toString()
 public static string export(mixed class, string name, bool return)
-public mixed invoke(stdclass object, mixed args)
+public mixed invoke(stdclass object [, mixed args [, ...]])
 public mixed invokeArgs(stdclass object, array args)
 public bool isFinal()
 public bool isAbstract()

[PHP-DOC] #38237 [Opn->WFx]: Add PHP5 Reflection* Class documentation to main "Function Reference" docs

[vrana]

 ID:   38237
 Updated by:   [EMAIL PROTECTED]
 Reported By:  phpbugs at majiclab dot com
-Status:   Open
+Status:   Wont fix
 Bug Type: Documentation problem
 Operating System: n/a
 PHP Version:  Irrelevant
 New Comment:

1. Reflection methods don't have/need separate documentation.
2. Long pages are practical.


Previous Comments:


[2006-07-27 16:54:40] phpbugs at majiclab dot com

Description:

Could the Reflection Class documentation be moved or added to the main
function reference for PHP?  I see two big improvements from this:

1. Reflection methods/etc. would be searchable in the "function list"
search method.
2. Documentation would be split up over several pages rather than all
one page.






-- 
Edit this bug report at http://bugs.php.net/?id=38237&edit=1

[PHP-DOC] #41569 [Opn->Csd]: Reflection*::invoke(mixed args) actually accepts zero or more arguments

[vrana]

 ID:  41569
 Updated by:  [EMAIL PROTECTED]
 Reported By: salsi at icosaedro dot it
-Status:  Open
+Status:  Closed
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.




Previous Comments:


[2007-06-02 20:51:15] salsi at icosaedro dot it

Description:

The Reflection*::invoke() methods accept zero or more arguments of
mixed type, but the signature as reported in the documentation about the
Reflection* classes does not make this evident, and apparently there is
only one mandatory argument.

A syntax similar to call_user_func() should be used instead, so:

ReflectionFunction::invoke(mixed args)  becomes
ReflectionFunction::invoke([mixed $...])

and

ReflectionMethod::invoke(object obj, mixed args)  becomes
ReflectionMethod::invoke(object obj [, [mixed $args])







-- 
Edit this bug report at http://bugs.php.net/?id=41569&edit=1

[PHP-DOC] #39876 [Opn->Csd]: ReflectionParameter::getDeclaringFunction() method not available

[vrana]

 ID:  39876
 Updated by:  [EMAIL PROTECTED]
 Reported By: bugs at php dot frankkleine dot de
-Status:  Open
+Status:  Closed
 Bug Type:Documentation problem
 PHP Version: 5.2.0
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

Available as of PHP 5.2.3.


Previous Comments:


[2006-12-20 22:21:41] bugs at php dot frankkleine dot de

Summary was changed to a wrong title, corrected this.



[2006-12-19 17:26:24] [EMAIL PROTECTED]

This is the commit that included the MBO_0s:

revision 1.164.2.32
date: 2006/03/12 17:22:34;  author: helly;  state: Exp;  lines: +66
-10

[...]
  . (inactive but tested) Add getDeclaringFunction()
  . (inactive but tested) Add getPosition()
[...]

Sadly, no reason is given why these methods are "inactive but tested".



[2006-12-19 05:59:27] judas dot iscariote at gmail dot com

either the docs needs fixing, or the #if MBO_0 's in php_reflection.c
needs to removed ;)



[2006-12-18 21:16:02] bugs at php dot frankkleine dot de

Description:

The manual states on
http://www.php.net/manual/en/language.oop5.reflection.php that the
ReflectionParameter::getDeclaringFunction() method is available since
PHP 5.1.3. However this method is neither available in 5.1.4 nor in 5.2.

Reproduce code:
---
function test1($param) {}
$refParam = new ReflectionParameter('test1', 'param');
var_dump($refParam->getDeclaringFunction());

Expected result:

object(ReflectionFunction)[1]
  public 'name' => 'test1' (length=5)


Actual result:
--
Fatal error: Call to undefined method
ReflectionParameter::getDeclaringFunction() in
E:\php\tests\reflection_parameter.php on line 4





-- 
Edit this bug report at http://bugs.php.net/?id=39876&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 05:06:06 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  getDeclaringFunction() and getPosition() available now (bug #39876)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.29&r2=1.30&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.29 
phpdoc/en/language/oop5/reflection.xml:1.30
--- phpdoc/en/language/oop5/reflection.xml:1.29 Fri Aug 17 05:00:11 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 05:06:05 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -293,10 +293,8 @@
  isDefaultValueAvailable and
  isOptional were added in PHP 5.0.3,
  while isArray was added in PHP 5.1.0.
- 
+ getPosition were added in PHP 5.2.3.
 

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 04:55:56 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  Typo
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.27&r2=1.28&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.27 
phpdoc/en/language/oop5/reflection.xml:1.28
--- phpdoc/en/language/oop5/reflection.xml:1.27 Fri Aug 17 04:54:11 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 04:55:56 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -612,7 +612,7 @@
 }
 }
 
-// Create an instance of the Reflection_Method class
+// Create an instance of the ReflectionMethod class
 $method = new ReflectionMethod('Counter', 'increment');
 
 // Print out basic information

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 04:54:11 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  ReflectionFunctionAbstract (bug #41571)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.26&r2=1.27&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.26 
phpdoc/en/language/oop5/reflection.xml:1.27
--- phpdoc/en/language/oop5/reflection.xml:1.26 Fri Aug 17 04:41:59 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 04:54:11 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -159,6 +159,7 @@
 public static string export(string name, bool return)
 public string getName()
 public bool isInternal()
+public bool isDisabled()
 public bool isUserDefined()
 public string getFileName()
 public int getStartLine()
@@ -176,6 +177,12 @@
 ]]>
 

+   
+Parent class ReflectionFunctionAbstract has the
+same methods except invoke,
+invokeArgs, export and
+isDisabled.
+   

 
  getNumberOfParameters and
@@ -558,7 +565,7 @@
 public int getModifiers()
 public ReflectionClass getDeclaringClass()
 
-// Inherited from ReflectionFunction
+// Inherited from ReflectionFunctionAbstract
 final private __clone()
 public string getName()
 public bool isInternal()

[PHP-DOC] #41571 [Opn->Csd]: ReflectionFunctionAbstract class: missing documentation

[vrana]

 ID:  41571
 Updated by:  [EMAIL PROTECTED]
 Reported By: salsi at icosaedro dot it
-Status:  Open
+Status:  Closed
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"Parent class ReflectionFunctionAbstract has the same methods except
invoke(), invokeArgs(), export() and isDisabled()." Comment fixed.


Previous Comments:


[2007-06-02 21:03:35] salsi at icosaedro dot it

Description:

The class ReflectionFunctionAbstract isn't documented at all.  A
comment to the ReflectionMethod class lets me to guess this class be
defined as follows:

abstract class ReflectionFunctionAbstract
{
private void function __clone()
public string function getName()
public bool function isInternal()
public bool function isUserDefined()
public string function getFileName()
public int function getStartLine()
public int function getEndLine()
public string function getDocComment()
public array[string]mixed function getStaticVariables()
public bool function returnsReference()
public array[int]ReflectionParameter function getParameters()
public int function getNumberOfParameters()
public int function getNumberOfRequiredParameters()
}

The comment inside ReflectionMethod

// Inherited from ReflectionFunction

should the read

// Inherited from ReflectionFunctionAbstract







-- 
Edit this bug report at http://bugs.php.net/?id=41571&edit=1

[PHP-DOC] #42202 [Opn->Csd]: fputcsv() inserts a new line character at the end of string

[vrana]

 ID:   42202
 Updated by:   [EMAIL PROTECTED]
 Reported By:  nikhil dot gupta at in dot ibm dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Linux, Windows
 PHP Version:  5CVS-2007-08-03 (CVS)
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"fputcsv() formats a line as CSV and write it (terminated by a newline)
to the specified file"


Previous Comments:


[2007-08-04 14:10:25] [EMAIL PROTECTED]

This is the correct behaviour. Reclassified as docu bug.



[2007-08-03 12:13:34] nikhil dot gupta at in dot ibm dot com

Description:

fputcsv() inserts a newline character at the end of string. This
behaviour is not seen in the documentation. This happens for both php5
and php6 on windows as well as on RHEL.

Reproduce code:
---
 


Expected result:

int(9)
int(9)
string(9) ""aaa,bbb""


Actual result:
--
int(10)
int(10)
string(10) ""aaa,bbb"
"






-- 
Edit this bug report at http://bugs.php.net/?id=42202&edit=1

[PHP-DOC] #41572 [Opn->Csd]: Example 19.40: My_Reflection_Method::$visibility is string or array?

[vrana]

 ID:  41572
 Updated by:  [EMAIL PROTECTED]
 Reported By: salsi at icosaedro dot it
-Status:  Open
+Status:  Closed
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

Initialized to array().


Previous Comments:


[2007-06-02 21:17:38] salsi at icosaedro dot it

Description:

Manual page about the Reflection* classes, example 10.40 "Extending the
built-in classes". The property My_Reflection_Method::$visibility gets
initialized with an empty string, then an array generated by
Reflection::getModifierNames() is assigned. This confused me a bit
before I realized the returned value is, indeed, an array.

I suggest to modify this example so to save time to the future readers
either changing the initial value of the property to "array()" or adding
a join() to the value returned by getModifierNames().







-- 
Edit this bug report at http://bugs.php.net/?id=41572&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 04:41:59 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  $visibility in extending example is array (bug #41572)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.25&r2=1.26&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.25 
phpdoc/en/language/oop5/reflection.xml:1.26
--- phpdoc/en/language/oop5/reflection.xml:1.25 Fri Aug 17 04:37:31 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 04:41:59 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -842,12 +842,12 @@
  */
 class My_Reflection_Method extends ReflectionMethod
 {
-public $visibility = '';
+public $visibility = array();
 
 public function __construct($o, $m)
 {
 parent::__construct($o, $m);
-$this->visibility= Reflection::getModifierNames($this->getModifiers());
+$this->visibility = 
Reflection::getModifierNames($this->getModifiers());
 }
 }
 

[PHP-DOC] #41573 [Opn->Csd]: Undocumented interface Reflector

[vrana]

 ID:  41573
 Updated by:  [EMAIL PROTECTED]
 Reported By: salsi at icosaedro dot it
-Status:  Open
+Status:  Closed
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"Reflector is an interface implemented by all exportable Reflection
classes."


Previous Comments:


[2007-06-02 21:46:35] salsi at icosaedro dot it

Description:

The interface Reflector isn't documented at all.






-- 
Edit this bug report at http://bugs.php.net/?id=41573&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 reflection.xml

[Jakub Vrana]

vrana   Fri Aug 17 04:37:32 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5reflection.xml 
  Log:
  Document Reflector (bug #41573)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/reflection.xml?r1=1.24&r2=1.25&diff_format=u
Index: phpdoc/en/language/oop5/reflection.xml
diff -u phpdoc/en/language/oop5/reflection.xml:1.24 
phpdoc/en/language/oop5/reflection.xml:1.25
--- phpdoc/en/language/oop5/reflection.xml:1.24 Wed Jun 20 22:24:13 2007
+++ phpdoc/en/language/oop5/reflection.xml  Fri Aug 17 04:37:31 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Reflection
   
@@ -111,6 +111,27 @@

   
 
+  
+   Reflector
+   
+Reflector is an interface implemented by all
+exportable Reflection classes.
+   
+   
+
+
+
+   
+  
+
   
ReflectionException

[PHP-DOC] #41588 [Opn->Csd]: preg_match offset is in bytes even in unicode mode

[vrana]

 ID:   41588
 Updated by:   [EMAIL PROTECTED]
 Reported By:  spam02 at pornel dot net
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: *
 PHP Version:  6.0.0-dev (20070509)
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

$offset: "(in bytes)"


Previous Comments:


[2007-06-04 13:18:38] [EMAIL PROTECTED]

>preg_match() with 'u' modifier is supposed to use UTF-8, but this
>switch doesn't affect offset parameter, which is always in bytes.

Right, PHP is not supposed to parse the regexp to detect which
modifiers were used.
The byte/codepoint behaviour changes only in Unicode mode.



[2007-06-04 13:08:02] spam02 at pornel dot net

(fixed php version)



[2007-06-04 13:04:43] spam02 at pornel dot net

Description:

preg_match() with 'u' modifier is supposed to use UTF-8, but this
switch doesn't affect offset parameter, which is always in bytes.

This gotcha at least deserves to be documented, although consistent
unicode support would be even better.


Reproduce code:
---
http://bugs.php.net/?id=41588&edit=1

[PHP-DOC] #41755 [Opn->Csd]: clearstatcache() documentation needs to be updated

[vrana]

 ID:   41755
 Updated by:   [EMAIL PROTECTED]
 Reported By:  mahesh dot vemula at in dot ibm dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Linux and Windows
 PHP Version:  PHP5
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"However unlink clears cache automatically."


Previous Comments:


[2007-06-21 10:57:39] mahesh dot vemula at in dot ibm dot com

The bug is tested on php5 and php6



[2007-06-21 08:54:02] mahesh dot vemula at in dot ibm dot com

Description:

clearstatcache() documentation page:
http://in2.php.net/manual/en/function.clearstatcache.php
says "if you call file_exists() on a file that doesn't exist, it will
return FALSE until you create the file. If you create the file, it will
return TRUE even if you then delete the file.". 

But if we delete the file using unlink(), and then use file_exists()
function on the file it returns FALSE, which contradicts with the
documentation of clearstatcache(), according to which it should return
TRUE even if you delete the file.
Samething happening with is_file(), is_dir() functions also.

Note:
>From unlink() source code, we see that clearstarcache() gets internally
called with call to unlink() thus clearing the cache eachtime. Hence the
actual output seems to be correct, and the documentation needs to be
fixed. 

For reference:
Source code of unlink() :
static int php_plain_files_unlink(php_stream_wrapper *wrapper, char
*url, int options, php_stream_context *context TSRMLS_DC)
{
char *p;
int ret;
zval funcname;
zval *retval = NULL;

if ((p = strstr(url, "://")) != NULL) {
url = p + 3;
}

if (options & ENFORCE_SAFE_MODE) {
if (PG(safe_mode) && !php_checkuid(url, NULL,
CHECKUID_CHECK_FILE_AND_DIR)) {
return 0;
}

if (php_check_open_basedir(url TSRMLS_CC)) {
return 0;
}
}

ret = VCWD_UNLINK(url);
if (ret == -1) {
if (options & REPORT_ERRORS) {
php_error_docref1(NULL TSRMLS_CC, url, E_WARNING, "%s",
strerror(errno));
}
return 0;
}
/* Clear stat cache */
ZVAL_STRINGL(&funcname, "clearstatcache", sizeof("clearstatcache")-1,
0);
call_user_function_ex(CG(function_table), NULL, &funcname, &retval, 0,
NULL, 0, NULL TSRMLS_CC);
if (retval) {
zval_ptr_dtor(&retval);
}
return 1;
}


Reproduce code:
---



Expected result:

bool(true)
bool(false)


Actual result:
--
bool(true)
bool(false)






-- 
Edit this bug report at http://bugs.php.net/?id=41755&edit=1

[PHP-DOC] #41937 [Opn->Csd]: Documentation of ini_get() return values

[vrana]

 ID:   41937
 Updated by:   [EMAIL PROTECTED]
 Reported By:  zoe at uk dot ibm dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Linux
 PHP Version:  Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"Returns empty string on failure or for null values"


Previous Comments:


[2007-07-09 12:53:21] zoe at uk dot ibm dot com

Description:

This problem is related to defect 41922 and applies to both PHP5 and
PHP6.

A decision has been made not to fix 41922 because of possible impact on
existing applications.

I suggest that the following text is added to the documentation for
ini_get().

Ini_get() will return a null string to indicate either (a) that the
call to ini_get() has failed, or (b) that the value of the ini setting 
is a null string. Please see here: http://uk.php.net/manual/en/ini.php
for a list of ini settings which have a null string as the default
value.






-- 
Edit this bug report at http://bugs.php.net/?id=41937&edit=1

[PHP-DOC] #42012 [Opn->Bgs]: section index request

[vrana]

 ID:   42012
 Updated by:   [EMAIL PROTECTED]
 Reported By:  keith at karsites dot net
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: Fedora Core 6
 PHP Version:  Irrelevant
 New Comment:

Web documentation has link to a section in left column.


Previous Comments:


[2007-07-16 21:23:43] keith at karsites dot net

Description:

Docs Feature request:

As well as the main index at the front of the manual, please could 
we have an index at the start of each section, similar to the MySQL 
or PostgreSQL manuals?

Eg. when I'm reading about a particular function, say the file() 
function, in the Filesystem section I cannot go directly to the 
start of that section. I have to click on Home at the bottom of the 
page, go to the front of the manual, then find the 'XL Filesystem 
Functions' section, and click on that to get the index page for this 
section.

Could we have a link somewhere prominent on each page in each 
section, that would allow one to return directly to the index page 
of that particular section?

That would make navigating the documentation alot quicker.

TIA

Keith







-- 
Edit this bug report at http://bugs.php.net/?id=42012&edit=1

[PHP-DOC] #41934 [Opn->Bgs]: xslt extension for PHP 5 not found on PECL

[vrana]

 ID:  41934
 Updated by:  [EMAIL PROTECTED]
 Reported By: peter_e at gmx dot net
-Status:  Open
+Status:  Bogus
 Bug Type:Documentation problem
 PHP Version: Irrelevant
 New Comment:

It really is in PECL: http://cvs.php.net/pecl/xslt/


Previous Comments:


[2007-07-09 10:08:49] peter_e at gmx dot net

Then change the documentation to reflect that.  If it has been moved 
but never released, it is for all intents and purposes simply 
removed.



[2007-07-09 09:12:09] [EMAIL PROTECTED]

It's been moved to PECL but was never released, mostly because there is
not much point as there is ext/xsl in PHP5.



[2007-07-09 09:02:36] peter_e at gmx dot net

Description:

The page  claims 
that "This extension has been moved to the PECL repository", but 
there is nothing on the PECL site that matches "xslt".  Please 
clarify what happened to this extension.






-- 
Edit this bug report at http://bugs.php.net/?id=41934&edit=1

[PHP-DOC] cvs: phpdoc /en/reference/info/functions ini-get.xml

[Jakub Vrana]

vrana   Thu Aug 16 12:31:30 2007 UTC

  Modified files:  
/phpdoc/en/reference/info/functions ini-get.xml 
  Log:
  Returns empty string also for null (bug #41937)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/info/functions/ini-get.xml?r1=1.16&r2=1.17&diff_format=u
Index: phpdoc/en/reference/info/functions/ini-get.xml
diff -u phpdoc/en/reference/info/functions/ini-get.xml:1.16 
phpdoc/en/reference/info/functions/ini-get.xml:1.17
--- phpdoc/en/reference/info/functions/ini-get.xml:1.16 Wed Jun 20 22:24:47 2007
+++ phpdoc/en/reference/info/functions/ini-get.xml  Thu Aug 16 12:31:30 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   ini_get
@@ -37,7 +37,7 @@
   &reftitle.returnvalues;
   
Returns the value of the configuration option as a string on success, or
-   an empty string on failure.
+   an empty string on failure or for null values.
   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/pcre/functions preg-match-all.xml preg-match.xml

[Jakub Vrana]

vrana   Fri Aug 17 03:00:29 2007 UTC

  Modified files:  
/phpdoc/en/reference/pcre/functions preg-match-all.xml 
preg-match.xml 
  Log:
  $offset is in bytes (#41588)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pcre/functions/preg-match-all.xml?r1=1.24&r2=1.25&diff_format=u
Index: phpdoc/en/reference/pcre/functions/preg-match-all.xml
diff -u phpdoc/en/reference/pcre/functions/preg-match-all.xml:1.24 
phpdoc/en/reference/pcre/functions/preg-match-all.xml:1.25
--- phpdoc/en/reference/pcre/functions/preg-match-all.xml:1.24  Thu Aug 16 
10:03:31 2007
+++ phpdoc/en/reference/pcre/functions/preg-match-all.xml   Fri Aug 17 
03:00:29 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   preg_match_all
@@ -158,7 +158,7 @@
   
Normally, the search starts from the beginning of the subject string.
The optional parameter offset can be used to
-   specify the alternate place from which to start the search.
+   specify the alternate place from which to start the search (in bytes).
   
   

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pcre/functions/preg-match.xml?r1=1.25&r2=1.26&diff_format=u
Index: phpdoc/en/reference/pcre/functions/preg-match.xml
diff -u phpdoc/en/reference/pcre/functions/preg-match.xml:1.25 
phpdoc/en/reference/pcre/functions/preg-match.xml:1.26
--- phpdoc/en/reference/pcre/functions/preg-match.xml:1.25  Mon Jul 23 
19:32:16 2007
+++ phpdoc/en/reference/pcre/functions/preg-match.xml   Fri Aug 17 03:00:29 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   preg_match
@@ -82,7 +82,7 @@
   
Normally, the search starts from the beginning of the subject string.
The optional parameter offset can be used to
-   specify the alternate place from which to start the search.
+   specify the alternate place from which to start the search (in bytes).
   
   

[PHP-DOC] #41658 [Opn->Bgs]: Missing documentation for SoapClient and SoapServer classes

[vrana]

 ID:   41658
 Updated by:   [EMAIL PROTECTED]
 Reported By:  scott at crisscott dot com
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: Irrelavent
 PHP Version:  Irrelevant
 New Comment:

Thanks for the report. We have other tools to track the missing
documentation.


Previous Comments:


[2007-06-11 19:24:22] scott at crisscott dot com

Description:

Missing methods:
SoapServer::addSoapHeader()
SoapClient::__setSoapHeaders()

Reproduce code:
---
$> php --rc SoapServer
$> php --rc SoapClient






-- 
Edit this bug report at http://bugs.php.net/?id=41658&edit=1

[PHP-DOC] #41680 [Opn->Csd]: set_error_handler is unclear on the effects of retuning false

[vrana]

 ID:   41680
 Updated by:   [EMAIL PROTECTED]
 Reported By:  tbajan at mintel dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Unix
 PHP Version:  Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"If the function returns FALSE then the normal error handler
continues."


Previous Comments:


[2007-06-13 14:32:33] tbajan at mintel dot com

Description:

The documentation says "The error handler must return FALSE to populate
$php_errormsg."  It is not clear that returning false from the error
handler also runs the whole default PHP error handler.






-- 
Edit this bug report at http://bugs.php.net/?id=41680&edit=1

[PHP-DOC] cvs: phpdoc /en/reference/errorfunc/functions set-error-handler.xml

[Jakub Vrana]

vrana   Fri Aug 17 02:28:56 2007 UTC

  Modified files:  
/phpdoc/en/reference/errorfunc/functionsset-error-handler.xml 
  Log:
  Returning false from callback (bug #41680)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/errorfunc/functions/set-error-handler.xml?r1=1.37&r2=1.38&diff_format=u
Index: phpdoc/en/reference/errorfunc/functions/set-error-handler.xml
diff -u phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.37 
phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.38
--- phpdoc/en/reference/errorfunc/functions/set-error-handler.xml:1.37  Wed Jun 
20 22:24:25 2007
+++ phpdoc/en/reference/errorfunc/functions/set-error-handler.xml   Fri Aug 
17 02:28:56 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   set_error_handler
@@ -131,6 +131,9 @@
 

   
+  
+   If the function returns &false; then the normal error handler continues.
+  
  
 
 

[PHP-DOC] #41697 [Opn->Csd]: Impossible to compare simpleXML Objects

[vrana]

 ID:   41697
 Updated by:   [EMAIL PROTECTED]
 Reported By:  judas dot iscariote at gmail dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Irrelevant
 PHP Version:  5CVS-2007-06-15 (CVS)
 Assigned To:  rrichards
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"Extensions can define own rules for their objects comparison."


Previous Comments:


[2007-06-27 08:46:27] judas dot iscariote at gmail dot com

This gotcha should be mentioned in the documentation then .



[2007-06-26 12:32:46] [EMAIL PROTECTED]

Thank you for taking the time to write to us, but this is not
a bug. Please double-check the documentation available at
http://www.php.net/manual/ and the instructions on how to report
a bug at http://bugs.php.net/how-to-report.php

Tony's assessment is correct



[2007-06-25 18:43:19] [EMAIL PROTECTED]

As far as I know, there is no way to compare two different Libxml
document pointers, so the result is correct.
Rob, please correct me if I'm wrong.



[2007-06-15 07:53:29] judas dot iscariote at gmail dot com

Description:

You cannot compare simpleXML Objects.


Reproduce code:
---
';


$foo = new SimpleXMLElement($xmlstring);

$bar = new SimpleXMLElement($xmlstring);

/* "Two object instances are equal if they have the same attributes and
values, and are instances of the same class" */

var_dump($foo == $bar);

/* object are identical if and only if they refer to the same instance
of the same class.*/

var_dump($foo === $bar);

?>

Expected result:

//the are equal
bool(true)
//but not indentical
bool(false)


Actual result:
--
bool(false)
bool(false)






-- 
Edit this bug report at http://bugs.php.net/?id=41697&edit=1

[PHP-DOC] cvs: phpdoc /en/language/oop5 object-comparison.xml

[Jakub Vrana]

vrana   Fri Aug 17 02:14:00 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5object-comparison.xml 
  Log:
  Comparing extension objects (bug #41697)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/object-comparison.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/language/oop5/object-comparison.xml
diff -u phpdoc/en/language/oop5/object-comparison.xml:1.5 
phpdoc/en/language/oop5/object-comparison.xml:1.6
--- phpdoc/en/language/oop5/object-comparison.xml:1.5   Wed Jun 20 22:24:13 2007
+++ phpdoc/en/language/oop5/object-comparison.xml   Fri Aug 17 02:14:00 2007
@@ -1,5 +1,5 @@
 
-
+
   http://docbook.org/ns/docbook";>
Comparing objects

@@ -100,6 +100,11 @@
  
 

+   
+
+ Extensions can define own rules for their objects comparison.
+
+   
   
  
 

[PHP-DOC] #41700 [Opn->Bgs]: documentation not clear about "whatever() or return;"

[vrana]

 ID:   41700
 Updated by:   [EMAIL PROTECTED]
 Reported By:  looris at gmail dot com
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: Irrilevant
 PHP Version:  Irrelevant
 New Comment:

"return" is not a function as documented in "return" documentation.


Previous Comments:


[2007-06-15 12:58:40] smlerman at gmail dot com

>From http://www.php.net/manual/en/function.return.php:
"...the return() statement..."

Return is a statement, not a function or expression. It has to appear
on its own, not as part of some other statement.



[2007-06-15 12:37:21] looris at gmail dot com

Description:

I came across this: http://bugs.php.net/bug.php?id=40712

here's what iliaa wrote:

+

Thank you for taking the time to write to us, but this is not

a bug. Please double-check the documentation available at
http://www.php.net/manual/ and the instructions on how to report
a bug at 
http://bugs.php.net/how-to-report.php

+

now, I guess that you can't do "..or return.." because return isn't a
function, ok, but, reading the documentation, nothing related to this
sort of thing is ever mentioned in these related articles:
http://www.php.net/manual/en/function.return.php
http://www.php.net/manual/en/functions.returning-values.php
http://www.php.net/manual/en/language.operators.logical.php
http://www.php.net/manual/en/language.functions.php

Maybe this thing is explained somewhere in the docs, but it seems a
little awkward to me that it doesn't appear on none of these related
articles. I think this kind of thing does really need to be mentioned
somewhere in these places. If this is not a documentation bug, i don't
know what is.






-- 
Edit this bug report at http://bugs.php.net/?id=41700&edit=1

[PHP-DOC] #42323 [Opn->Csd]: Details in array_merge page are wrong

[vrana]

 ID:   42323
 Updated by:   [EMAIL PROTECTED]
 Reported By:  kev at projectcolo dot org dot uk
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: N/A
 PHP Version:  Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"If you want to completely preserve the arrays and just want to append
them to each other (not overwriting the previous keys), use the +
operator"


Previous Comments:


[2007-08-16 22:36:17] kev at projectcolo dot org dot uk

Description:

The notes in Example 257 above are incorrect. It states:

If you want to completely preserve the arrays and just want to append
them to each other, use the + operator

Check the array type page at
http://www.php.net/manual/en/language.types.array.php which states
differently. Duplicate keys are ignored with the + operator.

Reproduce code:
---



Expected result:

array(2) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  ... more values
}
array(4) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  [2]=>
  string(4) "rain"
  [3]=>
  string(5) "shine"
}


Actual result:
--
array(2) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
}
array(4) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  [2]=>
  string(4) "rain"
  [3]=>
  string(5) "shine"
}






-- 
Edit this bug report at http://bugs.php.net/?id=42323&edit=1

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

[Jakub Vrana]

vrana   Fri Aug 17 02:03:58 2007 UTC

  Modified files:  
/phpdoc/en/reference/array/functionsarray-merge.xml 
  Log:
  Plus doesn't overwrite keys (bug #42323)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/array/functions/array-merge.xml?r1=1.20&r2=1.21&diff_format=u
Index: phpdoc/en/reference/array/functions/array-merge.xml
diff -u phpdoc/en/reference/array/functions/array-merge.xml:1.20 
phpdoc/en/reference/array/functions/array-merge.xml:1.21
--- phpdoc/en/reference/array/functions/array-merge.xml:1.20Wed Jun 20 
22:24:15 2007
+++ phpdoc/en/reference/array/functions/array-merge.xml Fri Aug 17 02:03:58 2007
@@ -1,5 +1,5 @@
 
-
+
 
 http://docbook.org/ns/docbook";>
  
@@ -85,7 +85,8 @@
 
 
  If you want to completely preserve the arrays and just want to append
- them to each other, use the + operator:
+ them to each other (not overwriting the previous keys), use the
+ + operator:
 
 
 

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

[Jakub Vrana]

vrana   Fri Aug 17 01:59:28 2007 UTC

  Modified files:  
/phpdoc/en/reference/misc/functions eval.xml 
  Log:
  Grammar (thanks to Mike Ford)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/misc/functions/eval.xml?r1=1.23&r2=1.24&diff_format=u
Index: phpdoc/en/reference/misc/functions/eval.xml
diff -u phpdoc/en/reference/misc/functions/eval.xml:1.23 
phpdoc/en/reference/misc/functions/eval.xml:1.24
--- phpdoc/en/reference/misc/functions/eval.xml:1.23Thu Aug 16 13:10:28 2007
+++ phpdoc/en/reference/misc/functions/eval.xml Fri Aug 17 01:59:28 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   eval
@@ -58,11 +58,11 @@
   
As of PHP 4, eval returns &null; unless 
return is called in the evaluated code, in which case
-   the value passed to return is returned. In case of a
-   parse error in the evaluated code, eval returns 
-   &false;. Normal code continues in execution after parse error in
-   eval and this error can not be catched by
-   set_error_handler.
+   the value passed to return is returned. If there is a
+   parse error in the evaluated code, eval returns
+   &false; and execution of the following code continues normally. It is
+   not possible to catch a parse error in eval
+   using set_error_handler.
   
  
 

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

[Jakub Vrana]

vrana   Fri Aug 17 01:54:46 2007 UTC

  Modified files:  
/phpdoc/en/reference/bbcode/functions   bbcode-create.xml 
  Log:
  Fix proto
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bbcode/functions/bbcode-create.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/bbcode/functions/bbcode-create.xml
diff -u phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.3 
phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.4
--- phpdoc/en/reference/bbcode/functions/bbcode-create.xml:1.3  Tue Jul 24 
21:55:02 2007
+++ phpdoc/en/reference/bbcode/functions/bbcode-create.xml  Fri Aug 17 
01:54:46 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   bbcode_create
@@ -8,7 +8,7 @@
  
   &reftitle.description;
   
-   ressourcebbcode_create
+   resourcebbcode_create
arraybbcode_initial_tags
   
 

[PHP-DOC] cvs: phpdoc /scripts check-references.php

[Jakub Vrana]

vrana   Fri Aug 17 01:54:04 2007 UTC

  Modified files:  
/phpdoc/scripts check-references.php 
  Log:
  Conditional incrementation of $counts[refs]
  
http://cvs.php.net/viewvc.cgi/phpdoc/scripts/check-references.php?r1=1.24&r2=1.25&diff_format=u
Index: phpdoc/scripts/check-references.php
diff -u phpdoc/scripts/check-references.php:1.24 
phpdoc/scripts/check-references.php:1.25
--- phpdoc/scripts/check-references.php:1.24Fri Jun 15 15:53:49 2007
+++ phpdoc/scripts/check-references.php Fri Aug 17 01:54:04 2007
@@ -391,7 +391,7 @@
) {
echo (isset($source_ref[0]) ? "Parameter(s) " . 
(is_int($source_ref[0]) ? "$source_ref[0] and rest" : implode(", ", 
$source_ref[0])) : "Nothing") . " should be passed by reference in $filename on 
line $lineno" . (isset($source_ref[1]) ? "\n: source in $source_ref[1] on line 
$source_ref[2]" : "") . ".\n";
}
-   if (isset($source_ref)) {
+   if (isset($source_refs[$function_name])) {
$counts["refs"]++;
}

[PHP-DOC] cvs: phpdoc /en/reference/svn/functions svn-fs-node-prop.xml

[Jakub Vrana]

vrana   Fri Aug 17 01:53:19 2007 UTC

  Modified files:  
/phpdoc/en/reference/svn/functions  svn-fs-node-prop.xml 
  Log:
  Fix proto
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml
diff -u phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml:1.2 
phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml:1.3
--- phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml:1.2  Thu Jun 21 
11:46:57 2007
+++ phpdoc/en/reference/svn/functions/svn-fs-node-prop.xml  Fri Aug 17 
01:53:19 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  
   svn_fs_node_prop
@@ -9,7 +9,7 @@
  
   &reftitle.description;
   
-   intsvn_fs_node_prop
+   stringsvn_fs_node_prop

resourcefsroot
stringpath

stringpropname

Re: [PHP-DOC] phpdoc conventions on methods

[Hannes Magnusson]

On 8/17/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> > This magic include has nothing to do with IDs or refnames or any other
> > element/attribute. Its a total file based voodoo.
>
> Yes, I understand. What I wasn't sure is if I have two refname's in
> refentry tag, would I still get one entry on the reference page when
> it's rendered? I guess the answer is yes.

Yes.
since the path/to/function will translate to &path.to.function; its
totally unaware of the content of the file.


>
> > Just to be sure, you are using the skeletons from
> > http://wiki.phpdoc.info/DocSkel?v=sx8, right?
> >
>
> Yep, looks like that. Only thing - if I use xlink:href, I have to add
> xmlns:xlink="http://www.w3.org/1999/xlink"; to refentry tag. It's not in
> the skeleton and it didn't build for me without it - so is there
> easier/better way to do it?

If you use the xlink namespace you need to add it to the root element
of the file.
There is no simpler way of doing it, no.
(There is no harm in defining it even if it isn't used, so I guess the
skeletons should be updated to define it always..)

-Hannes

Re: [PHP-DOC] phpdoc conventions on methods

[Stanislav Malyshev]

This magic include has nothing to do with IDs or refnames or any other
element/attribute. Its a total file based voodoo.


Yes, I understand. What I wasn't sure is if I have two refname's in 
refentry tag, would I still get one entry on the reference page when 
it's rendered? I guess the answer is yes.



Just to be sure, you are using the skeletons from
http://wiki.phpdoc.info/DocSkel?v=sx8, right?



Yep, looks like that. Only thing - if I use xlink:href, I have to add 
xmlns:xlink="http://www.w3.org/1999/xlink"; to refentry tag. It's not in 
the skeleton and it didn't build for me without it - so is there 
easier/better way to do it?


--
Stanislav Malyshev, Zend Software Architect
[EMAIL PROTECTED]   http://www.zend.com/
(408)253-8829   MSN: [EMAIL PROTECTED]

[PHP-DOC] cvs: phpdoc / README

[Hannes Magnusson]

bjori   Fri Aug 17 00:54:56 2007 UTC

  Modified files:  
/phpdoc README 
  Log:
  ulink is no longer used, recommend link xlink:href instead
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/README?r1=1.36&r2=1.37&diff_format=u
Index: phpdoc/README
diff -u phpdoc/README:1.36 phpdoc/README:1.37
--- phpdoc/README:1.36  Thu May 24 23:12:47 2007
+++ phpdoc/README   Fri Aug 17 00:54:56 2007
@@ -120,8 +120,8 @@
   internal manual links
 variables
 
- external links via global.ent
-mmm cookies

+  external links via global.ent
+mmm cookies   
 
 
   types, this links to the given types manual
 page: object -> php.net/types.object

Re: [PHP-DOC] phpdoc conventions on methods

[Hannes Magnusson]

On 8/17/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> > Neither. functions.xml is autogenerated by configure and referes to
> > the filepath.
>
> So, the function list in main extension page gets one entry per file in
> functions/? Where the names come from - is it refname? What if I have
> more than one refname - is it only first?

I'm not following (could be to tired, in which case I'll reply again
to morrow :P)

If you mean "each file in functions/ gets one entry in functions.xml"
you are right.
Its all done via magically created entities.

How this works:
reference.xml (the "index page" for all extensions):

.


...



This magic include has nothing to do with IDs or refnames or any other
element/attribute. Its a total file based voodoo.

The bottom line: you don't have to think about how or where to
"include" the xml files. Its all done automatically.
For consistency, please name the files with their xml:id (stripping
"function." from the filename).

i.e. the strpos() function is located in functions/strpos.xml and
therfor has the ID "function.strpos"


Just to be sure, you are using the skeletons from
http://wiki.phpdoc.info/DocSkel?v=sx8, right?


> >> 2. There's two ways of making external links  and  >> xlink:href>. Is there a difference? Which one should be used?
> >
> >  does not exist in DocBook5.
> > The correct method is  (all external URLs
> > should be entities and added to phpdoc/entities/global.ent
>
> I guess someone has to fix the README in phpdoc then ;) It tells to use
> .

Grr. I'll fix it. Thanks for the heads up

-Hannes

[PHP-DOC] #41866 [Bgs]: method overloading works "correctly" but not "as described"

[ozone at cname dot com]

 ID:   41866
 User updated by:  ozone at cname dot com
 Reported By:  ozone at cname dot com
 Status:   Bogus
 Bug Type: Documentation problem
 Operating System: netbsd
 PHP Version:  Irrelevant
 New Comment:

Examples of daisy-chaining parent:: are given in the documentation for
"Constructors and Destructors", but not in the documentation for
"Overloading", so I ended up writing code to see what would happen. If
the rules about argument passing are different inside Magic Methods than
elsewhere, it would be a useful thing to document.


Previous Comments:


[2007-08-16 13:15:14] [EMAIL PROTECTED]

You are calling __call() directly. Documentation describes behavior
with indirect calling - method($parameters).



[2007-07-01 21:26:50] ozone at cname dot com

Description:

Documentation states that the __call() method will be passed two
arguments, the first being the name of the called method, the second
being *an array* of the arguments. Thus, when daisy-chaining the
__call() method via parent::__call() or equivalent, the second __call()
should have an array with a single element which is an array of the
arguments passed to the first __call().

The actual behavior is more desirable than the documented behavior, and
this is probably "not a bug". That said, I don't want to rewrite my code
if a future version of PHP changes the behavior without warning.


Reproduce code:
---
class a {
function __call($m, $a) {
echo "--- a::$m\n";
echo "call($m) ";
var_dump($a);
}
}

class b extends a {
function __call($m, $a) {
echo "--- b::$m\n";
if($m == "special") {
echo "special override ";
var_dump($a);
} else parent::__call($m, $a);
}
}

$ca = new a();
$cb = new b();
$ca->test();
$ca->test("one", "two");
$cb->special();
$cb->test();
$cb->test("one", "two");


Expected result:

A literal interpretation of the documentation says the var_dump
ultimately executed by the last call to $cb->test() "should" display
something like:

array(1) {
  [0]=> array(2) {
  [0]=>
  string(3) "one"
  [1]=>
  string(3) "two"
  }
}


Actual result:
--
array(2) {
  [0]=>
  string(3) "one"
  [1]=>
  string(3) "two"
}






-- 
Edit this bug report at http://bugs.php.net/?id=41866&edit=1

Re: [PHP-DOC] phpdoc conventions on methods

[Stanislav Malyshev]

Neither. functions.xml is autogenerated by configure and referes to
the filepath.


So, the function list in main extension page gets one entry per file in 
functions/? Where the names come from - is it refname? What if I have 
more than one refname - is it only first?



2. There's two ways of making external links  and . Is there a difference? Which one should be used?


 does not exist in DocBook5.
The correct method is  (all external URLs
should be entities and added to phpdoc/entities/global.ent


I guess someone has to fix the README in phpdoc then ;) It tells to use 
.

--
Stanislav Malyshev, Zend Software Architect
[EMAIL PROTECTED]   http://www.zend.com/
(408)253-8829   MSN: [EMAIL PROTECTED]

[PHP-DOC] #42323 [NEW]: Details in array_merge page are wrong

[kev at projectcolo dot org dot uk]

From: kev at projectcolo dot org dot uk
Operating system: N/A
PHP version:  Irrelevant
PHP Bug Type: Documentation problem
Bug description:  Details in array_merge page are wrong

Description:

The notes in Example 257 above are incorrect. It states:

If you want to completely preserve the arrays and just want to append them
to each other, use the + operator

Check the array type page at
http://www.php.net/manual/en/language.types.array.php which states
differently. Duplicate keys are ignored with the + operator.

Reproduce code:
---



Expected result:

array(2) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  ... more values
}
array(4) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  [2]=>
  string(4) "rain"
  [3]=>
  string(5) "shine"
}


Actual result:
--
array(2) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
}
array(4) {
  [0]=>
  string(4) "moon"
  [1]=>
  string(3) "sky"
  [2]=>
  string(4) "rain"
  [3]=>
  string(5) "shine"
}


-- 
Edit bug report at http://bugs.php.net/?id=42323&edit=1
-- 
Try a CVS snapshot (PHP 4.4): 
http://bugs.php.net/fix.php?id=42323&r=trysnapshot44
Try a CVS snapshot (PHP 5.2): 
http://bugs.php.net/fix.php?id=42323&r=trysnapshot52
Try a CVS snapshot (PHP 6.0): 
http://bugs.php.net/fix.php?id=42323&r=trysnapshot60
Fixed in CVS: http://bugs.php.net/fix.php?id=42323&r=fixedcvs
Fixed in release: 
http://bugs.php.net/fix.php?id=42323&r=alreadyfixed
Need backtrace:   http://bugs.php.net/fix.php?id=42323&r=needtrace
Need Reproduce Script:http://bugs.php.net/fix.php?id=42323&r=needscript
Try newer version:http://bugs.php.net/fix.php?id=42323&r=oldversion
Not developer issue:  http://bugs.php.net/fix.php?id=42323&r=support
Expected behavior:http://bugs.php.net/fix.php?id=42323&r=notwrong
Not enough info:  
http://bugs.php.net/fix.php?id=42323&r=notenoughinfo
Submitted twice:  
http://bugs.php.net/fix.php?id=42323&r=submittedtwice
register_globals: http://bugs.php.net/fix.php?id=42323&r=globals
PHP 3 support discontinued:   http://bugs.php.net/fix.php?id=42323&r=php3
Daylight Savings: http://bugs.php.net/fix.php?id=42323&r=dst
IIS Stability:http://bugs.php.net/fix.php?id=42323&r=isapi
Install GNU Sed:  http://bugs.php.net/fix.php?id=42323&r=gnused
Floating point limitations:   http://bugs.php.net/fix.php?id=42323&r=float
No Zend Extensions:   http://bugs.php.net/fix.php?id=42323&r=nozend
MySQL Configuration Error:http://bugs.php.net/fix.php?id=42323&r=mysqlcfg

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 22:22:16 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagickreference.xml 
  Log:
  Added aboutimagemagick section
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/reference.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/imagick/reference.xml
diff -u phpdoc/en/reference/imagick/reference.xml:1.9 
phpdoc/en/reference/imagick/reference.xml:1.10
--- phpdoc/en/reference/imagick/reference.xml:1.9   Wed Jun 20 22:24:40 2007
+++ phpdoc/en/reference/imagick/reference.xml   Thu Aug 16 22:22:16 2007
@@ -1,5 +1,5 @@
 
-
+
 
 
 
@@ -16,9 +16,20 @@
 ImageMagick API.

   
- 
+
+  
+   
+   ImageMagick® is a software suite to create, edit, and compose bitmap 
images..
+   It can read, convert and write images in a variety of formats (over 100)
+   including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, 
Postscript, SVG, and TIFF.
+   
+   
+  Copyright 1999-2007 ImageMagick Studio LLC, a non-profit 
organization dedicated to making software imaging solutions freely available.
+
+  
+
   
-   &reftitle.examples;
+   &reftitle.examples; 

 Imagick makes image manipulation in PHP extremely easy through an OO
 interface. Here is a quick example on how to make a thumbnail:

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:56:57 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickcharcoalimage.xml 
  Log:
  Added method descriptions
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/charcoalimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/charcoalimage.xml
diff -u phpdoc/en/reference/imagick/imagick/charcoalimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/charcoalimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/charcoalimage.xml:1.4   Wed Jun 20 
22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/charcoalimage.xml   Thu Aug 16 
21:56:57 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-charcoalimage">
  
   Imagick::charcoalImage
@@ -28,7 +28,7 @@
  radius
  
   
-   Its description
+   The radius of the Gaussian, in pixels, not counting the center pixel
   
  
 
@@ -36,7 +36,7 @@
  sigma
  
   
-   Its description
+   The standard deviation of the Gaussian, in pixels
   
  
 

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:55:10 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickborderimage.xml 
  Log:
  Fixed parameter descriptions and changed method description a little.
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/borderimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/borderimage.xml
diff -u phpdoc/en/reference/imagick/imagick/borderimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/borderimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/borderimage.xml:1.4 Wed Jun 20 
22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/borderimage.xml Thu Aug 16 21:55:10 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-borderimage">
  
   Imagick::borderImage
@@ -17,7 +17,7 @@
   &warn.undocumented.func;
   &warn.experimental.func;
   
-   Surrounds the image with a border of the color defined by the bordercolor 
pixel wand.
+   Surrounds the image with a border of the color defined by the bordercolor 
ImagickPixel object.
   
  
 
@@ -29,7 +29,7 @@
  bordercolor
  
   
-   Its description
+   ImagickPixel object containing the border color
   
  
 
@@ -37,7 +37,7 @@
  width
  
   
-   Its description
+   Border width
   
  
 
@@ -45,7 +45,7 @@
  height
  
   
-   Its description
+   Border height
   
  
 

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:52:05 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickblurimage.xml 
  Log:
  Added an example
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/blurimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/blurimage.xml
diff -u phpdoc/en/reference/imagick/imagick/blurimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/blurimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/blurimage.xml:1.4   Wed Jun 20 
22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/blurimage.xml   Thu Aug 16 21:52:04 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-blurimage">
  
   Imagick::blurImage
@@ -93,48 +93,42 @@
  
  -->
 
- 
 
- 
 
 
 

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:50:02 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickblackthresholdimage.xml 
  Log:
  Fixed method description.
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml
diff -u phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml:1.4 Wed Jun 
20 22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/blackthresholdimage.xml Thu Aug 16 
21:50:01 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-blackthresholdimage">
  
   Imagick::blackThresholdImage
@@ -15,7 +15,8 @@
   &warn.undocumented.func;
   &warn.experimental.func;
   
-   Is like MagickThresholdImage() but  forces all pixels below the threshold 
into black while leaving all pixels above the threshold unchanged.
+   Is like Imagick::thresholdImage() but forces all pixels below the threshold 
+   into black while leaving all pixels above the threshold unchanged.
   
  
 

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:45:48 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickannotateimage.xml 
  Log:
  Added an example.
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/annotateimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/annotateimage.xml
diff -u phpdoc/en/reference/imagick/imagick/annotateimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/annotateimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/annotateimage.xml:1.4   Wed Jun 20 
22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/annotateimage.xml   Thu Aug 16 
21:45:47 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-annotateimage">
  
   Imagick::annotateImage
@@ -111,48 +111,58 @@
  
  -->
 
- 
 
- 
 
 
 

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

[Mikko Koppanen]

mkoppanen   Thu Aug 16 21:36:45 2007 UTC

  Modified files:  
/phpdoc/en/reference/imagick/imagickaffinetransformimage.xml 
  Log:
  Changed the parameter name.
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/affinetransformimage.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/imagick/imagick/affinetransformimage.xml
diff -u phpdoc/en/reference/imagick/imagick/affinetransformimage.xml:1.4 
phpdoc/en/reference/imagick/imagick/affinetransformimage.xml:1.5
--- phpdoc/en/reference/imagick/imagick/affinetransformimage.xml:1.4Wed Jun 
20 22:24:41 2007
+++ phpdoc/en/reference/imagick/imagick/affinetransformimage.xmlThu Aug 
16 21:36:45 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.imagick-affinetransformimage">
  
   Imagick::affineTransformImage
@@ -10,12 +10,12 @@
   &reftitle.description;
   
boolImagick::affineTransformImage
-   
ImagickDrawdrawing_wand
+   
ImagickDrawmatrix
   
   &warn.undocumented.func;
   &warn.experimental.func;
   
-   Transforms an image as dictated by the affine matrix of the drawing wand.
+   Transforms an image as dictated by the affine matrix.
   
  
 
@@ -24,10 +24,10 @@
   

 
- drawing_wand
+ matrix
  
   
-   The drawing wand
+   The affine matrix
   
  
 

Re: [PHP-DOC] phpdoc conventions on methods

[Hannes Magnusson]

On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> Another couple of questions:
> 1. What does &reference.module.functions; (functions.xml) collect -
> xml:id or refname?

Neither. functions.xml is autogenerated by configure and referes to
the filepath.


> 2. There's two ways of making external links  and  xlink:href>. Is there a difference? Which one should be used?

 does not exist in DocBook5.
The correct method is  (all external URLs
should be entities and added to phpdoc/entities/global.ent

-Hannes

Re: [PHP-DOC] phpdoc conventions on methods

[Stanislav Malyshev]

Another couple of questions:
1. What does &reference.module.functions; (functions.xml) collect - 
xml:id or refname?
2. There's two ways of making external links  and xlink:href>. Is there a difference? Which one should be used?

--
Stanislav Malyshev, Zend Software Architect
[EMAIL PROTECTED]   http://www.zend.com/
(408)253-8829   MSN: [EMAIL PROTECTED]

Re: [PHP-DOC] phpdoc conventions on methods

[Hannes Magnusson]

On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> >> What if OO and procedural have different names, like Format->getError
> >> and format_get_error?
> >
> > Life sucks :)
> > Depending on the xml:id you can only create a link the OO way or the
> > procedural way.
>
> I see. So then I can't use  for the second way - I should use
>  then or ?

I would go with class::method()
IIRC  uses the first  as the link-text which is
probably the thing you are trying to avoid.

-Hannes

Re: [PHP-DOC] phpdoc conventions on methods

[Stanislav Malyshev]

What if OO and procedural have different names, like Format->getError
and format_get_error?


Life sucks :)
Depending on the xml:id you can only create a link the OO way or the
procedural way.


I see. So then I can't use  for the second way - I should use 
 then or ?


Thanks for your help,
--
Stanislav Malyshev, Zend Software Architect
[EMAIL PROTECTED]   http://www.zend.com/
(408)253-8829   MSN: [EMAIL PROTECTED]

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-get-option.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 19:40:36 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-get-option.xml 
  Log:
  Added example
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-get-option.xml?r1=1.13&r2=1.14&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-get-option.xml
diff -u phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.13 
phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.14
--- phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.13Thu Aug 
16 19:30:16 2007
+++ phpdoc/en/reference/sockets/functions/socket-get-option.xml Thu Aug 16 
19:40:36 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-get-option">
  
   socket_get_option
@@ -247,6 +247,27 @@
   
  
 
+ 
+  &reftitle.examples;
+  
+   
+socket_set_option example
+
+
+
+   
+  
+ 
+
  
   &reftitle.changelog;
   

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-set-option.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 19:36:34 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-set-option.xml 
  Log:
  Added an example and parameter description
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-set-option.xml?r1=1.11&r2=1.12&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-set-option.xml
diff -u phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.11 
phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.12
--- phpdoc/en/reference/sockets/functions/socket-set-option.xml:1.11Wed Jun 
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-set-option.xml Thu Aug 16 
19:36:34 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-set-option">
  
   socket_set_option
@@ -32,6 +32,8 @@
  socket
  
   
+   A valid socket resource created with socket_create
+   or socket_accept.
   
  
 
@@ -77,6 +79,27 @@
   
  
 
+ 
+  &reftitle.examples;
+  
+   
+socket_set_option example
+
+
+
+   
+  
+ 
+
  
   &reftitle.changelog;
   

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-get-option.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 19:30:17 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-get-option.xml 
  Log:
  Documented all options
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-get-option.xml?r1=1.12&r2=1.13&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-get-option.xml
diff -u phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.12 
phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.13
--- phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.12Tue Jul 
 3 19:53:55 2007
+++ phpdoc/en/reference/sockets/functions/socket-get-option.xml Thu Aug 16 
19:30:16 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-get-option">
  
   socket_get_option
@@ -52,11 +52,12 @@
  
   
Available Socket Options
-   
+   
 
  
   Option
   Description
+  Type
  
 
 
@@ -65,11 +66,8 @@
   
Reports whether debugging information is being recorded.
   
- 
- 
-  SO_ACCEPTCONN
   
-   Reports whether socket listening is enabled.
+   int
   
  
  
@@ -77,12 +75,18 @@
   
Reports whether transmission of broadcast messages is supported.
   
+  
+   int
+  
  
  
   SO_REUSEADDR
   
Reports whether local addresses can be reused.
   
+  
+   int
+  
  
  
   SO_KEEPALIVE
@@ -92,11 +96,40 @@
the connection is broken and processes writing to that socket are 
notified
with a SIGPIPE signal.
   
+  
+   int
+  
  
  
   SO_LINGER
   
-   Reports whether the socket lingers on 
socket_close if data is present.
+   
+Reports whether the socket lingers on 
+socket_close if data is present. By default, 
+when the socket is closed, it attempts to send all unsent data.
+In the case of a connection-oriented socket, 
+socket_close will wait for its peer to
+acknowledge the data. 
+   
+   
+If l_onoff is non-zero and 
+l_linger is zero, all the 
+unsent data will be discarded and RST (reset) is sent to the 
+peer in the case of a connection-oriented socket. 
+   
+   
+On the other hand, if l_onoff is 
+non-zero and l_linger is non-zero,
+socket_close will block until all the data 
+is sent or the time specified in 
l_linger
+elapses. If the socket is non-blocking, 
+socket_close will fail and return an error.
+   
+  
+  
+   array. The array will contain two keys:
+   l_onoff and 
+   l_linger. 
   
  
  
@@ -104,29 +137,45 @@
   
Reports whether the socket leaves 
out-of-band data inline.
   
+  
+   int
+  
  
  
   SO_SNDBUF
   
-   Reports send buffer size information.
+   Reports the size of the send buffer.
   
+  
+   int
+
  
  
   SO_RCVBUF
   
-   Reports recieve buffer size information.
+   Reports the size of the receive buffer.
   
+  
+   int
+   
  
  
   SO_ERROR
   
Reports information about error status and clears it.
   
+  
+   int (cannot be set by 
socket_set_option)
+  
  
  
   SO_TYPE
   
-   Reports the socket type.
+   Reports the socket type (e.g. 
+   SOCK_STREAM).
+  
+  
+   int (cannot be set by 
socket_set_option)
   
  
  
@@ -134,12 +183,18 @@
   
Reports whether outgoing messages bypass the standard routing 
facilities.
   
+  
+   int
+  
  
  
   SO_RCVLOWAT
   
-   Reports the minimum number of bytes to process for 
socket input operations.
-   ( Defaults to 1 )
+   Reports the minimum number of bytes to process for 
socket 
+   input operations.
+  
+  
+   int
   
  
  
@@ -147,11 +202,11 @@
   
Reports the timeout value for input operations.
   
- 
- 
-  SO_SNDLOWAT
   
-   Reports the minimum number of bytes to process for 
socket output operations.
+   array. The array will 

Re: [PHP-DOC] Newbie needs help getting started....

[Hannes Magnusson]

On 8/16/07, Al <[EMAIL PROTECTED]> wrote:
> I volunteered to help with documenting an extension still in cvs.

Cool. New blood is always welcomed! :D

> I've loaded and fiddled with XML Copy Editor.  However, it doesn't like
> DocBook's language.  Fusses about errors. I've tried to find a good DocBook
> editor; but, it appears that most of the tools are Linux.  Need a 
> recommendation
> for a Windows DocBook editor.

Thats... weird. Most editors I know of are windows based (with the
exception of vim and emacs of cause).
See; http://www.docbook.org/docs/howto/#editors


> Next, I'd like to be able to see the html results.  Firefox did have DocBook
> add-on; but, it's obsolete for new Firefox versions.  What can I use to view 
> the
> rendered version of my work without making a big deal out of it?

On windows? I don't know. You probably need 'cygwin' and all sorts of
weird tools.
On *nix: ./configure && make part/the-id-you-want-to-see

I.e. if you are editing the strpos() sources, which has the xml:id
"function.strpos":
./configure && make part/function.strpos

Note; you'll need GNU make for the "part/" target to work properly.

-Hannes

Re: [PHP-DOC] phpdoc conventions on methods

[Hannes Magnusson]

On 8/16/07, Stanislav Malyshev <[EMAIL PROTECTED]> wrote:
> > If you wrap it inside a  element then drop the (),
> > otherwise I'd say keep them
>
> When does function tag create link and when it doesn't? I saw sometimes

I recently posted a note on the subject, see
http://news.php.net/php.doc/969377231

 will not create links to the current page.
Example:
 http://docbook...";>
  
  ...
  
foobar is a awesome function!
  

Will generate:
foobar()


 always adds ().


> it does, but I'm pretty sure I saw cases when it doesn't. Generally, if
> I want to link to a function, should I use ,  or ?
> I see most docs use this syntax in reference.xml:


People were randomly using link and xref to link to methods, some used
 but that didn't create any links for methods (in fact, if
it did create a link at all it was to completely wrong file.
HttpMessage:header() for instance was linked to ext/standard
header() :)


> What if I have dual-api function (like mysqli, which has both OO and
> procedural syntax) but single manual entry describing both and I define
> two refnames - like mysqli:
> 
>mysqli_autocommit
>mysqli->autocommit()
>Turns on or off auto-commiting database
> modifications
>   
>
> Would both create right links with  tags (i.e.
> mysqli_autocommit and
> mysqli->autocommit() would link to the page named
> function.mysqli-autocommit.php?)

The filename is created from the xml:id, so if the ID is
function.mysqli-autocommit then yes, both will create link to
function.mysqli-autocommit.
(Well, no. You'll have to remove the (). As I said above, 
will add () automatically :)

If the content of  has "::", "->" or "_" it will be replaced with "-".


> What if OO and procedural have different names, like Format->getError
> and format_get_error?

Life sucks :)
Depending on the xml:id you can only create a link the OO way or the
procedural way.


>
> > We don't have a "official" OO doc-style, what comes closest is the
> > pecl/http docs.
>
> Maybe it's good time to make some? Not that I'm volunteering but right
> now in the manual OO extension doc styles are so different it's outright
> confusing.

We know. Thats why everyone is postponing the SPL docs for instance.

I was going to create OO skeleton this summer, but without an
implementation it is totally useless to create skeletons that cannot
be used.

After PhD has caught up on all the current phpbook features I will
post my suggestion of OO skel with PhD implementation for it.

> > You could send a file, or two, to the list and have people check it
> > out for you...
>
> Thanks, the docs I'm talking about are in
> http://cvs.php.net/viewvc.cgi/pecl/intl/doc/intl/

I don't have the time to check it out at the moment, hopefully someone
else will :]


-Hannes

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-set-block.xml socket-set-nonblock.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 19:00:00 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-set-block.xml 
socket-set-nonblock.xml 
  Log:
  Added better examples and wrote a little explanation on what blocking is
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-set-block.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-set-block.xml
diff -u phpdoc/en/reference/sockets/functions/socket-set-block.xml:1.8 
phpdoc/en/reference/sockets/functions/socket-set-block.xml:1.9
--- phpdoc/en/reference/sockets/functions/socket-set-block.xml:1.8  Wed Jun 
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-set-block.xml  Thu Aug 16 
19:00:00 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-set-block">
  
   socket_set_block
@@ -13,8 +13,14 @@

resourcesocket
   
   
-   The socket_set_block function removes the O_NONBLOCK 
flag
-   on the socket specified by the socket parameter.
+   The socket_set_block function removes the 
+   O_NONBLOCK flag on the socket specified by the 
+   socket parameter.
+  
+  
+   When an operation (e.g. receive, send, connect, accept, ...) is performed 
on 
+   a blocking socket, the script will pause its execution until it receives
+   a signal or it can perform the operation.
   
  
 
@@ -26,6 +32,8 @@
  socket
  
   
+   A valid socket resource created with socket_create
+   or socket_accept.
   
  
 
@@ -44,31 +52,23 @@
   &reftitle.examples;
   

-socket_set_block example
+socket_set_nonblock example
 
 
 
+
+ This example creates a listening socket on all interfaces on port 1223 and
+ sets the socket to O_BLOCK mode. 
+ socket_accept will hang until there is a connection
+ to accept.
+

   
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml?r1=1.11&r2=1.12&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml
diff -u phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml:1.11 
phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml:1.12
--- phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml:1.11  Wed Jun 
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-set-nonblock.xml   Thu Aug 
16 19:00:00 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-set-nonblock">
  
   socket_set_nonblock
@@ -13,8 +13,15 @@

resourcesocket
   
   
-   The socket_set_nonblock function sets the O_NONBLOCK 
flag
-   on the socket specified by the socket parameter.
+   The socket_set_nonblock function sets the 
+   O_NONBLOCK flag on the socket specified by
+   the socket parameter.
+  
+  
+   When an operation (e.g. receive, send, connect, accept, ...) is performed 
on 
+   a non-blocking socket, the script not pause its execution until it receives 
a 
+   signal or it can perform the operation. Rather, if the operation would 
result
+   in a block, the called function will fail.
   
  
 
@@ -26,6 +33,8 @@
  socket
  
   
+   A valid socket resource created with socket_create
+   or socket_accept.
   
  
 
@@ -48,21 +57,19 @@
 
 
 
+
+ This example creates a listening socket on all interfaces on port 1223 and
+ sets the socket to O_NONBLOCK mode. 
+ socket_accept will immediately fail unless there is a
+ pending connection exactly at this moment.
+

   
  

Re: [PHP-DOC] cvs: phd /themes/php phpweb.php

[Hannes Magnusson]

On 8/16/07, Hannes Magnusson <[EMAIL PROTECTED]> wrote:
> bjori   Thu Aug 16 18:36:28 2007 UTC
>
>   Modified files:
> /phd/themes/php phpweb.php
>   Log:
>- Generate the TOC only ones for each chapter
>- Add next/previous links

Note: This fix depends on the patch from
http://news.php.net/php.internals/31583 which will hopefully be
committed into the next PHP release.

-Hannes

[PHP-DOC] cvs: phd /themes/php phpweb.php

[Hannes Magnusson]

bjori   Thu Aug 16 18:36:28 2007 UTC

  Modified files:  
/phd/themes/php phpweb.php 
  Log:
   - Generate the TOC only ones for each chapter
   - Add next/previous links
  
  
http://cvs.php.net/viewvc.cgi/phd/themes/php/phpweb.php?r1=1.5&r2=1.6&diff_format=u
Index: phd/themes/php/phpweb.php
diff -u phd/themes/php/phpweb.php:1.5 phd/themes/php/phpweb.php:1.6
--- phd/themes/php/phpweb.php:1.5   Tue Aug 14 12:04:12 2007
+++ phd/themes/php/phpweb.php   Thu Aug 16 18:36:28 2007
@@ -1,5 +1,5 @@
 ext;
 $parent = PhDHelper::getParent($id);
-foreach(PhDHelper::getChildren($parent) as $k => $v) {
-$toc .= sprintf("array('%s.php', '%s'),\n", $k, 
addslashes(PhDHelper::getDescription($k, false)));
+$filename = $this->ext . DIRECTORY_SEPARATOR . "toc" . 
DIRECTORY_SEPARATOR . $parent . ".inc";
+$up = array();
+$incl = '';
+
+$next = $prev = array(null, null);
+if ($parent && $parent != "ROOT") {
+$siblings = PhDHelper::getChildren($parent);
+/* TODO:
+ *   Maybe this isn't worth it.. but this, in theory, allows you 
+ * to easily add new pages without needing to rebuild the entire 
+ * section.
+ */
+if (!file_exists($filename)) {
+echo "Creating $filename...\n";
+
+foreach($siblings as $sid => $array) {
+$toc[] = array($sid.$ext, empty($array["sdesc"]) ? 
$array["ldesc"] : $array["sdesc"]);
+}
+
+$parents = array();
+$p = $parent;
+while (($p = PhDHelper::getParent($p)) && $p != "ROOT") {
+$parents[] = array($p, PhDHelper::getDescription($p, 
true));
+}
+
+$content = 'getFilename($parent).$ext, 
PhDHelper::getDescription($parent, true));
+
+// {{{ Create the "next" link
+if (!empty($siblings[$id]["children"])) {
+$tmp = reset($siblings[$id]["children"]);
+$next = array($tmp["filename"].$ext, (empty($tmp["ldesc"]) ? 
$tmp["sdesc"] : $tmp["ldesc"]));
+} else {
+// don't overwrite these variables
+$tid = $id;
+$tsiblings = $siblings;
+$tparent = $parent;
+do {
+if (!isset($tsiblings[$tid])) {
+break;
+}
+
+// Seek to $tid
+in_array($tsiblings[$tid], $tsiblings, false, true) or 
die(var_export(debug_backtrace(), true) ."\n$tid\n$tparent"); // This should 
*never* happen
+$tmp = next($tsiblings);
+prev($tsiblings); // Reset the internal pointer to 
previous pos
+if ($tmp) {
+$next = array($tmp["filename"].$ext, 
(empty($tmp["sdesc"]) ? $tmp["ldesc"] : $tmp["sdesc"]));
+break;
+}
+
+// We are the end element in this chapter
+$tgrandpa = PhDHelper::getParent($tparent);
+if (!$tgrandpa || $tgrandpa == "ROOT") {
+// There is no next relative
+break;
+}
+
+$tsiblings  = PhDHelper::getChildren($tgrandpa);
+$tid = $tparent;
+$tparent = $tgrandpa;
+} while(true);
+} // }}}
+
+// {{{ Create the "previous" link
+do {
+if (!isset($siblings[$id])) {
+break;
+}
+
+// Seek to $id
+in_array($siblings[$id], $siblings, false, true);
+$tmp = prev($siblings);
+if ($tmp) {
+while (!empty($tmp["children"])) {
+$tmp = end($tmp["children"]);
+}
+$prev = array($tmp["filename"].$ext, (empty($tmp["sdesc"]) 
? $tmp["ldesc"] : $tmp["sdesc"]));
+break;
+}
+
+$prev = array(PhDHelper::getFilename($parent).$ext, 
PhDHelper::getDescription($parent, false));
+} while(false); // }}}
 }
 
+$setup = array(
+"home" => array('index'.$ext, "PHP Manual"),
+"head" => array("UTF-8", "en"), // FIXME: We should probably check 
the xml:lang on the current chunk and fallback on the roots element lang
+"this" => array($id.$ext, PhDHelper::getDescription($id)),
+"up"   => $up,
+"prev" => $prev,
+"next" => $next,
+);
+$var = var_export($setup, true);
+
 /* Yes. This is scary. I know. */
 return ' array("index.php", "PHP Manual"),
-"head" => array("UTF-8", "en"),
-"this" => array("'.$id.'.php", 
"'.addslashes(PhDHelper::getDe

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-read.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:28:08 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-read.xml 
  Log:
  Added parameter specification
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-read.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-read.xml
diff -u phpdoc/en/reference/sockets/functions/socket-read.xml:1.9 
phpdoc/en/reference/sockets/functions/socket-read.xml:1.10
--- phpdoc/en/reference/sockets/functions/socket-read.xml:1.9   Wed Jun 20 
22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-read.xml   Thu Aug 16 
18:28:08 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.socket-read">
  
   socket_read
@@ -30,6 +30,8 @@
  socket
  
   
+   A valid socket resource created with socket_create
+   or socket_accept.
   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-create-pair.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:27:16 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-create-pair.xml 
  Log:
  Created the see also section
  
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-create-pair.xml?r1=1.18&r2=1.19&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-create-pair.xml
diff -u phpdoc/en/reference/sockets/functions/socket-create-pair.xml:1.18 
phpdoc/en/reference/sockets/functions/socket-create-pair.xml:1.19
--- phpdoc/en/reference/sockets/functions/socket-create-pair.xml:1.18   Tue Jul 
 3 19:38:22 2007
+++ phpdoc/en/reference/sockets/functions/socket-create-pair.xmlThu Aug 
16 18:27:16 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-create-pair">
  
   socket_create_pair
@@ -156,6 +156,19 @@
   
  
 
+ 
+  &reftitle.seealso;
+  
+   
+socket_create
+socket_create_listen
+socket_bind
+socket_listen
+socket_last_error
+socket_strerror
+   
+  
+ 
 
 
 

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-create-listen.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:26:08 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-create-listen.xml 
  Log:
  - Added parameter specification
  - Added socket_create_pair in see also section
  
  
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-create-listen.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-create-listen.xml
diff -u phpdoc/en/reference/sockets/functions/socket-create-listen.xml:1.8 
phpdoc/en/reference/sockets/functions/socket-create-listen.xml:1.9
--- phpdoc/en/reference/sockets/functions/socket-create-listen.xml:1.8  Wed Jun 
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-create-listen.xml  Thu Aug 
16 18:26:08 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-create-listen">
  
   socket_create_listen
@@ -32,6 +32,7 @@
  port
  
   
+   The port on which to listen on all interfaces.
   
  
 
@@ -78,6 +79,7 @@
   

 socket_create
+socket_create_pair
 socket_bind
 socket_listen
 socket_last_error
@@ -85,7 +87,6 @@

   
  
-
 
 
 

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

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:24:24 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-connect.xml 
  Log:
  - Clarified method synopsis
  - Port needs to be specified in socket is AF_INET or AF_INET6
  - IP is quad-dot notation if AF_INET or IPV6 notation if AF_INET6 
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-connect.xml?r1=1.10&r2=1.11&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-connect.xml
diff -u phpdoc/en/reference/sockets/functions/socket-connect.xml:1.10 
phpdoc/en/reference/sockets/functions/socket-connect.xml:1.11
--- phpdoc/en/reference/sockets/functions/socket-connect.xml:1.10   Wed Jun 
20 22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-connect.xmlThu Aug 16 
18:24:24 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-connect">
  
   socket_connect
@@ -15,7 +15,7 @@
intport
   
   
-   Initiates a connection using the socket resource
+   Initiate a connection to address using the socket 
resource
socket, which must be a valid socket
resource created with socket_create.
   
@@ -36,10 +36,12 @@
  address
  
   
-   The address parameter is either an IP address
-   in dotted-quad notation (e.g. 127.0.0.1), if the
-   socket is of the AF_INET family; or the pathname
-   of a Unix domain socket, if the socket family is
+   The address parameter is either an IPv4 address
+   in dotted-quad notation (e.g. 127.0.0.1) if 
+   socket is AF_INET, a valid 
+   IPv6 address (e.g. ::1) if IPv6 support is enabled 
and 
+   socket is AF_INET6
+   or the pathname of a Unix domain socket, if the socket family is
AF_UNIX.
   
  
@@ -48,9 +50,10 @@
  port
  
   
-   The port parameter is only used when connecting
-   to an AF_INET socket, and designates the port on
-   the remote host to which a connection should be made.
+   The port parameter is only used and is mandatory
+   when connecting to an AF_INET or an 
+   AF_INET6 socket, and designates
+   the port on the remote host to which a connection should be made.
   
  
 

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-close.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:22:54 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-close.xml 
  Log:
  Moved the note to method synopsis, like all the other socket functions
  
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-close.xml?r1=1.8&r2=1.9&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-close.xml
diff -u phpdoc/en/reference/sockets/functions/socket-close.xml:1.8 
phpdoc/en/reference/sockets/functions/socket-close.xml:1.9
--- phpdoc/en/reference/sockets/functions/socket-close.xml:1.8  Wed Jun 20 
22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-close.xml  Thu Aug 16 
18:22:54 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.socket-close">
  
   socket_close
@@ -14,7 +14,8 @@
   
   
socket_close closes the socket resource
-   given by socket.
+   given by socket. This function is specific to sockets
+   and cannot be used on any other type of resources.
   
  
 
@@ -25,16 +26,10 @@
 
  socket
  
-  

-socket_close can't be used on PHP file resources
-created with fopen, popen,
-fsockopen, or pfsockopen;
-it is meant for sockets created with 
-socket_create or
-socket_accept.
+A valid socket resource created with socket_create
+or socket_accept.

-  
  
 

[PHP-DOC] cvs: phpdoc /en/reference/sockets/functions socket-accept.xml

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 18:21:58 2007 UTC

  Modified files:  
/phpdoc/en/reference/sockets/functions  socket-accept.xml 
  Log:
  Added parameter specification
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/functions/socket-accept.xml?r1=1.7&r2=1.8&diff_format=u
Index: phpdoc/en/reference/sockets/functions/socket-accept.xml
diff -u phpdoc/en/reference/sockets/functions/socket-accept.xml:1.7 
phpdoc/en/reference/sockets/functions/socket-accept.xml:1.8
--- phpdoc/en/reference/sockets/functions/socket-accept.xml:1.7 Wed Jun 20 
22:25:25 2007
+++ phpdoc/en/reference/sockets/functions/socket-accept.xml Thu Aug 16 
18:21:58 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.socket-accept">
  
   socket_accept
@@ -44,6 +44,7 @@
  socket
  
   
+   A valid socket resource created with socket_create.
   
  
 

[PHP-DOC] Newbie needs help getting started....

[Al]

I volunteered to help with documenting an extension still in cvs.

However, I've spent a day so far just trying to get the tools going.

I know PHP pretty well, develop code using a good Windows based editor and run 
it on Linux shared hosts.


So far, I can use TortoiseCVS to load my sandbox. That's fine.

I've loaded and fiddled with XML Copy Editor.  However, it doesn't like 
DocBook's language.  Fusses about errors. I've tried to find a good DocBook 
editor; but, it appears that most of the tools are Linux.  Need a recommendation 
for a Windows DocBook editor.


Next, I'd like to be able to see the html results.  Firefox did have DocBook 
add-on; but, it's obsolete for new Firefox versions.  What can I use to view the 
rendered version of my work without making a big deal out of it?


Thanks.

Re: [PHP-DOC] phpdoc conventions on methods

[Stanislav Malyshev]

If you wrap it inside a  element then drop the (),
otherwise I'd say keep them


When does function tag create link and when it doesn't? I saw sometimes 
it does, but I'm pretty sure I saw cases when it doesn't. Generally, if 
I want to link to a function, should I use ,  or ? 
I see most docs use this syntax in reference.xml:


 
mysqli - 
construct a new mysqli object

   

Could I replace  with  there?

What if I have dual-api function (like mysqli, which has both OO and 
procedural syntax) but single manual entry describing both and I define 
two refnames - like mysqli:


  mysqli_autocommit
  mysqli->autocommit()
  Turns on or off auto-commiting database 
modifications

 

Would both create right links with  tags (i.e. 
mysqli_autocommit and 
mysqli->autocommit() would link to the page named 
function.mysqli-autocommit.php?)


What if OO and procedural have different names, like Format->getError 
and format_get_error?



We don't have a "official" OO doc-style, what comes closest is the
pecl/http docs.


Maybe it's good time to make some? Not that I'm volunteering but right 
now in the manual OO extension doc styles are so different it's outright 
confusing.



You could send a file, or two, to the list and have people check it
out for you...


Thanks, the docs I'm talking about are in 
http://cvs.php.net/viewvc.cgi/pecl/intl/doc/intl/
They are rather half-baked but they have enough "meat" to figure out 
general structure and I want to have a structure before we add more content.


But I'd also like to have a set of rules, since there's other people 
working on the same docs and in general it's better to understand what's 
going on and not just copy-paste things.

--
Stanislav Malyshev, Zend Software Architect
[EMAIL PROTECTED]   http://www.zend.com/
(408)253-8829   MSN: [EMAIL PROTECTED]

[PHP-DOC] #42012 [Bgs]: section index request

[keith at karsites dot net]

 ID:   42012
 User updated by:  keith at karsites dot net
 Reported By:  keith at karsites dot net
 Status:   Bogus
 Bug Type: Documentation problem
 Operating System: Fedora Core 6
 PHP Version:  Irrelevant
 New Comment:

Thankyou for pointing that out Jakob :-) Is there an online version 
for the PEAR manual as well, in the same or a similar format please? 
If not, is there a bug tracker for the PEAR manual?


Previous Comments:


[2007-08-16 11:46:43] [EMAIL PROTECTED]

Web documentation has link to a section in left column.



[2007-07-16 21:23:43] keith at karsites dot net

Description:

Docs Feature request:

As well as the main index at the front of the manual, please could 
we have an index at the start of each section, similar to the MySQL 
or PostgreSQL manuals?

Eg. when I'm reading about a particular function, say the file() 
function, in the Filesystem section I cannot go directly to the 
start of that section. I have to click on Home at the bottom of the 
page, go to the front of the manual, then find the 'XL Filesystem 
Functions' section, and click on that to get the index page for this 
section.

Could we have a link somewhere prominent on each page in each 
section, that would allow one to return directly to the index page 
of that particular section?

That would make navigating the documentation alot quicker.

TIA

Keith







-- 
Edit this bug report at http://bugs.php.net/?id=42012&edit=1

[PHP-DOC] #42320 [Bgs]: chm file php_manual_nl.chm

[info at tclogic dot nl]

 ID:   42320
 User updated by:  info at tclogic dot nl
 Reported By:  info at tclogic dot nl
 Status:   Bogus
 Bug Type: Documentation problem
 Operating System: vista
 PHP Version:  5.2.3
 New Comment:

I was tring and tring and I discover that the chm file did not work
until I unblock the file.

sorry, it is written in red letter obove the download page, I dir not
notice

Bert-Pieter


Previous Comments:


[2007-08-16 15:49:47] [EMAIL PROTECTED]

Please do not submit the same bug more than once. An existing
bug report already describes this very problem. Even if you feel
that your issue is somewhat different, the resolution is likely
to be the same. 

Thank you for your interest in PHP.

This would be same as bug #42179.



[2007-08-16 13:36:34] [EMAIL PROTECTED]

Reclassified.



[2007-08-16 13:21:01] info at tclogic dot nl

Description:

The chm file does not work, the right panel stays empty.

discription in the right panel

  navigation to webpage was canceled
  
 or
 
 the adress is not valid

please repair this, I downloded it over my old version, so I have no
offline manual anymore

greets
Bert-Pieter






-- 
Edit this bug report at http://bugs.php.net/?id=42320&edit=1

[PHP-DOC] #41960 [Com]: HTML Help file (29 Jul 2007) version of PHP manual has missing information.

[info at tclogic dot nl]

 ID:   41960
 Comment by:   info at tclogic dot nl
 Reported By:  eugenew at starhub dot net dot sg
 Status:   Assigned
 Bug Type: Documentation problem
 Operating System: Microsoft Windows XP SP2
 PHP Version:  Irrelevant
 Assigned To:  nlopess
 New Comment:

for the dutch manual it works neither,
please fixit. it is now older then 2 month

Bert-Pieter Oelen


Previous Comments:


[2007-07-31 17:51:19] eugenew at starhub dot net dot sg

Thanks for the bug fix. However, I downloaded the new version the new
English CHM version of the PHP manual dated 29 Jul 2007. The "This
program cannot display the webpage" error message still appears for
"Zend API", "PHP API", the "Extending PHP 3" section under "Appendixes",
and the "Function Index" page under the "Function Index" section under
"Appendixes".



[2007-07-27 11:22:36] [EMAIL PROTECTED]

the html_xsl target works, so the new chm files should be fine.
Please wait until the files are rebuilt.



[2007-07-11 06:36:44] eugenew at starhub dot net dot sg

Description:

I downloaded the English CHM version of the PHP manual (dated 7 July
2007) from both Singapore mirrors. In each case, the "Table of Contents"
is not shown and is replaced by a "This program cannot display the
webpage" message. The same applies for the "Zend API", "PHP API", "FAQ"
and "Appendixes" sections. The previous release of the HTML help file
version (dated 20 June 2007) did not have such a problem, so it appears
to be a bug in generating the documentation. I note that the previous
release had a filesize of around 7938 KB, but this new release has a
filesize of around 2620 KB.






-- 
Edit this bug report at http://bugs.php.net/?id=41960&edit=1

[PHP-DOC] #42176 [Opn->Csd]: General XSS / CSRF considerations

[vrana]

 ID:   42176
 Updated by:   [EMAIL PROTECTED]
 Reported By:  judas dot iscariote at gmail dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: irrelevant
 PHP Version:  Irrelevant
 New Comment:

In my opinion - don't ever promote insecure code in the documentation.
If you have another opinion, bring the discussion to the mailing list or
phpdoc/rfc. If you know about any other holes, please report or fix
them. Symptoms of this bug are fixed now so it can be closed IMHO.


Previous Comments:


[2007-08-16 12:10:20] [EMAIL PROTECTED]

Still open, this is a general question/consideration that affects the
entire manual.



[2007-08-16 09:57:16] [EMAIL PROTECTED]

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

';
echo htmlspecialchars(print_r($_POST, true));
echo '';
}
?>

Name:  
Email: 
Beer: 

Warthog
Guinness
Stuttgarter
Schwabenbr嵼/option>







[2007-08-02 13:51:25] [EMAIL PROTECTED]

This is a tough question because this type of example is everywhere and
escaping every variable throughout the entire manual gets messy. And do
we know of a method that will work with 100% of all cases? Do we use
filter, htmlspecialchars, or a custom way? No simple answer (that I know
of).

I believe this was briefly discussed once and we decided to simply
leave it, but, it's worth officially discussing and in need of a
creative solution because this is a real problem.

Regardless, the security section (and tutorial) must both contain
sections that talk about this topic so we may refer to them elsewhere.
For example, the following is outdated:

http://php.net/manual/en/security.variables





[2007-08-02 11:36:44] judas dot iscariote at gmail dot com

Description:

the "Example 12.11. More complex form variables"
in

http://php.net/manual/en/language.variables.external.php


contains a security hole.


Reproduce code:
---
says:

echo 'Please try again';




as well print_r($_POST)...

Expected result:

manual teaching good practices always, PHP_SELF escaped as well $_POST
not printed without escaping

Actual result:
--
a how to permit XSS in your code.  





-- 
Edit this bug report at http://bugs.php.net/?id=42176&edit=1

[PHP-DOC] CVS account for a new translator

[Lajos Cseppent]

Hello,

My friend Johnny Gold has decided he would like to start translating the PHP 
Manual to Hungarian: He has just requested a CVS account.

Name: Johnny Gold
E-mail: [EMAIL PROTECTED] depi
Text: Translating documentation to Hungarian - chappy has told me

Could you give him an account as soon as possible, because in these days 
I'll go abroad and I don't know if there will be Internet connection or not, 
and I can't upload his files.

Thank you very much,
Lajos Cseppentõ

[PHP-DOC] #41750 [Opn->Csd]: Object casing docs are outdated/wrong

[vrana]

 ID:   41750
 Updated by:   [EMAIL PROTECTED]
 Reported By:  [EMAIL PROTECTED]
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: *
 PHP Version:  Irrelevant
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.




Previous Comments:


[2007-06-20 21:50:24] [EMAIL PROTECTED]

This is different, the other report doesn't mention the casting page at
all.



[2007-06-20 19:05:03] [EMAIL PROTECTED]

Please do not submit the same bug more than once. An existing
bug report already describes this very problem. Even if you feel
that your issue is somewhat different, the resolution is likely
to be the same. 

Thank you for your interest in PHP.

See bug#37537



[2007-06-20 18:15:52] [EMAIL PROTECTED]

Description:

(20:10:03) Вадим: What objects can be
cast to string, and what will be the result?
(20:10:32) Derick: which PHP version?
(20:10:39) Вадим: PHP-5.2.3
(20:10:49) Derick: only objects which implement __toString() afaik
(20:11:02) Вадим: Despite the PHP manual
saying that the result will allways be "Object", I get a fatal error:
"Object of class C could not be converted to string".
(20:11:16) Derick: the manual is outdated then
(20:11:30) Derick: do you have an url for me where you found this?
(20:11:40) Вадим:
http://www.php.net/manual/en/language.types.string.php#language.types.string.casting
(20:12:12) Вадим: Objects are always
converted to the string "Object". If you would like to print out the
member variable values of an object for debugging reasons, read the
paragraphs below. If you would like to find out the class name of which
an object is an instance of, use get_class(). As of PHP 5, __toString()
method is used if applicable.
(20:12:19) Derick: right, the last line explains it
(20:12:23) Derick: but it's not enough
(20:12:49) Вадим: it doesn't say that
objects that do not implement __toString() cannot be cast.
(20:12:52) Derick: right
(20:12:59) Derick: which is true for php 5.0 and 5.1
(20:13:24) Derick: i will file a doc bug
(20:13:46) Вадим: aha. and why PHP 5.1.x
returns "[Object id #1]" and not "Object" ?
(20:14:03) Derick: afaik it never returned just "Object"
(20:14:07) Derick: perhaps in PHP 4
(20:14:14) Вадим: but this is what the
doc says..






-- 
Edit this bug report at http://bugs.php.net/?id=41750&edit=1

[PHP-DOC] #42320 [Opn->Bgs]: chm file php_manual_nl.chm

[vrana]

 ID:   42320
 Updated by:   [EMAIL PROTECTED]
 Reported By:  info at tclogic dot nl
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: vista
 PHP Version:  5.2.3
 New Comment:

Please do not submit the same bug more than once. An existing
bug report already describes this very problem. Even if you feel
that your issue is somewhat different, the resolution is likely
to be the same. 

Thank you for your interest in PHP.

This would be same as bug #42179.


Previous Comments:


[2007-08-16 13:36:34] [EMAIL PROTECTED]

Reclassified.



[2007-08-16 13:21:01] info at tclogic dot nl

Description:

The chm file does not work, the right panel stays empty.

discription in the right panel

  navigation to webpage was canceled
  
 or
 
 the adress is not valid

please repair this, I downloded it over my old version, so I have no
offline manual anymore

greets
Bert-Pieter






-- 
Edit this bug report at http://bugs.php.net/?id=42320&edit=1

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

[Jakub Vrana]

vrana   Thu Aug 16 15:48:12 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   clearstatcache.xml 
  Log:
  Grammar
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/clearstatcache.xml?r1=1.12&r2=1.13&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/clearstatcache.xml
diff -u phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.12 
phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.13
--- phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.12Thu Aug 
16 14:04:11 2007
+++ phpdoc/en/reference/filesystem/functions/clearstatcache.xml Thu Aug 16 
15:48:12 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.clearstatcache">
  
   clearstatcache
@@ -29,7 +29,7 @@
files. So, if you call file_exists on a file that
doesn't exist, it will return &false; until you create the file. If you
create the file, it will return &true; even if you then delete the file.
-   However unlink clears cache automatically.
+   However unlink clears the cache automatically.
   
   

Re: [PHP-DOC] cvs: phpdoc /en/reference/misc/functions eval.xml

[Jakub Vrana]

Ford, Mike wrote:
> There's a couple of grammatical errors in there, and the style could be
> improved some;

Thanks for spotting, feel free to fix my Engrish :-).

Jakub Vrana

RE: [PHP-DOC] cvs: phpdoc /en/reference/misc/functions eval.xml

[Ford, Mike]

On 16 August 2007 14:10, Jakub Vrana wrote:

> vrana Thu Aug 16 13:10:28 2007 UTC
> 
>   Modified files:
> /phpdoc/en/reference/misc/functions   eval.xml
>   Log:
>   Parse error (bug #41890)
 
>  In case of a
> parse error in the evaluated code,
> eval returns
> -   &false;.
> +   &false;. Normal code continues in execution after parse error in
> +   eval and this error can not be catched by
> +   set_error_handler.

There's a couple of grammatical errors in there, and the style could be
improved some; I suggest rewriting the whole of the last two sentences
like this:

 If there is a
   parse error in the evaluated code, eval returns
   &false; and execution of the following code continues normally. It is
   not possible to catch a parse error in eval
   using set_error_handler.


Cheers!

Mike


Mike Ford,  Electronic Information Services Adviser,
JG125, The Headingley Library
James Graham Building, Headingley Campus
Tel: extn 24730Fax: extn 23211 


To view the terms under which this email is distributed, please go to 
http://disclaimer.leedsmet.ac.uk/email.htm

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

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 14:58:11 2007 UTC

  Modified files:  
/phpdoc/en/reference/socketsconstants.xml 
  Log:
  Revert, old change in local file already committed by Jakub
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/constants.xml?r1=1.6&r2=1.7&diff_format=u
Index: phpdoc/en/reference/sockets/constants.xml
diff -u phpdoc/en/reference/sockets/constants.xml:1.6 
phpdoc/en/reference/sockets/constants.xml:1.7
--- phpdoc/en/reference/sockets/constants.xml:1.6   Thu Aug 16 14:55:09 2007
+++ phpdoc/en/reference/sockets/constants.xml   Thu Aug 16 14:58:11 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  &reftitle.constants;
  &extension.constants;
@@ -94,28 +94,6 @@
   
   

-MSG_EOF 
-(integer)
-   
-   
-
- 
-
-   
-  
-  
-   
-MSG_EOR 
-(integer)
-   
-   
-
- 
-
-   
-  
-  
-   
 MSG_OOB 
 (integer)

[PHP-DOC] cvs: phpdoc /en/features file-upload.xml

[Jakub Vrana]

vrana   Thu Aug 16 14:57:40 2007 UTC

  Modified files:  
/phpdoc/en/features file-upload.xml 
  Log:
  H in Virtualhost
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/features/file-upload.xml?r1=1.91&r2=1.92&diff_format=u
Index: phpdoc/en/features/file-upload.xml
diff -u phpdoc/en/features/file-upload.xml:1.91 
phpdoc/en/features/file-upload.xml:1.92
--- phpdoc/en/features/file-upload.xml:1.91 Wed Jun 20 22:24:10 2007
+++ phpdoc/en/features/file-upload.xml  Thu Aug 16 14:57:40 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Handling file uploads
 
@@ -490,7 +490,7 @@
 this with the Script directive.  It can be
 placed almost anywhere in your Apache configuration file.  A
 common place is inside a  block or perhaps inside
-a  block.  A line like this would do the trick:
+a  block.  A line like this would do the trick:
 
  
 

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

[Nicolas Bérard-Nault]

nicobn  Thu Aug 16 14:55:09 2007 UTC

  Modified files:  
/phpdoc/en/reference/socketsconstants.xml 
  Log:
  Added the two missing constants to constants.xml (MSG_EOF and MSG_EOR)
  
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sockets/constants.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/sockets/constants.xml
diff -u phpdoc/en/reference/sockets/constants.xml:1.5 
phpdoc/en/reference/sockets/constants.xml:1.6
--- phpdoc/en/reference/sockets/constants.xml:1.5   Thu Aug 16 13:08:29 2007
+++ phpdoc/en/reference/sockets/constants.xml   Thu Aug 16 14:55:09 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook";>
  &reftitle.constants;
  &extension.constants;
@@ -94,6 +94,28 @@
   
   

+MSG_EOF 
+(integer)
+   
+   
+
+ 
+
+   
+  
+  
+   
+MSG_EOR 
+(integer)
+   
+   
+
+ 
+
+   
+  
+  
+   
 MSG_OOB 
 (integer)

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

[Jakub Vrana]

vrana   Thu Aug 16 14:04:11 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   clearstatcache.xml 
  Log:
  unlink clears cache (bug #41755)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/clearstatcache.xml?r1=1.11&r2=1.12&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/clearstatcache.xml
diff -u phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.11 
phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.12
--- phpdoc/en/reference/filesystem/functions/clearstatcache.xml:1.11Sun Jul 
 1 21:31:16 2007
+++ phpdoc/en/reference/filesystem/functions/clearstatcache.xml Thu Aug 16 
14:04:11 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; 
xml:id="function.clearstatcache">
  
   clearstatcache
@@ -29,6 +29,7 @@
files. So, if you call file_exists on a file that
doesn't exist, it will return &false; until you create the file. If you
create the file, it will return &true; even if you then delete the file.
+   However unlink clears cache automatically.
   
   

[PHP-DOC] #41729 [Opn->Bgs]: Cap.12 Variables - Basic

[vrana]

 ID:   41729
 Updated by:   [EMAIL PROTECTED]
 Reported By:  degaulle13 at virgilio dot it
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: Windows XP Pro SP2
 PHP Version:  Irrelevant
 New Comment:

The code is wrong even if it issues only E_NOTICE.


Previous Comments:


[2007-06-18 15:06:53] degaulle13 at virgilio dot it

Description:

I am an Italian, excused for errors in the translation.

In the Documentation -> Cap.12 Variables -> Basic is written: 

"One important thing to note is that only named variables may be
assigned by reference."

  

But to me, this code works. In fact, if I insert the row
"error_reporting(E_ALL);" they give to a Notice but not an error to me.

Output:
Notice: Only variables should be assigned by reference in
C:\www\index.php on line 9
25 

Hello.



Reproduce code:
---
  


Expected result:

Parse Error

Actual result:
--
Notice: Only variables should be assigned by reference in
C:\www\index.php on line 9
25 






-- 
Edit this bug report at http://bugs.php.net/?id=41729&edit=1

[PHP-DOC] #41739 [Opn->Bgs]: Escaped backslash in PCRE regex documentation

[vrana]

 ID:   41739
 Updated by:   [EMAIL PROTECTED]
 Reported By:  trex0003 at umn dot edu
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: CentOS
 PHP Version:  Irrelevant
 New Comment:

\ character
\\ PCRE representation of this character
'' PHP string to write this representation.



Previous Comments:


[2007-06-19 17:34:33] trex0003 at umn dot edu

Description:

Documentation of how PCRE regex behaves with escaped backslashes is
confusing as written in current documentation:

http://php.planetmirror.com/manual/en/reference.pcre.pattern.syntax.php

Perhaps this just means an expansion of the note:

"Note:  Single and double quoted PHP strings have special meaning of
backslash. Thus if \ has to be matched with a regular expression \\,
then "" or '' must be used in PHP code."

While trying to use preg_split to break a string at non-escaped string
quotes, I tried using a negative lookbehind assertion (see code below).
With all other escaped characters in the lookbehind assertion, you only
need one backwards slash before the escaped character (e.g., "(?http://bugs.php.net/bug.php?id=22315

...but this only implies the difference in behavior without explaining
why.

Reproduce code:
---
$string = "This sentence is not quoted. 'But this one is, and it
contains \'escaped quotes\' within!'";

$needle = "/(? This sentence is not quoted. 
[1] => But this one is, and it contains \'escaped quotes\' within!
[2] => 
)

// Adding a third backslash to the $needle gives this result.

Actual result:
--
Warning: preg_split() [function.preg-split]: Compilation failed:
missing ) at offset 7 in
/data/domains/lawweb3.law.umn.edu/public/php/regex.php on line 16





-- 
Edit this bug report at http://bugs.php.net/?id=41739&edit=1

[PHP-DOC] cvs: phpdoc /en/language types.xml

[Jakub Vrana]

vrana   Thu Aug 16 14:17:15 2007 UTC

  Modified files:  
/phpdoc/en/language types.xml 
  Log:
  Objects cast to Object only in PHP 4 (bug #41750)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/types.xml?r1=1.182&r2=1.183&diff_format=u
Index: phpdoc/en/language/types.xml
diff -u phpdoc/en/language/types.xml:1.182 phpdoc/en/language/types.xml:1.183
--- phpdoc/en/language/types.xml:1.182  Mon Jun 25 17:59:35 2007
+++ phpdoc/en/language/types.xmlThu Aug 16 14:17:15 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Types
 
@@ -1215,7 +1215,7 @@
  entire contents.
 
 
- Objects are always converted to the string "Object".
+ Objects in PHP 4 are always converted to the string 
"Object".
  If you would like to print out the member variable values of an 
  object for debugging reasons, read the paragraphs 
  below. If you would like to find out the class name of which an object 

[PHP-DOC] cvs: phpdoc /en/language/oop5 magic.xml

[Jakub Vrana]

vrana   Thu Aug 16 14:16:21 2007 UTC

  Modified files:  
/phpdoc/en/language/oop5magic.xml 
  Log:
  Converting objects without __toString() since PHP 5.2.0
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/oop5/magic.xml?r1=1.16&r2=1.17&diff_format=u
Index: phpdoc/en/language/oop5/magic.xml
diff -u phpdoc/en/language/oop5/magic.xml:1.16 
phpdoc/en/language/oop5/magic.xml:1.17
--- phpdoc/en/language/oop5/magic.xml:1.16  Fri Jul 13 17:56:19 2007
+++ phpdoc/en/language/oop5/magic.xml   Thu Aug 16 14:16:20 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Magic Methods
   
@@ -143,6 +143,8 @@
 It is worth noting that before PHP 5.2.0 the __toString
 method was only called when it was directly combined with
 echo or print.
+Since PHP 5.2.0, converting objects without __toString
+method to string would cause E_RECOVERABLE_ERROR.

   
 

[PHP-DOC] #41754 [Opn->Csd]: copy() function returns true for copying an empty file on windows.

[vrana]

 ID:   41754
 Updated by:   [EMAIL PROTECTED]
 Reported By:  nikhil dot gupta at in dot ibm dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Windows
 PHP Version:  5CVS-2007-06-21 (snap)
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.




Previous Comments:


[2007-06-21 08:06:29] nikhil dot gupta at in dot ibm dot com

Description:

When copy()  function is used to make a copy of an empty file on
Windows, it returns "true".But according to the documentation : 

"Note: Windows compatibility: If you copy a file with no size, copy()
will return FALSE, but the file will be correctly copied."

but it outputs true on Windows as well as Linux on both php5 and php6.
This behaviour is contradictory to that mentioned in documentation. It
may require change in documentation.




Reproduce code:
---


Expected result:

bool(false)

Actual result:
--
bool(true)





-- 
Edit this bug report at http://bugs.php.net/?id=41754&edit=1

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

[Jakub Vrana]

vrana   Thu Aug 16 14:08:22 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   copy.xml 
  Log:
  Doesn't return false for empty file (bug 41754)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/copy.xml?r1=1.16&r2=1.17&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/copy.xml
diff -u phpdoc/en/reference/filesystem/functions/copy.xml:1.16 
phpdoc/en/reference/filesystem/functions/copy.xml:1.17
--- phpdoc/en/reference/filesystem/functions/copy.xml:1.16  Wed Jun 20 
22:24:27 2007
+++ phpdoc/en/reference/filesystem/functions/copy.xml   Thu Aug 16 14:08:22 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.copy">
  
   copy
@@ -107,17 +107,6 @@
   
  
 
- 
-  &reftitle.notes;
-  
-   
-Windows compatibility: If you copy a file with no size,
-copy will return &false;, but the file will be
-correctly copied.
-   
-  
- 
-
  
   &reftitle.seealso;
   

[PHP-DOC] #41763 [Opn->Bgs]: fopen() documentation for append mode needs more clarity

[vrana]

 ID:   41763
 Updated by:   [EMAIL PROTECTED]
 Reported By:  kraghuba at in dot ibm dot com
-Status:   Open
+Status:   Bogus
 Bug Type: Documentation problem
 Operating System: linux, windows
 PHP Version:  Irrelevant
 New Comment:

fopen(, "a") works as described but ftell() tells offset since
opening:

outputs e.g. 5 0 1.


Previous Comments:


[2007-06-21 12:54:29] kraghuba at in dot ibm dot com

Description:

The current documentation of fopen for append mode doesn't state
clearly where the file pointer is set initally. The doc says :
"In a mode : Open for writing only; place the file pointer at the end
of the file. If the file does not exist, attempt to create it.".

But in reality the file pointer is set to 0, the file position is moved
to end of file before any write operation.

Please modify the document to make this clear. 

I also noticed that in response to following defect this was explained
: "Bug #15528: ftell does not work consistently"


Reproduce code:
---



Expected result:

C:\workdir\test>php fopen.php
resource(5) of type (stream)
int(0)

Actual result:
--
C:\workdir\test>php fopen.php
resource(5) of type (stream)
int(0)





-- 
Edit this bug report at http://bugs.php.net/?id=41763&edit=1

[PHP-DOC] #41769 [Opn->Csd]: flock() ignores third argument $wouldblock

[vrana]

 ID:   41769
 Updated by:   [EMAIL PROTECTED]
 Reported By:  commander at graphicore dot de
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: WinXP
 PHP Version:  4.4.7
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.

"LOCK_NB not supported on Windows"


Previous Comments:


[2007-06-25 17:56:19] [EMAIL PROTECTED]

Seems to be docu problem, reclassified as such.



[2007-06-21 18:52:55] commander at graphicore dot de

Little typo:
with "LOCK_EX + LOCK_NB" OR "LOCK_SH + LOCK_NB"



[2007-06-21 18:23:02] commander at graphicore dot de

Description:

Different behaviors of flock between WinXp and Linux(and FreeBSD) if
you use the optional third Argument ($wouldblock) with "LOCK_EX +
LOCK_NB" OR "LOCK_EX + LOCK_NB"

If this is no bug please correct the documentation.

Versions of PHP tested
Win:
PHP 4.4.4
PHP 4.4.7
PHP 5.1.6
PHP 5.2.2
(all Windows versions do the same)

Linux
PHP 4.4.4
FreeBSD
PHP 4.4.6
(both Linux and FreeBSD do the same)


Reproduce code:
---
';

$handle = fopen('test.txt','ab');
if($handle){
$wouldblock = NULL;
$flock = flock($handle,LOCK_EX + LOCK_NB,$wouldblock);
echo '$flock '; var_dump($flock);echo '';
echo '$woulblock '; var_dump($wouldblock);echo '';
if(!$flock){
echo 'no lock for me';
}else{
echo 'got a lock';
fwrite( $handle, ' start '.$date.' ' );
sleep(5); //assume the whole writing process takes 5 seconds
fwrite( $handle, ' end '.$date."\n" );
}
fclose($handle);
}
echo 'end: this took '.(time()-$starttime).' secconds';
?>

Expected result:

Linux will if the file is locked set $wouldblock to int(1) and always
return TRUE.

Output Linux (and FreeBSD):
###first process:
start:06:05:09
$flock bool(true)
$woulblock int(0)
got a lock
end: this took 5 secconds

###seccond Process:
start:06:05:11
$flock bool(true) 
$woulblock int(1) 
got a lock
end: this took 5 secconds

###test.txt
 start 06:05:09  start 06:05:11  end 06:05:09
 end 06:05:11

Actual result:
--
Windows will set $wouldblock always to int(0) and if the file is locked
return FALSE.

Output WinXp:
###first process:
start:06:09:22
$flock bool(true) 
$woulblock int(0) 
got a lock
end: this took 5 secconds

###seccond Process:
start:06:09:24
$flock bool(false)
$woulblock int(0)
no lock for me
end: this took 0 secconds

###test.txt
 start 06:09:22  end 06:09:22





-- 
Edit this bug report at http://bugs.php.net/?id=41769&edit=1

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

[Jakub Vrana]

vrana   Thu Aug 16 13:46:21 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   flock.xml 
  Log:
  LOCK_NB not supported on Windows (bug #41769)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/flock.xml?r1=1.16&r2=1.17&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/flock.xml
diff -u phpdoc/en/reference/filesystem/functions/flock.xml:1.16 
phpdoc/en/reference/filesystem/functions/flock.xml:1.17
--- phpdoc/en/reference/filesystem/functions/flock.xml:1.16 Thu Aug 16 
13:39:01 2007
+++ phpdoc/en/reference/filesystem/functions/flock.xml  Thu Aug 16 13:46:21 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.flock">
  
   flock
@@ -67,6 +67,7 @@
  
   LOCK_NB if you don't want
   flock to block while locking.
+  (not supported on Windows)
  
 

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

[Jakub Vrana]

vrana   Thu Aug 16 13:39:01 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   flock.xml 
  Log:
  Mandatory lock under Windows
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/flock.xml?r1=1.15&r2=1.16&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/flock.xml
diff -u phpdoc/en/reference/filesystem/functions/flock.xml:1.15 
phpdoc/en/reference/filesystem/functions/flock.xml:1.16
--- phpdoc/en/reference/filesystem/functions/flock.xml:1.15 Sun Jul  1 
21:31:16 2007
+++ phpdoc/en/reference/filesystem/functions/flock.xml  Thu Aug 16 13:39:01 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.flock">
  
   flock
@@ -151,7 +151,7 @@
   &reftitle.notes;
   

-flock is mandatory under Windows.
+flock locks mandatory under Windows.

   
   

[PHP-DOC] #42320 [Opn]: chm file php_manual_nl.chm

[jani]

 ID:   42320
 Updated by:   [EMAIL PROTECTED]
 Reported By:  info at tclogic dot nl
 Status:   Open
-Bug Type: *Compile Issues
+Bug Type: Documentation problem
 Operating System: vista
 PHP Version:  5.2.3
 New Comment:

Reclassified.


Previous Comments:


[2007-08-16 13:21:01] info at tclogic dot nl

Description:

The chm file does not work, the right panel stays empty.

discription in the right panel

  navigation to webpage was canceled
  
 or
 
 the adress is not valid

please repair this, I downloded it over my old version, so I have no
offline manual anymore

greets
Bert-Pieter






-- 
Edit this bug report at http://bugs.php.net/?id=42320&edit=1

[PHP-DOC] #41798 [Opn->Csd]: stat() gives -1 for value of [blocks] on windows for a valid input file.

[vrana]

 ID:   41798
 Updated by:   [EMAIL PROTECTED]
 Reported By:  nikhil dot gupta at in dot ibm dot com
-Status:   Open
+Status:   Closed
 Bug Type: Documentation problem
 Operating System: Windows
 PHP Version:  5CVS-2007-06-25 (snap)
 New Comment:

This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.

Thank you for the report, and for helping us make our documentation
better.




Previous Comments:


[2007-06-25 17:45:51] [EMAIL PROTECTED]

Reclassified as docu issue.



[2007-06-25 11:15:46] nikhil dot gupta at in dot ibm dot com

Description:

Using stat() function on a valid file on Windows operating system ,
gives -1 for [blocks] member of the  array returned by stat() function.
On linux it outputs proper value.

In the documentation, it is mentioned that [rdev] and [blksize] members
of the array returned by stat() function will output -1 on Windows
operating function. I doubt, whether same will be applicable for
[blocks] also?

If yes, then documentation might need the change.

Reproduce code:
---


Expected result:

int(%d)
int(%d)

Actual result:
--
int(-1)
int(-1)





-- 
Edit this bug report at http://bugs.php.net/?id=41798&edit=1

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

[Jakub Vrana]

vrana   Thu Aug 16 13:32:51 2007 UTC

  Modified files:  
/phpdoc/en/reference/filesystem/functions   stat.xml 
  Log:
  'blocks' not available on Windows (bug #41798)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filesystem/functions/stat.xml?r1=1.16&r2=1.17&diff_format=u
Index: phpdoc/en/reference/filesystem/functions/stat.xml
diff -u phpdoc/en/reference/filesystem/functions/stat.xml:1.16 
phpdoc/en/reference/filesystem/functions/stat.xml:1.17
--- phpdoc/en/reference/filesystem/functions/stat.xml:1.16  Wed Jun 20 
22:24:28 2007
+++ phpdoc/en/reference/filesystem/functions/stat.xml   Thu Aug 16 13:32:51 2007
@@ -1,5 +1,5 @@
 
-
+
 http://docbook.org/ns/docbook"; xml:id="function.stat">
  
   stat
@@ -117,7 +117,7 @@
   
12
blocks
-   number of blocks allocated
+   number of blocks allocated *
   
  
 

[PHP-DOC] cvs: phpdoc /en/language operators.xml

[Jakub Vrana]

vrana   Thu Aug 16 13:30:51 2007 UTC

  Modified files:  
/phpdoc/en/language operators.xml 
  Log:
  Modulus uses integers (bug #41802)
  
http://cvs.php.net/viewvc.cgi/phpdoc/en/language/operators.xml?r1=1.115&r2=1.116&diff_format=u
Index: phpdoc/en/language/operators.xml
diff -u phpdoc/en/language/operators.xml:1.115 
phpdoc/en/language/operators.xml:1.116
--- phpdoc/en/language/operators.xml:1.115  Wed Jun 20 22:24:12 2007
+++ phpdoc/en/language/operators.xmlThu Aug 16 13:30:51 2007
@@ -1,5 +1,5 @@
 
-
+
  http://docbook.org/ns/docbook";>
   Operators
   
@@ -293,6 +293,10 @@
 are integers (or strings that get converted to integers) and the numbers
 are evenly divisible, in which case an integer value will be returned.

+   
+Operands of modulus are converted to integers (by stripping the decimal
+part) before processing.
+   

 
  Remainder $a % $b is negative for negative