vendor/doctrine/couchdb/lib/Doctrine/CouchDB/View/DesignDocument.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\CouchDB\View;
  21
  22 /**
  23  * Abstract Design Document
  24  *
  25  * @license     http://www.opensource.org/licenses/mit-license.php MIT
  26  * @link        www.doctrine-project.com
  27  * @since       1.0
  28  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  29  */
  30 interface DesignDocument
  31 {
  32     /**
  33      * Get design doc code
  34      *
  35      * Return the view (or general design doc) code, which should be
  36      * committed to the database, which should be structured like:
  37      *
  38      * <code>
  39      *  array(
  40      *    "views" => array(
  41      *      "name" => array(
  42      *          "map"     => "code",
  43      *          ["reduce" => "code"],
  44      *      ),
  45      *      ...
  46      *    )
  47      *  )
  48      * </code>
  49      */
  50     public function getData();
  51 }