Commit 91bc8bed authored by webchick's avatar webchick

#709892 by drunken monkey, Yorirou: Complete entity CRUD hook invocations: Add...

#709892 by drunken monkey, Yorirou: Complete entity CRUD hook invocations: Add a hook_entity_delete() for consistency.
parent 8ab93aea
......@@ -1190,6 +1190,7 @@ function file_delete(stdClass $file, $force = FALSE) {
// Let other modules clean up any references to the deleted file.
module_invoke_all('file_delete', $file);
module_invoke_all('entity_delete', $file, 'file');
// Make sure the file is deleted before removing its row from the
// database, so UIs can still find the file in the database.
......
......@@ -1592,6 +1592,7 @@ function comment_delete_multiple($cids) {
foreach ($comments as $comment) {
field_attach_delete('comment', $comment);
module_invoke_all('comment_delete', $comment);
module_invoke_all('entity_delete', $comment, 'comment');
// Delete the comment's replies.
$child_cids = db_query('SELECT cid FROM {comment} WHERE pid = :cid', array(':cid' => $comment->cid))->fetchCol();
......
......@@ -1171,6 +1171,7 @@ function node_delete_multiple($nids) {
// Call the node-specific callback (if any):
node_invoke($node, 'delete');
module_invoke_all('node_delete', $node);
module_invoke_all('entity_delete', $node, 'node');
field_attach_delete('node', $node);
// Remove this node from the search index if needed.
......
......@@ -19,6 +19,7 @@ files[] = tests/bootstrap.test
files[] = tests/cache.test
files[] = tests/common.test
files[] = tests/database_test.test
files[] = tests/entity_crud_hook_test.test
files[] = tests/entity_query.test
files[] = tests/error.test
files[] = tests/file.test
......
; $Id$
name = "Entity CRUD Hooks Test"
description = "Support module for CRUD hook tests."
core = 7.x
package = Testing
files[] = entity_crud_hook_test.module
version = VERSION
hidden = TRUE
<?php
// $Id$
//
// Insert hooks
//
/**
* Implements hook_entity_insert().
*/
function entity_crud_hook_test_entity_insert($entity, $type) {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called for type ' . $type);
}
/**
* Implements hook_comment_insert().
*/
function entity_crud_hook_test_comment_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_file_insert().
*/
function entity_crud_hook_test_file_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_node_insert().
*/
function entity_crud_hook_test_node_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_term_insert().
*/
function entity_crud_hook_test_taxonomy_term_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_vocabulary_insert().
*/
function entity_crud_hook_test_taxonomy_vocabulary_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_user_insert().
*/
function entity_crud_hook_test_user_insert() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
//
// Load hooks
//
/**
* Implements hook_entity_load().
*/
function entity_crud_hook_test_entity_load(array $entities, $type) {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called for type ' . $type);
}
/**
* Implements hook_comment_load().
*/
function entity_crud_hook_test_comment_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_file_load().
*/
function entity_crud_hook_test_file_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_node_load().
*/
function entity_crud_hook_test_node_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_term_load().
*/
function entity_crud_hook_test_taxonomy_term_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_vocabulary_load().
*/
function entity_crud_hook_test_taxonomy_vocabulary_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_user_load().
*/
function entity_crud_hook_test_user_load() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
//
// Update hooks
//
/**
* Implements hook_entity_update().
*/
function entity_crud_hook_test_entity_update($entity, $type) {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called for type ' . $type);
}
/**
* Implements hook_comment_update().
*/
function entity_crud_hook_test_comment_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_file_update().
*/
function entity_crud_hook_test_file_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_node_update().
*/
function entity_crud_hook_test_node_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_term_update().
*/
function entity_crud_hook_test_taxonomy_term_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_vocabulary_update().
*/
function entity_crud_hook_test_taxonomy_vocabulary_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_user_update().
*/
function entity_crud_hook_test_user_update() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
//
// Delete hooks
//
/**
* Implements hook_entity_delete().
*/
function entity_crud_hook_test_entity_delete($entity, $type) {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called for type ' . $type);
}
/**
* Implements hook_comment_delete().
*/
function entity_crud_hook_test_comment_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_file_delete().
*/
function entity_crud_hook_test_file_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_node_delete().
*/
function entity_crud_hook_test_node_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_term_delete().
*/
function entity_crud_hook_test_taxonomy_term_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_taxonomy_vocabulary_delete().
*/
function entity_crud_hook_test_taxonomy_vocabulary_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
/**
* Implements hook_user_delete().
*/
function entity_crud_hook_test_user_delete() {
$_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called');
}
<?php
// $Id$
/**
* Test invocation of hooks when inserting, loading, updating or deleting an
* entity. Tested hooks are:
* - hook_entity_insert()
* - hook_entity_load()
* - hook_entity_update()
* - hook_entity_delete()
* As well as all type-specific hooks, like hook_node_insert(),
* hook_comment_update(), etc.
*/
class EntityCrudHookTestCase extends DrupalWebTestCase {
protected $ids = array();
public static function getInfo() {
return array(
'name' => 'Entity CRUD hooks',
'description' => 'Tests the invocation of hooks when inserting, loading, updating or deleting an entity.',
'group' => 'Entity API',
);
}
public function setUp() {
parent::setUp('entity_crud_hook_test', 'taxonomy', 'comment');
}
/**
* Pass if the message $text was set by one of the CRUD hooks in
* entity_crud_hook_test.module, i.e., if the $text is an element of
* $_SESSION['entity_crud_hook_test'].
*
* @param $text
* Plain text to look for.
* @param $message
* Message to display.
* @param $group
* The group this message belongs to, defaults to 'Other'.
* @return
* TRUE on pass, FALSE on fail.
*/
protected function assertHookMessage($text, $message = NULL, $group = 'Other') {
if (!isset($message)) {
$message = $text;
}
return $this->assertTrue(array_search($text, $_SESSION['entity_crud_hook_test']) !== FALSE, $message, $group);
}
/**
* Test hook invocations for CRUD operations on comments.
*/
public function testCommentHooks() {
$node = (object) array(
'uid' => 1,
'type' => 'article',
'title' => 'Test node',
'status' => 1,
'comment' => 2,
'promote' => 0,
'sticky' => 0,
'language' => LANGUAGE_NONE,
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
);
node_save($node);
$nid = $node->nid;
$comment = (object) array(
'cid' => NULL,
'pid' => 0,
'nid' => $nid,
'uid' => 1,
'subject' => 'Test comment',
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
'status' => 1,
'language' => LANGUAGE_NONE,
);
$_SESSION['entity_crud_hook_test'] = array();
comment_save($comment);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type comment');
$this->assertHookMessage('entity_crud_hook_test_comment_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$comment = comment_load($comment->cid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type comment');
$this->assertHookMessage('entity_crud_hook_test_comment_load called');
$_SESSION['entity_crud_hook_test'] = array();
$comment->subject = 'New subject';
comment_save($comment);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type comment');
$this->assertHookMessage('entity_crud_hook_test_comment_update called');
$_SESSION['entity_crud_hook_test'] = array();
comment_delete($comment->cid);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type comment');
$this->assertHookMessage('entity_crud_hook_test_comment_delete called');
}
/**
* Test hook invocations for CRUD operations on files.
*/
public function testFileHooks() {
$url = 'public://entity_crud_hook_test.file';
file_put_contents($url, 'Test test test');
$file = (object) array(
'fid' => NULL,
'uid' => 1,
'filename' => 'entity_crud_hook_test.file',
'uri' => $url,
'filemime' => 'text/plain',
'filesize' => filesize($url),
'status' => 1,
'timestamp' => REQUEST_TIME,
);
$_SESSION['entity_crud_hook_test'] = array();
file_save($file);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type file');
$this->assertHookMessage('entity_crud_hook_test_file_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$file = file_load($file->fid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type file');
$this->assertHookMessage('entity_crud_hook_test_file_load called');
$_SESSION['entity_crud_hook_test'] = array();
$file->filename = 'new.entity_crud_hook_test.file';
file_save($file);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type file');
$this->assertHookMessage('entity_crud_hook_test_file_update called');
$_SESSION['entity_crud_hook_test'] = array();
file_delete($file);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type file');
$this->assertHookMessage('entity_crud_hook_test_file_delete called');
}
/**
* Test hook invocations for CRUD operations on nodes.
*/
public function testNodeHooks() {
$node = (object) array(
'uid' => 1,
'type' => 'article',
'title' => 'Test node',
'status' => 1,
'comment' => 2,
'promote' => 0,
'sticky' => 0,
'language' => LANGUAGE_NONE,
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
);
$_SESSION['entity_crud_hook_test'] = array();
node_save($node);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type node');
$this->assertHookMessage('entity_crud_hook_test_node_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$node = node_load($node->nid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type node');
$this->assertHookMessage('entity_crud_hook_test_node_load called');
$_SESSION['entity_crud_hook_test'] = array();
$node->title = 'New title';
node_save($node);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type node');
$this->assertHookMessage('entity_crud_hook_test_node_update called');
$_SESSION['entity_crud_hook_test'] = array();
node_delete($node->nid);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type node');
$this->assertHookMessage('entity_crud_hook_test_node_delete called');
}
/**
* Test hook invocations for CRUD operations on taxonomy terms.
*/
public function testTaxonomyTermHooks() {
$vocabulary = (object) array(
'name' => 'Test vocabulary',
'machine_name' => 'test',
'description' => NULL,
'module' => 'entity_crud_hook_test',
);
taxonomy_vocabulary_save($vocabulary);
$term = (object) array(
'vid' => $vocabulary->vid,
'name' => 'Test term',
'description' => NULL,
'format' => 1,
);
$_SESSION['entity_crud_hook_test'] = array();
taxonomy_term_save($term);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type taxonomy_term');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_term_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$term = taxonomy_term_load($term->tid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type taxonomy_term');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_term_load called');
$_SESSION['entity_crud_hook_test'] = array();
$term->name = 'New name';
taxonomy_term_save($term);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type taxonomy_term');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_term_update called');
$_SESSION['entity_crud_hook_test'] = array();
taxonomy_term_delete($term->tid);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type taxonomy_term');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_term_delete called');
}
/**
* Test hook invocations for CRUD operations on taxonomy vocabularies.
*/
public function testTaxonomyVocabularyHooks() {
$vocabulary = (object) array(
'name' => 'Test vocabulary',
'machine_name' => 'test',
'description' => NULL,
'module' => 'entity_crud_hook_test',
);
$_SESSION['entity_crud_hook_test'] = array();
taxonomy_vocabulary_save($vocabulary);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type taxonomy_vocabulary');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_vocabulary_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$vocabulary = taxonomy_vocabulary_load($vocabulary->vid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type taxonomy_vocabulary');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_vocabulary_load called');
$_SESSION['entity_crud_hook_test'] = array();
$vocabulary->name = 'New name';
taxonomy_vocabulary_save($vocabulary);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type taxonomy_vocabulary');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_vocabulary_update called');
$_SESSION['entity_crud_hook_test'] = array();
taxonomy_vocabulary_delete($vocabulary->vid);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type taxonomy_vocabulary');
$this->assertHookMessage('entity_crud_hook_test_taxonomy_vocabulary_delete called');
}
/**
* Test hook invocations for CRUD operations on users.
*/
public function testUserHooks() {
$edit = array(
'name' => 'Test user',
'mail' => 'test@example.com',
'created' => REQUEST_TIME,
'status' => 1,
'language' => 'en',
);
$account = (object) $edit;
$_SESSION['entity_crud_hook_test'] = array();
$account = user_save($account, $edit);
$this->assertHookMessage('entity_crud_hook_test_entity_insert called for type user');
$this->assertHookMessage('entity_crud_hook_test_user_insert called');
$_SESSION['entity_crud_hook_test'] = array();
$account = user_load($account->uid);
$this->assertHookMessage('entity_crud_hook_test_entity_load called for type user');
$this->assertHookMessage('entity_crud_hook_test_user_load called');
$_SESSION['entity_crud_hook_test'] = array();
$edit['name'] = 'New name';
$account = user_save($account, $edit);
$this->assertHookMessage('entity_crud_hook_test_entity_update called for type user');
$this->assertHookMessage('entity_crud_hook_test_user_update called');
$_SESSION['entity_crud_hook_test'] = array();
user_delete($account->uid);
$this->assertHookMessage('entity_crud_hook_test_entity_delete called for type user');
$this->assertHookMessage('entity_crud_hook_test_user_delete called');
}
}
......@@ -284,6 +284,17 @@ function hook_entity_load($entities, $type) {
* The type of entity being inserted (i.e. node, user, comment).
*/
function hook_entity_insert($entity, $type) {
// Insert the new entity into a fictional table of all entities.
$info = entity_get_info($type);
$id = reset(entity_extract_ids($type, $entity));
db_insert('example_entity')
->fields(array(
'type' => $type,
'id' => $id,
'created' => REQUEST_TIME,
'updated' => REQUEST_TIME,
))
->execute();
}
/**
......@@ -295,6 +306,34 @@ function hook_entity_insert($entity, $type) {
* The type of entity being updated (i.e. node, user, comment).
*/
function hook_entity_update($entity, $type) {
// Update the entity's entry in a fictional table of all entities.
$info = entity_get_info($type);
$id = reset(entity_extract_ids($type, $entity));
db_update('example_entity')
->fields(array(
'updated' => REQUEST_TIME,
))
->condition('type', $type)
->condition('id', $id)
->execute();
}
/**
* Act on entities when deleted.
*
* @param $entity
* The entity object.
* @param $type
* The type of entity being deleted (i.e. node, user, comment).
*/
function hook_entity_delete($entity, $type) {
// Delete the entity's entry from a fictional table of all entities.
$info = entity_get_info($type);
$id = reset(entity_extract_ids($type, $entity));
db_delete('example_entity')
->condition('type', $type)
->condition('id', $id)
->execute();
}
/**
......
......@@ -431,7 +431,8 @@ function taxonomy_vocabulary_delete($vid) {
->execute();
field_attach_delete_bundle('taxonomy_term', $vocabulary['machine_name']);
module_invoke_all('taxonomy', 'delete', 'vocabulary', $vocabulary);