Sha256: 5103cf3c1ff8b81eef16f5ac634bb461e9bd16a9be1e3065e52810a0c93d2ab4

Contents?: true

Size: 1.08 KB

Versions: 4

Compression:

Stored size: 1.08 KB

Contents

# Index Context

Index sets up an object using the build functionality, and then attempts to save it to the data source.

Index does the following:

- Queries for models

##### Example

```ruby
class PeopleContext
  include SnFoil::CRUD::IndexContext

  searcher PeopleSearcher
  policy PersonPolicy
  model Person
end
```

### Required Class Definitions

- Searcher
- Policy
- Model

### Primary Action
Does nothing
### Intervals (in order)

<table>
  <thead>
    <th>name</th>
    <th>description</th>
    <th>pre-defined functions</th>
  </thead>

  <tbody>
    <tr>
      <td>setup</td>
      <td>Shared by all CRUD actions</td>
      <td></td>
    </tr>
    <tr>
      <td>setup_index</td>
      <td></td>
      <td></td>
    </tr>
    <tr>
      <td>before_index</td>
      <td></td>
      <td>Queries for models</td>
    </tr>
    <tr>
      <td>after_index_success</td>
      <td></td>
      <td></td>
    </tr>
    <tr>
      <td>after_index_failure</td>
      <td></td>
      <td></td>
    </tr>
    <tr>
      <td>after_index</td>
      <td></td>
      <td></td>
    </tr>
  </tbody>
</table>

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
snfoil-1.1.1 docs/index-context.md
snfoil-1.1.0 docs/index-context.md
snfoil-1.0.1 docs/index-context.md
snfoil-1.0.0 docs/index-context.md