Search/src/structs/search_result.php

<?php
/**
 * File containing the ezcSearchResult class.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 * @package Search
 * @version //autogentag//
 * @copyright Copyright (C) 2005-2010 eZ Systems AS. All rights reserved.
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 */

/**
 * The struct contains the result as parsed by the different search handlers.
 *
 * @package Search
 * @version //autogentag//
 */
class ezcSearchResult
{
    /**
     * Search status.
     *
     * @var int
     */
    public $status;

    /**
     * Query time in milliseconds
     *
     * @var int
     */
    public $queryTime;

    /**
     * The number of results
     *
     * @var int
     */
    public $resultCount;

    /**
     * The index in the result, in case of paging
     *
     * @var int
     */
    public $start;

    /**
     * The found documents
     *
     * The key of the array is the document's ID, where the value contains the
     * document, the score and highlighted values.
     *
     * @var array(string=>ezcSearchResultDocument)
     */
    public $documents;

    /**
     * An error message in case a search error occurred
     *
     * @var string
     */
    public $error;

    /**
     * A list of facets
     *
     * The first index is the field on which the facet was generated for, and the
     * element consists of an array where they key is the facet string, and the
     * value is the number of this facet's occurences in the search result.
     *
     * @var array(string=>array(string=>mixed))
     */
    public $facets;

    /**
     * Contructs a new ezcSearchResult.
     *
     * @param int $status
     * @param int $queryTime
     * @param int $resultCount
     * @param int $start
     * @param array $documents
     * @param string $error
     * @param array(string=>array(mixed)) $facets
     */
    public function __construct( $status =  0, $queryTime =  0, $resultCount =  0, $start =  0, $documents =  array(), $error =  '', $facets = array() )
    {
        $this->status = $status;
        $this->queryTime = $queryTime;
        $this->resultCount = $resultCount;
        $this->start = $start;
        $this->documents = $documents;
        $this->error = $error;
        $this->facets = $facets;
    }

    /**
     * Returns a new instance of this class with the data specified by $array.
     *
     * $array contains all the data members of this class in the form:
     * array('member_name'=>value).
     *
     * __set_state makes this class exportable with var_export.
     * var_export() generates code, that calls this method when it
     * is parsed with PHP.
     *
     * @param array(string=>mixed) $array
     * @return ezcSearchResult
     */
    static public function __set_state( array $array )
    {
        return new ezcSearchResult(
            $array['status'], $array['queryTime'], $array['resultCount'],
            $array['start'], $array['documents'], $array['error'],
            $array['facets']
        );
    }
}
?>