Couchbase PHP client library

new() function docs is missing the $bucket parameter:

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: 1.1.0
  • Component/s: docs
  • Security Level: Public
  • Labels:
    None
  • Environment:
    Couchbase lib 1.0.4

Description

These docs are incorrect: http://www.couchbase.com/docs/couchbase-sdk-php-1.0/api-reference-summary.html

It says: "$object->new Couchbase($url, $username, $password [, $persistent ])"

It should say

Issue Links

is duplicated by

Bug - A problem which impairs or prevents the functions of the product. PCBC-94 new() function docs is missing the $bucket parameter:

  • Major - Major loss of function.
  • Resolved - A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Tim Smith added a comment -
Sorry, it got submitted accidentally. It should say:

$object->new Couchbase($url [ , $username, $password, $bucket, $persistent ])

That is, all the parameters are optional after $url. And the $bucket parameter is missing in the current docs.

Show
Tim Smith added a comment - Sorry, it got submitted accidentally. It should say: $object->new Couchbase($url [ , $username, $password, $bucket, $persistent ]) That is, all the parameters are optional after $url. And the $bucket parameter is missing in the current docs.
Hide
Permalink
Karen Zeller added a comment -
So I think this is the fix that should be applied to both 1.0 and 1.1:

    <derivative lang="php">

      <dcall call="new Couchbase" id="new_couchbase">

        <args>

          <argument inherit="url"/>

         <argument inherit="username" optional="yes"/>

         <argument inherit="password" optional="yes"/>
        
         <argument inherit="bucket" optional="yes"/>

          <argument inherit="persistent" optional="yes"/>

        </args>

      </dcall>

    </derivative>


So here is the added bucket option and the three parameters are now optional.
Show
Karen Zeller added a comment - So I think this is the fix that should be applied to both 1.0 and 1.1:     <derivative lang="php">       <dcall call="new Couchbase" id="new_couchbase">         <args>           <argument inherit="url"/>          <argument inherit="username" optional="yes"/>          <argument inherit="password" optional="yes"/>                   <argument inherit="bucket" optional="yes"/>           <argument inherit="persistent" optional="yes"/>         </args>       </dcall>     </derivative> So here is the added bucket option and the three parameters are now optional.
Hide
Permalink
Karen Zeller added a comment -
I think this is the fix for both 1.0 and 1.1:

    <derivative lang="php">

      <dcall call="new Couchbase" id="new_couchbase">

        <args>

          <argument inherit="url"/>

         <argument inherit="username" optional="yes"/>

         <argument inherit="password" optional="yes"/>
        
         <argument inherit="bucket" optional="yes"/>

          <argument inherit="persistent" optional="yes"/>

        </args>

      </dcall>

    </derivative>


So here is the added bucket option and the three parameters are now optional.
Show
Karen Zeller added a comment - I think this is the fix for both 1.0 and 1.1:     <derivative lang="php">       <dcall call="new Couchbase" id="new_couchbase">         <args>           <argument inherit="url"/>          <argument inherit="username" optional="yes"/>          <argument inherit="password" optional="yes"/>                   <argument inherit="bucket" optional="yes"/>           <argument inherit="persistent" optional="yes"/>         </args>       </dcall>     </derivative> So here is the added bucket option and the three parameters are now optional.

People

  • Assignee:
    Karen Zeller
    Reporter:
    Tim Smith
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: