Outdated Docs on php.net/amqp about php-amqp HOT 40 CLOSED

That is unfortunately all still in SVN. I don't know of they have migrated
or have plans to migrate. I'll look into, though anyone wih PHP cress
should have karma to make updates.

On Sunday, November 11, 2012, Bernhard Weißhuhn wrote:

The documentation on php.net is out of date and misleading at times. How
does the process of updating it work? Anything we can do to help?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17.

from php-amqp.

No plans on the core side so far (we would need someone to lead that effort).

from php-amqp.

brain dump of issues with the current documentation:

• renamed methods AMQPQueue::declare to declareQueue and AMQPExchange::declare to declareExchange
• renamed constants
• some method signatures list wrong types
• some flags do not work as expected (IMMEDIATE, MANDATORY)
• the callback to consume() must return TRUE, not FALSE to proceed
• added timeouts
• added consumerTags
• support for CC-arrays of routing keys
• point to ongoing effort at alanxz/rabbitmq-c#11 for up-to-date librabbitmq packages
• mention the new home at github

from php-amqp.

AMQP_REQUEUE for AMQPQueue::nack needs documenting

from php-amqp.

AMQPQueue#bind and #unbind do not require a routing key anymore (since #32)

from php-amqp.

new constant AMQP_OS_SOCKET_TIMEOUT_ERRNO

from php-amqp.

Could the documentation be provided in some form on a third party site? If so I'd be glad to offer hosting for it, I do have a pretty decent VPS until the issue with php.net documentation account gets fixed.

from php-amqp.

Thanks for the offer, but I'd prefer Markdown in the Readme.md right here on github. You're right, we shouldn't wait any longer for the stupid bureaucracy of php.net. Unfortunately right now, I'm pretty busy with $realJob, any volunteering would be super appreciated.

from php-amqp.

I just found https://github.com/dlsniper/phpamqp-doc . Sweet! Maybe we can work on top of that?

from php-amqp.

I started a similar project to provide stubs of the methods for IDE autocompletion and type checks. It doesn't have the nice docs you added, though.

from php-amqp.

Yes, clearly.
I'll try and get thru the library right now, I'll check against 1.0.9 in order to have the current state of things but I'm not sure my C skills are enough to read the extension properly. I'm working on that in order to provide auto-complete support for PhpStorm and/or any other IDE that could benefit from it.

I'll try and setup a documentation node on my computer, get the docs with doxygen or phpDocumentator and publish them at some address later on, maybe by the end of this week.

Thanks for the hard work you've done so far!

from php-amqp.

I have the same stub with full coverage of extension interface but it is not fully documented. If you want I can create PR.

from php-amqp.

That would be great! Thanks!

from php-amqp.

seems we did the same :-) Check https://github.com/bkw/pecl-amqp-official/tree/master/stubs to see if you can copy some of the stuff I already did.

from php-amqp.

Well, If you have the stubs maintained and updated then I'll just ask the JetBrain guys to use yours. I didn't even knew about them :(
If you want me to make a PR for something outdated then I could have a look on the stubs vs the lib.

from php-amqp.

we should just merge them into master, keep them current and tell JetBrain, yes.

from php-amqp.

@bkw 👍 for merging your stubs into the master.

from php-amqp.

PR: #33
I'll give the other maintainers a moment to comment, otherwise I'll merge this.

from php-amqp.

Ill work on these in SVN now.

On Fri, Nov 16, 2012 at 9:08 AM, Bernhard Weißhuhn <[email protected]

wrote:

AMQP_REQUEUE for AMQPQueue::nack needs documenting

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-10454080.

from php-amqp.

I went through what I consider the most important updates on https://github.com/pdezwart/php-amqp-docs .
This could need some more eyes. I could not for the love of god get phd to pickup any of my changes.

from php-amqp.

Don't worry about phd, I will handle hat portion. Just make your updates
and try and keep them as clean as possible :)

On Tuesday, December 4, 2012, Bernhard Weißhuhn wrote:

