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

Completely document constants and result codes.

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.1.0
    • Component/s: docs, library
    • Security Level: Public
    • Labels:
      None
    • Environment:
      PHP 1.1 branch

      Description

      There is no documentation in the PHP Couchbase Client for the constants used as options (e.g., COUCHBASE_OPT_COMPRESSOR, Couchbase::GET_PRESERVE_ORDER) and result codes (e.g., COUCHBASE_KEY_EEXISTS). This documentation is critical for usability of the library.

      Also, it would be very nice to have IDE support for these things, via a PHP file that could require_once() into the app so the IDE will find these symbols, shipped as part of the package.

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

        Activity

        Hide
        ingenthr Matt Ingenthron added a comment -

        I think MC is actually taking this on. Assigning it his way.

        Show
        ingenthr Matt Ingenthron added a comment - I think MC is actually taking this on. Assigning it his way.
        Show
        mccouch MC Brown (Inactive) added a comment - I've added the option and result codes to the PHP material: http://www.couchbase.com/docs/couchbase-sdk-php-1.1/api-reference-summary-options.html http://www.couchbase.com/docs/couchbase-sdk-php-1.1/api-reference-summary-errors.html
        Hide
        ingenthr Matt Ingenthron added a comment -

        Apologies MC, a bit more has happened here. I'll leave it to you, but I think this needs to be reopened with a changed description, or another issue opened.

        In addressing this issue, Trond went beyond the constants and documented the whole API. I think the attached PDF is more of a base for the API reference. For example, the new class CouchbaseClusterManager is covered.

        Should we open a new issue related to the API reference?

        Show
        ingenthr Matt Ingenthron added a comment - Apologies MC, a bit more has happened here. I'll leave it to you, but I think this needs to be reopened with a changed description, or another issue opened. In addressing this issue, Trond went beyond the constants and documented the whole API. I think the attached PDF is more of a base for the API reference. For example, the new class CouchbaseClusterManager is covered. Should we open a new issue related to the API reference?
        Hide
        mccouch MC Brown (Inactive) added a comment -

        No, it's fine.

        I've been using the material Trond has written to mark up this, but we already have another (http://www.couchbase.com/issues/browse/PCBC-105) which covers the wider API.

        I just wanted to close this one based on the core of the request; I'll continue to fill out the rest using the material from Trond this week.

        Show
        mccouch MC Brown (Inactive) added a comment - No, it's fine. I've been using the material Trond has written to mark up this, but we already have another ( http://www.couchbase.com/issues/browse/PCBC-105 ) which covers the wider API. I just wanted to close this one based on the core of the request; I'll continue to fill out the rest using the material from Trond this week.
        Hide
        ingenthr Matt Ingenthron added a comment -

        Updated the summary to reflect what was actually done.

        Note that in the process of fixing this, the previous method of documenting functions (which some IDEs have support for) is no longer supported by the PHP project. All API will be documented at couchbase.com/docs in the API reference for PHP.

        We're open to other directions on how to work well with IDEs. I'm just repeating what we've heard from PHP core contributors.

        Show
        ingenthr Matt Ingenthron added a comment - Updated the summary to reflect what was actually done. Note that in the process of fixing this, the previous method of documenting functions (which some IDEs have support for) is no longer supported by the PHP project. All API will be documented at couchbase.com/docs in the API reference for PHP. We're open to other directions on how to work well with IDEs. I'm just repeating what we've heard from PHP core contributors.

          People

          • Assignee:
            mccouch MC Brown (Inactive)
            Reporter:
            TimSmith Tim Smith (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Time Tracking

              Estimated:
              Original Estimate - 24h
              24h
              Remaining:
              Remaining Estimate - 24h
              24h
              Logged:
              Time Spent - Not Specified
              Not Specified

                Gerrit Reviews

                There are no open Gerrit changes