Overview

Namespaces

  • PHP
  • vierbergenlars
    • Forage
      • ODM
        • HydrationSettings
      • QueryParser
      • SearchIndex
      • SearchQuery
      • SearchResult
      • Transport

Classes

  • DocumentMapper
  • SearchHit
  • SearchIndex
  • SearchQuery
  • SearchResult

Interfaces

  • HydrationSettingsInterface
  • Indexable
  • Overview
  • Namespace
  • Class
  • Tree
 1: <?php
 2: 
 3: namespace vierbergenlars\Forage\ODM;
 4: 
 5: use Defer\Deferrable;
 6: 
 7: /**
 8:  * Should be implemented by all objects that are indexable
 9:  */
10: interface Indexable extends Deferrable
11: {
12:     /**
13:      * Converts the object to a document.
14:      * @return array The returned array should contain a mapping from fields to their values. It should also contain an id key.
15:      */
16:     public function toDocument();
17: }
18: 
Forage-PHP-Client API documentation generated by ApiGen 2.8.0