summaryrefslogtreecommitdiffstats
path: root/src/Psecio/Gatekeeper/DataSource/Stub.php
blob: cefb7bb9433729b0c440a77764bafec83a21c1ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?php

namespace Psecio\Gatekeeper\DataSource;

class Stub extends \Psecio\Gatekeeper\DataSource
{
    /**
     * Save the given model
     *
     * @param \Modler\Model $model Model instance
     * @return boolean Success/fail of action
     */
    public function save(\Modler\Model $model){}

    /**
     * Create a new record with model given
     *
     * @param \Modler\Model $model Model instance
     * @return boolean Success/fail of action
     */
    public function create(\Modler\Model $model){}

    /**
     * Update the record for the given model
     *
     * @param \Modler\Model $model Model instance
     * @return boolean Success/fail of action
     */
    public function update(\Modler\Model $model){}

    /**
     * Delete the record defined by the model data
     *
     * @param \Modler\Model $model Model instance
     * @return boolean Success/fail of action
     */
    public function delete(\Modler\Model $model){}

    /**
     * Find and populate a model based on the model type and where criteria
     *
     * @param \Modler\Model $model Model instance
     * @param array $where "Where" data to locate record
     * @return boolean Success/fail of action
     */
    public function find(\Modler\Model $model, array $where = array()){}

    /**
     * Return the number of entities in DB per condition or in general
     *
     * @param \Modler\Model $model Model instance
     * @param array $where
     * @return bool Success/fail of action
     * @internal param array $where "Where" data to locate record
     */
    public function count(\Modler\Model $model, array $where = array()){}

    /**
     * Return the last error from action taken on the datasource
     *
     * @return string Error string
     */
    public function getLastError(){}

    /**
     * Fetch the data from the source
     *
     * @return boolean Success/fail of action
     */
    public function fetch(){}
}