Skip to content
Permalink
Browse files

Extrated RepositoryInterface out of the code in ORM\Table

  • Loading branch information...
lorenzo committed Feb 16, 2014
1 parent 25cb2a2 commit 4ab894541d09302ac7bee5168ae31ad76041af36
Showing with 186 additions and 96 deletions.
  1. +172 −0 src/Datasource/RepositoryInterface.php
  2. +14 −96 src/ORM/Table.php
@@ -0,0 +1,172 @@
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Datasource;
use Cake\ORM\Entity;
/**
* Describes the methods that any class representing a data storage should
* comply with.
*/
interface RepositoryInterface {
/**
* Creates a new Query for this repository and applies some defaults based on the
* type of search that was selected.
*
* ### Model.beforeFind event
*
* Each find() will trigger a `Model.beforeFind` event for all attached
* listeners. Any listener can set a valid result set using $query
*
* @param string $type the type of query to perform
* @param array $options An array that will be passed to Query::applyOptions
* @return \Cake\ORM\Query
*/
public function find($type = 'all', $options = []);
/**
* Returns a single record after finding it by its primary key, if no record is
* found this method throws an exception.
*
* ###Example:
*
* {{{
* $id = 10;
* $article = $articles->get($id);
*
* $article = $articles->get($id, ['contain' => ['Comments]]);
* }}}
*
* @param mixed primary key value to find
* @param array $options options accepted by `Table::find()`
* @throws Cake\ORM\Error\RecordNotFoundException if the record with such id
* could not be found
* @return \Cake\ORM\Entity
* @see RepositoryInterface::find()
*/
public function get($primaryKey, $options = []);
/**
* Creates a new Query instance for this repository
*
* @return \Cake\ORM\Query
*/
public function query();
/**
* Update all matching records.
*
* Sets the $fields to the provided values based on $conditions.
* This method will *not* trigger beforeSave/afterSave events. If you need those
* first load a collection of records and update them.
*
* @param array $fields A hash of field => new value.
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
*/
public function updateAll($fields, $conditions);
/**
* Delete all matching records.
*
* Deletes all records matching the provided conditions.
*
* This method will *not* trigger beforeDelete/afterDelete events. If you
* need those first load a collection of records and delete them.
*
* This method will *not* execute on associations `cascade` attribute. You should
* use database foreign keys + ON CASCADE rules if you need cascading deletes combined
* with this method.
*
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
* @see RepositoryInterface::delete()
*/
public function deleteAll($conditions);
/**
* Returns true if there is any record in this repository matching the specified
* conditions.
*
* @param array $conditions list of conditions to pass to the query
* @return boolean
*/
public function exists(array $conditions);
/**
* Persists an entity based on the fields that are marked as dirty and
* returns the same entity after a successful save or false in case
* of any error.
*
* @param \Cake\ORM\Entity the entity to be saved
* @param array $options
* @return \Cake\ORM\Entity|boolean
*/
public function save(Entity $entity, array $options = []);
/**
* Delete a single entity.
*
* Deletes an entity and possibly related associations from the database
* based on the 'dependent' option used when defining the association.
*
* @param Entity $entity The entity to remove.
* @param array $options The options fo the delete.
* @return boolean success
*/
public function delete(Entity $entity, array $options = []);
/**
* Create a new entity + associated entities from an array.
*
* This is most useful when hydrating request data back into entities.
* For example, in your controller code:
*
* {{{
* $article = $this->Articles->newEntity($this->request->data());
* }}}
*
* The hydrated entity will correctly do an insert/update based
* on the primary key data existing in the database when the entity
* is saved. Until the entity is saved, it will be a detached record.
*
* @param array $data The data to build an entity with.
* @param array $associations A whitelist of associations
* to hydrate. Defaults to all associations
* @return Cake\ORM\Entity
*/
public function newEntity(array $data = [], $associations = null);
/**
* Create a list of entities + associated entities from an array.
*
* This is most useful when hydrating request data back into entities.
* For example, in your controller code:
*
* {{{
* $articles = $this->Articles->newEntities($this->request->data());
* }}}
*
* The hydrated entities can then be iterated and saved.
*
* @param array $data The data to build an entity with.
* @param array $associations A whitelist of associations
* to hydrate. Defaults to all associations
* @return array An array of hydrated records.
*/
public function newEntities(array $data, $associations = null);
}
Oops, something went wrong.

0 comments on commit 4ab8945

Please sign in to comment.
You can’t perform that action at this time.