Uploaded image for project: 'Couchbase PHP client library'
  1. Couchbase PHP client library
  2. PCBC-95

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

    Details

    • Type: Bug
    • Status: Closed
    • Priority: 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

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

          Hide
          TimSmith Tim Smith (Inactive) 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
          TimSmith Tim Smith (Inactive) 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
          kzeller kzeller 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
          kzeller kzeller 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
          kzeller kzeller 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
          kzeller kzeller 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:
              kzeller kzeller
              Reporter:
              TimSmith Tim Smith (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Gerrit Reviews

                There are no open Gerrit changes