AudioPreset.php
4 years ago
Block.php
4 years ago
CurrentUser.php
5 years ago
EmailCollection.php
5 years ago
LicensedProduct.php
5 years ago
Model.php
4 years ago
ModelInterface.php
5 years ago
Player.php
5 years ago
Post.php
5 years ago
Preset.php
4 years ago
ReusableVideo.php
4 years ago
Setting.php
5 years ago
Video.php
4 years ago
Webhook.php
3 years ago
ModelInterface.php
112 lines
| 1 | <?php |
| 2 | |
| 3 | namespace PrestoPlayer\Models; |
| 4 | |
| 5 | interface ModelInterface |
| 6 | { |
| 7 | /** |
| 8 | * Sets attributes in the model |
| 9 | * |
| 10 | * @param array $args |
| 11 | * @return ModelInterface |
| 12 | */ |
| 13 | public function set($args); |
| 14 | |
| 15 | /** |
| 16 | * Gets a model from the database |
| 17 | * |
| 18 | * @param integer $id |
| 19 | * @return ModelInterface |
| 20 | */ |
| 21 | public function get($id); |
| 22 | |
| 23 | /** |
| 24 | * Attempt to locate a database record using the given |
| 25 | * column / value pairs. If the model can NOT be found |
| 26 | * in the database, a record will be inserted with |
| 27 | * the attributes resulting from merging the first array |
| 28 | * argument with the optional second array argument. |
| 29 | * |
| 30 | * @param array $search Model to search for |
| 31 | * @param array $create Attributes to create |
| 32 | * @return void |
| 33 | */ |
| 34 | public function firstOrCreate($search, $create); |
| 35 | |
| 36 | /** |
| 37 | * Re-retrieve the instance from the database |
| 38 | * |
| 39 | * @return ModelInterface |
| 40 | */ |
| 41 | public function fresh(); |
| 42 | |
| 43 | /** |
| 44 | * Fetch all models from the database |
| 45 | * |
| 46 | * @return array Array of ModelInterface objects |
| 47 | */ |
| 48 | public function all(); |
| 49 | |
| 50 | /** |
| 51 | * Fetch models from the database |
| 52 | * |
| 53 | * @param array $args |
| 54 | * @return array Array of ModelInterface objects |
| 55 | */ |
| 56 | public function fetch($args); |
| 57 | |
| 58 | /** |
| 59 | * Create a new model in the database |
| 60 | * |
| 61 | * @param array $args |
| 62 | * @return int ID of the created model |
| 63 | */ |
| 64 | public function create($args); |
| 65 | |
| 66 | /** |
| 67 | * Convenience function to create and get model |
| 68 | * |
| 69 | * @param array $args Model creation args |
| 70 | * @return Model |
| 71 | */ |
| 72 | public function createAndGet($args); |
| 73 | |
| 74 | /** |
| 75 | * Update an existing model or create a new model if no matching model exists |
| 76 | * |
| 77 | * @param array $search |
| 78 | * @param array $create |
| 79 | * @return Model |
| 80 | */ |
| 81 | public function updateOrCreate($search, $create); |
| 82 | |
| 83 | /** |
| 84 | * Update a model in the database |
| 85 | * |
| 86 | * @param array $args |
| 87 | * @return ModelInterface |
| 88 | */ |
| 89 | public function update($args); |
| 90 | |
| 91 | /** |
| 92 | * Trash a model |
| 93 | * |
| 94 | * @return ModelInterface |
| 95 | */ |
| 96 | public function trash(); |
| 97 | |
| 98 | /** |
| 99 | * Untrash a model |
| 100 | * |
| 101 | * @return ModelInterface |
| 102 | */ |
| 103 | public function untrash(); |
| 104 | |
| 105 | /** |
| 106 | * Permanently delete a model |
| 107 | * |
| 108 | * @return bool |
| 109 | */ |
| 110 | public function delete(); |
| 111 | } |
| 112 |