summaryrefslogtreecommitdiffstats
path: root/src/Psecio/Gatekeeper/DataSource.php
blob: f56ce0b8f0be5b7bd887f3bcb2ab217cf0a7455c (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<?php

namespace Psecio\Gatekeeper;

abstract class DataSource
{
    /**
     * Data source configuration options
     * @var array
     */
    public $config = array();

    /**
     * Last error from a datasource request
     * @var string
     */
    public $lastError = '';

    /**
     * Init the object and set the configuration
     * @param array $config Configuration settings
     */
    public function __construct(array $config)
    {
        $this->setConfig($config);
    }

    /**
     * Set the configuration
     *
     * @param array $config Config settings
     */
    public function setConfig(array $config)
    {
        $this->config = $config;
    }

    /**
     * Get the configuration settings
     *
     * @return array Config settings
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Save the given model
     *
     * @param \Modler\Model $model Model instance
     * @return boolean Success/fail of action
     */
    public abstract 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 abstract 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 abstract 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 abstract 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 object Either a collection or model instance
     */
    public abstract 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 abstract function count(\Modler\Model $model, array $where = array());

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