EoC\Opt\DocOpts

Complexity

Total Complexity

15

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	includeLatest()	0	3	1
A	includeAttsSince()	0	3	1
A	issetIgnoreClass()	0	2	1
A	includeLocalSeq()	0	3	1
A	includeMeta()	0	3	1
A	includeDeletedConflicts()	0	3	1
A	reset()	0	3	1
A	includeRevs()	0	3	1
A	ignoreClass()	0	3	1
A	includeAttachments()	0	3	1
A	includeRevsInfo()	0	3	1
A	includeAttEncodingInfo()	0	3	1
A	includeConflicts()	0	3	1
A	includeOpenRevs()	0	7	2

<?php

/**
 * @file DocOpts.php
 * @brief This file contains the DocOpts class.
 * @details
 * @author Filippo F. Fadda
 */


namespace EoC\Opt;


/**
 * @brief To retrieve additional information about document, you can create a DocOpts instance and pass it as parameter
 * to the Couch::getDoc() method.
 * @nosubgrouping
 */
class DocOpts extends AbstractOpts {

  private $ignoreClass = FALSE;


  public function reset() {
    $this->ignoreClass = FALSE;
    parent::reset();
  }


  /**
   * @brief Includes information about the encoding of each document's attachments.
   */
  public function includeAttEncodingInfo() {
    $this->options['att_encoding_info'] = 'true';
    return $this;
  }


  /**
   * @brief Includes a metadata structure that holds information about all the document's attachments.
   */
  public function includeAttachments() {
    $this->options['attachments'] = 'true';
    return $this;
  }


  /**
   * @brief Include just the changed attachments from the specified revision(s).
   * @details If you already have a local copy of an earlier revision of a document and its attachments, you may want
   * to fetch only the attachments that have changed since a particular revision. You can specify one or more revision IDs.
   * In the last case you must use an array of string. The response will include the content of only those attachments
   * that changed since the given revision(s).
   * @param string|array $revs The revision(s) identifier(s).
   */
  public function includeAttsSince($revs) {
    $this->options['atts_since'] = json_encode($revs);
    return $this;
  }


  /**
   * @brief Includes information about document's conflicts.
   */
  public function includeConflicts() {
    $this->options['conflicts'] = 'true';
    return $this;
  }


  /**
   * @brief Includes information about deleted document's conflicts.
   */
  public function includeDeletedConflicts() {
    $this->options['deleted_conflicts'] = 'true';
    return $this;
  }


  /**
   * @brief Includes the sequence number of the revision in the database.
   */
  public function includeLocalSeq() {
    $this->options['local_seq'] = 'true';
    return $this;
  }


  /**
   * @brief Equals to calling includeRevsInfo(), includeConflicts() and includeDeletedConflicts().
   */
  public function includeMeta() {
    $this->options['meta'] = 'true';
    return $this;
  }


  /**
   * @brief This can be used alternatively to includeRevsInfo() method. This option is used by the replicator to return
   * an array of revision IDs more efficiently. The numeric prefixes are removed, with a "start" value indicating the
   * prefix for the first (most recent) ID.
   * @details CouchDB will return something like this:
   @code
     {
       "_revisions": {
         "start": 3,
         "ids": ["fffff", "eeeee", "ddddd"]
       }
     }
   @endcode
   */
  public function includeRevs() {
    $this->options['revs'] = 'true';
    return $this;
  }


  /**
   * @brief Includes information about all the document's revisions.
   * @details CouchDB will return something like this:
   @code
     {
       "_revs_info": [
         {"rev": "3-ffffff", "status": "available"},
         {"rev": "2-eeeeee", "status": "missing"},
         {"rev": "1-dddddd", "status": "deleted"},
       ]
     }
   @endcode
   */
  public function includeRevsInfo() {
    $this->options['revs_info'] = 'true';
    return $this;
  }


  /**
   * @brief You can fetch the bodies of multiple revisions at once using this option. Using `$revs = 'all'` you can
   * fetch all leaf revisions; alternatively you can specify an array of revisions. The JSON returns an array of objects
   * with an "ok" key pointing to the document, or a "missing" key pointing to the rev string.
   * @details CouchDB will return something like this:
   * [{"missing":"1-fbd8a6da4d669ae4b909fcdb42bb2bfd"},{"ok":{"_id":"test","_rev":"2-5bc3c6319edf62d4c624277fdd0ae191","hello":"foo"}}]
   * @param string|array $revs The revision(s) identifier(s).
   */
  public function includeOpenRevs($revs = 'all') {
    if (is_array($revs))
      $this->options['open_revs'] = json_encode($revs);
    else
      $this->options['open_revs'] = 'all';

    return $this;
  }


  /**
   * @brief The option is supposed to tell the source to send the leafs of an edit branch containing a requested
   * revision, i.e. if the document has been updated since the revlist was calculated, the source is free to send the
   * new one.
   */
  public function includeLatest() {
    $this->options['latest'] = 'true';
    return $this;
  }


  /**
   * @brief Ignores the class name to avoid the creation of an instance of that class.
   * @details When `true` ignores the class name, previously saved in the special attribute `class`, to avoid the
   * creation of an instance of that particular class. You want use this property when the interpreter can't load class
   * due to namespace resolution problem or because the class definition is missing.
   */
  public function ignoreClass() {
    $this->ignoreClass = TRUE;
    return $this;
  }


  /**
   * @brief Returns `true` if ignoreClass() has been called before.
   */
  public function issetIgnoreClass() {
    return $this->ignoreClass;
  }

}