I went through what I consider the most important updates on
https://github.com/pdezwart/php-amqp-docs .
This could need some more eyes. I could not for the love of god get phd to
pickup any of my changes.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-11004752.

from php-amqp.

Puh, DocBook. I’m sorry but I pass on this one.

from php-amqp.

Damn Lars, I was counting on You with this one, I thought You were the php "official" around here ;-)

from php-amqp.

I committed the changes to SVN. This will be updated in the live manual on
Friday.

On Tue, Dec 4, 2012 at 4:38 PM, Bernhard Weißhuhn
[email protected]:

Damn Lars, I was counting on You with this one, I thought You were the php
"official" around here ;-)

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-11022598.

from php-amqp.

Awesome, thanks, @pdezwart !

from php-amqp.

I missed one occurrence of AMQP_NOACK (renamed to AMQP_AUTOACK). Just committed in pdezwart/php-amqp-docs@d5598fd

from php-amqp.

The changes don't seem to have made it to php.net just yet. @pdezwart , are you certain you pushed them all?

from php-amqp.

I have a record of committing them:

r328670 | pdezwart | 2012-12-04 20:31:42 -0800 (Tue, 04 Dec 2012) | 4 lines
Changed paths:
M /phpdoc/en/trunk/reference/amqp/amqpconnection/getport.xml
A /phpdoc/en/trunk/reference/amqp/amqpconnection/gettimeout.xml
A /phpdoc/en/trunk/reference/amqp/amqpconnection/settimeout.xml
D /phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml
A /phpdoc/en/trunk/reference/amqp/amqpexchange/declareexchange.xml (from
/phpdoc/en/trunk/reference/amqp/amqpexchange/declare.xml:328606)
D /phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml
A /phpdoc/en/trunk/reference/amqp/amqpqueue/declarequeue.xml (from
/phpdoc/en/trunk/reference/amqp/amqpqueue/declare.xml:328606)

Updating AMQP documentation

• Replacing deprecated declare functions
• Adding missing timeouts

I have no idea what is going on. Ill reach out.

On Mon, Dec 10, 2012 at 4:32 AM, Bernhard Weißhuhn <[email protected]

wrote:

The changes don't seem to have made it to php.net just yet. @pdezwarthttps://github.com/pdezwart, are you certain you pushed them all?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/17#issuecomment-11191461.

from php-amqp.

Documentation on official site is still outdated comparing to latest stable version of extension, can someone take care of this?

from php-amqp.

Could someone point me (and any other readers) to the currently maintained documentation for this extension, if it exists?

from php-amqp.

Look into stubs, they has the most accurate method comments after original C sources.

from php-amqp.

I put the stubs documentation rendered by phpDocumentor in this address. If this is a bad thing please let me know.

from php-amqp.

JFYI: php-amqp documentation removed from http://php.net site.

from php-amqp.

public function bind($exchange_name, $routing_key = null, array $arguments = array()) is out of date.

The notice occur: "Warning: AMQPQueue::bind() expects at most 2 parameters" when I write code like
"$queue->bind($exchange->getName(), '', array('test' => 'test')); ",

from php-amqp.

Could you check the stub again? By the way I think that the documentation is really too hard to understand. Many people don't want to use if it have not any documentation.

from php-amqp.

Documentation only seems to be on the Polish PHP docs: http://www.php.net/manual/pl/book.amqp.php

Is there anything we can do to get the up to date, English version of the docs on php.net?

from php-amqp.

@pdezwart could you put the docs in the PHP SVN again ? They are not in http://svn.php.net/viewvc/phpdoc/en/trunk/reference/

from php-amqp.

I want to read English version of the docs on php.net too.

from php-amqp.

+1 on having English documentation

from php-amqp.

Docs was removed from php.net website while they are out of sync and pretty outdated. For now, stubs are the only reliable documentation (as well as tests). I really sorry that we don't have any docs.

I hope we'll get good docs and examples for next major release.

from php-amqp.