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

getDelayed seems to return a Boolean not a "string (Binary object)" as the docs state

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 1.0.3
    • Fix Version/s: 1.1.0
    • Component/s: docs, library
    • Security Level: Public
    • Labels:
      None

      Description

      I'm not sure if this is a doc error or a code error, but the documentation for getDelayed [1] states it returns a "string (Binary object)" when in fact it returns a Boolean.

      The return of a Boolean is likely the intended response as getDelayed implies the use of a callback.

      I've marked this issue as being related to both docs & library, though, in case I've missed something.

      [1] http://www.couchbase.com/docs/couchbase-sdk-php-1.0/api-reference-retrieve.html#table-couchbase-sdk_php_get-delayed

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

        Activity

        BigBlueHat Benjamin Young created issue -
        ingenthr Matt Ingenthron made changes -
        Field Original Value New Value
        Assignee Jan Lehnardt [ jan ] Matt Ingenthron [ ingenthr ]
        Hide
        ingenthr Matt Ingenthron added a comment -

        Mark: Please determine if this issue is still valid and help me triage it into the appropriate release. I've assigned it to you for triage, not necessarily to fix it.

        Show
        ingenthr Matt Ingenthron added a comment - Mark: Please determine if this issue is still valid and help me triage it into the appropriate release. I've assigned it to you for triage, not necessarily to fix it.
        ingenthr Matt Ingenthron made changes -
        Assignee Matt Ingenthron [ ingenthr ] Mark Nunberg [ mnunberg ]
        ingenthr Matt Ingenthron made changes -
        Fix Version/s 1.0.5 [ 10339 ]
        Fix Version/s 1.1.0-beta [ 10403 ]
        Priority Minor [ 4 ] Critical [ 2 ]
        Hide
        ingenthr Matt Ingenthron added a comment -

        Trond: Since this may be just a matter of getting correct documentation, I've bumped the priority so we try to triage it and decide where it belongs. Please allocate just a few minutes to it when you can.

        If it's a documentation fix that's needed, let's pass it along to Karen.

        If you're unsure what was originally intended, it may make sense to look at pecl-memcached.

        Show
        ingenthr Matt Ingenthron added a comment - Trond: Since this may be just a matter of getting correct documentation, I've bumped the priority so we try to triage it and decide where it belongs. Please allocate just a few minutes to it when you can. If it's a documentation fix that's needed, let's pass it along to Karen. If you're unsure what was originally intended, it may make sense to look at pecl-memcached.
        ingenthr Matt Ingenthron made changes -
        Assignee Mark Nunberg [ mnunberg ] Trond Norbye [ trond ]
        Hide
        trond Trond Norbye added a comment -

        According to the code (and the documentation for pecl::memcached:getDelayed) it should return a boolean value.

        Show
        trond Trond Norbye added a comment - According to the code (and the documentation for pecl::memcached:getDelayed) it should return a boolean value.
        trond Trond Norbye made changes -
        Assignee Trond Norbye [ trond ] Karen Zeller [ kzeller ]
        Hide
        kzeller kzeller added a comment -

        I think this fixes it:

        <dcall id="get-delayed" call="getDelayed" inherit="none">

        <m_title>
        Get a key to be fetched later
        </m_title>

        <args>

        <argument inherit="keyn"/>

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

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

        </args>
        <return inherit="boolean"/>
        </dcall>

        Show
        kzeller kzeller added a comment - I think this fixes it: <dcall id="get-delayed" call="getDelayed" inherit="none"> <m_title> Get a key to be fetched later </m_title> <args> <argument inherit="keyn"/> <argument inherit="with_cas" optional="yes"/> <argument inherit="callback" optional="yes"/> </args> <return inherit="boolean"/> </dcall>
        kzeller kzeller made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        Hide
        kzeller kzeller added a comment -

        <dcall id="get-delayed" call="getDelayed" inherit="none">

        <m_title>
        Get a key to be fetched later
        </m_title>

        <args>

        <argument inherit="keyn"/>

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

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

        </args>
        <return inherit="boolean"/>
        </dcall>

        Show
        kzeller kzeller added a comment - <dcall id="get-delayed" call="getDelayed" inherit="none"> <m_title> Get a key to be fetched later </m_title> <args> <argument inherit="keyn"/> <argument inherit="with_cas" optional="yes"/> <argument inherit="callback" optional="yes"/> </args> <return inherit="boolean"/> </dcall>
        kzeller kzeller made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        ingenthr Matt Ingenthron made changes -
        Fix Version/s 1.1.0 [ 10242 ]
        Fix Version/s 1.1.0-beta [ 10403 ]
        trond Trond Norbye made changes -
        Fix Version/s 1.0.5 [ 10339 ]
        brett19 Brett Lawson made changes -
        Workflow jira [ 17839 ] Couchbase SDK Workflow [ 44288 ]

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            BigBlueHat Benjamin Young
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes