1: <?php
 2: /*
 3:  * The MIT License
 4:  *
 5:  * Copyright 2017 David Schoenbauer <dschoenbauer@gmail.com>.
 6:  *
 7:  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8:  * of this software and associated documentation files (the "Software"), to deal
 9:  * in the Software without restriction, including without limitation the rights
10:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11:  * copies of the Software, and to permit persons to whom the Software is
12:  * furnished to do so, subject to the following conditions:
13:  *
14:  * The above copyright notice and this permission notice shall be included in
15:  * all copies or substantial portions of the Software.
16:  *
17:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23:  * THE SOFTWARE.
24:  */
25: namespace DSchoenbauer\Sql\Command;
26: 
27: /**
28:  * A common interface used for SQL commands
29:  * @author David Schoenbauer <dschoenbauer@gmail.com>
30:  */
31: interface CommandInterface
32: {
33: 
34:     /**
35:      * A SQL statement that has been formatted per the PDO prepared statement syntax
36:      */
37:     public function getSql();
38: 
39:     /**
40:      * a single level array that fulfills the requirements of the SQL statement
41:      */
42:     public function getData();
43: 
44:     /**
45:      * this will take the sql and the data and execute them in a manner that makes sense for the command
46:      * @param \PDO $pdo a PDO connection to a given resource
47:      * @return mixed can return what makes most sense for the command
48:      */
49:     public function execute(\PDO $pdo);
50: }
51: