updated flag module to 7.x-3.6 (2015-mar-02)

This commit is contained in:
Bachir Soussi Chiadmi
2015-04-20 20:01:42 +02:00
parent 785dee0639
commit eeb0df349d
41 changed files with 2024 additions and 521 deletions

View File

@@ -43,7 +43,7 @@ class FlagFlaggingCRUDTestCase extends FlagTestCaseBase {
*/
public static function getInfo() {
return array(
'name' => 'Flagging CRUD',
'name' => 'CRUD API',
'description' => 'Basic CRUD operations on flagging entities.',
'group' => 'Flag',
);
@@ -216,14 +216,14 @@ class FlagFlaggingCRUDTestCase extends FlagTestCaseBase {
* Test Flag admin UI.
*/
class FlagAdminTestCase extends FlagTestCaseBase {
var $_flag = FALSE;
public $_flag = FALSE;
/**
* Implements getInfo().
*/
public static function getInfo() {
return array(
'name' => 'Flag admin tests',
'name' => 'Admin UI',
'description' => 'Add, edit and delete flags.',
'group' => 'Flag',
);
@@ -235,7 +235,7 @@ class FlagAdminTestCase extends FlagTestCaseBase {
function setUp() {
parent::setUp('flag');
// Create and login user
// Create and login user.
$admin_user = $this->drupalCreateUser(array('access administration pages', 'administer flags'));
$this->drupalLogin($admin_user);
}
@@ -245,6 +245,14 @@ class FlagAdminTestCase extends FlagTestCaseBase {
*/
function testFlagAdmin() {
// Add a new flag using the UI.
$this->drupalGet(FLAG_ADMIN_PATH . '/add/node');
// Check the form has the expected defaults.
$this->assertFieldByName('flag_short', 'Flag this item', "The flag message default value shows in the form.");
$this->assertFieldByName('unflag_short', 'Unflag this item', "The unflag message default value shows in the form.");
$this->assertFieldByName('show_in_links[full]', 'full', "The view mode option is set to the node 'full' view mode by default.");
$this->assertFieldByName('show_in_links[teaser]', 'teaser', "The view mode option is set to the node 'teaser' view mode by default.");
$edit = array(
'name' => drupal_strtolower($this->randomName()),
'title' => $this->randomName(),
@@ -269,7 +277,13 @@ class FlagAdminTestCase extends FlagTestCaseBase {
$saved = $edit;
$saved['roles'] = array('flag' => array(2), 'unflag' => array(2));
$saved['types'] = array('page');
$saved['show_in_links'] = array('full' => 0, 'teaser' => 0, 'rss' => 0, 'search_index' => 0, 'search_result' => 0);
$saved['show_in_links'] = array(
'full' => 0,
'teaser' => 0,
'rss' => 0,
'search_index' => 0,
'search_result' => 0,
);
unset($saved['roles[flag][2]'], $saved['roles[unflag][2]'], $saved['types[article]'], $saved['types[page]'], $saved['show_in_links[full]'], $saved['show_in_links[teaser]'], $saved['show_in_links[rss]'], $saved['show_in_links[search_index]'], $saved['show_in_links[search_result]']);
$this->drupalPost(FLAG_ADMIN_PATH . '/add/node', $edit, t('Save flag'));
@@ -291,7 +305,7 @@ class FlagAdminTestCase extends FlagTestCaseBase {
$permissions = user_role_permissions(user_roles());
foreach ($saved['roles'] as $action => $rids) {
foreach ($rids as $rid) {
$permission_string = "$action ". $saved['name'];
$permission_string = "$action " . $saved['name'];
$this->assertTrue(isset($permissions[$rid][$permission_string]), t('Permission %perm set for flag.', array(
'%perm' => $permission_string,
)));
@@ -323,7 +337,13 @@ class FlagAdminTestCase extends FlagTestCaseBase {
$saved = $edit;
$saved['roles'] = array('flag' => array(2), 'unflag' => array(2));
$saved['types'] = array('article');
$saved['show_in_links'] = array('full' => TRUE, 'teaser' => TRUE, 'rss' => 0, 'search_index' => 0, 'search_result' => 0);
$saved['show_in_links'] = array(
'full' => TRUE,
'teaser' => TRUE,
'rss' => 0,
'search_index' => 0,
'search_result' => 0,
);
unset($saved['roles[flag][2]'], $saved['roles[unflag][2]'], $saved['types[article]'], $saved['types[page]'], $saved['show_in_links[full]'], $saved['show_in_links[teaser]'], $saved['show_in_links[rss]'], $saved['show_in_links[search_index]'], $saved['show_in_links[search_result]']);
$this->drupalPost(FLAG_ADMIN_PATH . '/manage/' . $flag->name, $edit, t('Save flag'));
@@ -350,7 +370,7 @@ class FlagAdminTestCase extends FlagTestCaseBase {
foreach ($saved['roles'] as $action => $rids) {
foreach ($rids as $rid) {
$permission_string = "$action ". $saved['name'];
$permission_string = "$action " . $saved['name'];
$this->assertTrue(isset($permissions[$rid][$permission_string]), t('Permission %perm set for flag.', array(
'%perm' => $permission_string,
)));
@@ -377,7 +397,7 @@ class FlagAccessFormTestCase extends FlagTestCaseBase {
*/
public static function getInfo() {
return array(
'name' => 'Flag access: entity forms',
'name' => 'Access to flags via entity forms',
'description' => 'Access to flag and unflag entities via entity forms.',
'group' => 'Flag',
);
@@ -431,7 +451,7 @@ class FlagAccessFormTestCase extends FlagTestCaseBase {
$this->drupalGet('node/add/article');
// Check that the flag form element cannot be seen
// Check that the flag form element cannot be seen.
$this->assertNoText('Flag this item', t('Flag form element was not found.'));
// Have the user create a node.
@@ -463,6 +483,161 @@ class FlagAccessFormTestCase extends FlagTestCaseBase {
}
/**
* Tokens we provide on generic entities.
*/
class FlagEntityTokensTestCase extends FlagTestCaseBase {
/**
* Implements getInfo().
*/
public static function getInfo() {
return array(
'name' => 'Entity tokens',
'description' => 'Tokens for flag count on entities.',
'group' => 'Flag',
);
}
/**
* Implements setUp().
*/
function setUp() {
// Our entity tokens require token module.
parent::setUp('flag', 'token');
}
/**
* Test tokens on nodes.
*/
function testNodeFlagToken() {
// Create a flag on article nodes.
$flag_data = array(
'entity_type' => 'node',
'name' => 'node_flag',
'title' => 'Node Flag',
'global' => 0,
'types' => array(
0 => 'article',
),
'flag_short' => 'Flag this item',
'flag_long' => '',
'flag_message' => '',
'unflag_short' => 'Unflag this item',
'unflag_long' => '',
'unflag_message' => '',
'unflag_denied_text' => 'You may not unflag this item',
'link_type' => 'normal',
'weight' => 0,
// Show the flag on the form.
'show_on_form' => 1,
'access_author' => '',
'show_contextual_link' => 0,
'show_in_links' => array(
'full' => 1,
'teaser' => 1,
),
'i18n' => 0,
'api_version' => 3,
);
$flag = $this->createFlag($flag_data);
// Create a node to flag.
$node = (object) array(
'type' => 'article',
'title' => $this->randomName(),
);
node_save($node);
// Flag it by several users.
$flag_user_1 = $this->drupalCreateUser(array('flag node_flag',));
// Flag the node as the user.
$flag = flag_get_flag('node_flag');
$flag->flag('flag', $node->nid, $flag_user_1);
$flag_user_2 = $this->drupalCreateUser(array('flag node_flag',));
// Flag the node as the user.
$flag->flag('flag', $node->nid, $flag_user_2);
$text = '[node:flag-node-flag-count]';
$replaced_text = token_replace($text, array('node' => $node));
$this->assertEqual($replaced_text, 2, "The flag count token for the node is correct.");
}
/**
* Test tokens on taxonomy terms.
*
* These are worthy of a separate test, as the token type is a special case.
*/
function testTaxonomyTermFlagToken() {
// Create a flag on tag terms.
$flag_data = array(
'entity_type' => 'taxonomy_term',
'name' => 'term_flag',
'title' => 'Term Flag',
'global' => 0,
'types' => array(
0 => 'tags',
),
'flag_short' => 'Flag this item',
'flag_long' => '',
'flag_message' => '',
'unflag_short' => 'Unflag this item',
'unflag_long' => '',
'unflag_message' => '',
'unflag_denied_text' => 'You may not unflag this item',
'link_type' => 'normal',
'weight' => 0,
// Show the flag on the form.
'show_on_form' => 1,
'access_author' => '',
'show_contextual_link' => 0,
'show_in_links' => array(
'full' => 1,
'teaser' => 1,
),
'i18n' => 0,
'api_version' => 3,
);
$flag = $this->createFlag($flag_data);
$vocabulary = taxonomy_vocabulary_load(1);
// Create a term to flag.
$term = (object) array(
'name' => $this->randomName(),
'vid' => 1,
);
taxonomy_term_save($term);
// Flag it by several users.
$flag_user_1 = $this->drupalCreateUser(array('flag term_flag',));
// Flag the term as the user.
$flag = flag_get_flag('term_flag');
$flag->flag('flag', $term->tid, $flag_user_1);
$flag_user_2 = $this->drupalCreateUser(array('flag term_flag',));
// Flag the term as the user.
$flag = flag_get_flag('term_flag');
$flag->flag('flag', $term->tid, $flag_user_2);
$text = '[term:flag-term-flag-count]';
$replaced_text = token_replace($text, array('term' => $term));
debug($replaced_text);
$this->assertEqual($replaced_text, 2, "The flag count token for the term is correct.");
}
}
/**
* Access to flags using the basic flag link.
*/
@@ -473,7 +648,7 @@ class FlagAccessLinkTestCase extends FlagTestCaseBase {
*/
public static function getInfo() {
return array(
'name' => 'Flag access tests',
'name' => 'Access to flags via basic link',
'description' => 'Access to flag and unflag entities using the basic link.',
'group' => 'Flag',
);
@@ -599,7 +774,7 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
*/
public static function getInfo() {
return array(
'name' => 'Flag confirm link tests',
'name' => 'Confirm form',
'description' => 'Flag confirm form link type.',
'group' => 'Flag',
);
@@ -621,7 +796,7 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
'types' => array(
0 => 'article',
),
'flag_short' => 'Flag this item',
'flag_short' => 'Flag <em>this</em> item',
'flag_long' => '',
'flag_message' => 'You have flagged this item.',
'unflag_short' => 'Unflag this item',
@@ -642,8 +817,8 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
'i18n' => 0,
'api_version' => 3,
);
$flag = flag_flag::factory_by_array($this->flag_data);
$flag->save();
$this->flag = flag_flag::factory_by_array($this->flag_data);
$this->flag->save();
// Reset our cache so our permissions show up.
drupal_static_reset('flag_get_flags');
@@ -651,8 +826,8 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
$this->checkPermissions(array(), TRUE);
// Create test user who can flag and unflag.
$flag_unflag_user = $this->drupalCreateUser(array('flag test_flag', 'unflag test_flag'));
$this->drupalLogin($flag_unflag_user);
$this->flag_unflag_user = $this->drupalCreateUser(array('flag test_flag', 'unflag test_flag'));
$this->drupalLogin($this->flag_unflag_user);
// Create an article node to flag and unflag.
$title = $this->randomName(8);
@@ -669,16 +844,27 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
}
/**
* Test that a user sees the flag confirm form.
* Test usage of the flag confirm form.
*/
function testFlag() {
// Look at our node.
$this->drupalGet('node/' . $this->nid);
$this->assertLink($this->flag_data['flag_short'], 0, 'The flag link appears on the page');
$flag_short_label = strip_tags($this->flag_data['flag_short']);
$this->assertRaw($this->flag_data['flag_short'], 'The flag text, including HTML, appears on the page.');
// assertLink() appears to have interesting problems dealing with an A
// element which contains other tags. However, the xpath it uses appears to
// be fine with being given just the portion of the link text that comes
// before the interior tag.
// Fortunately, there will be no other text on the page that matches 'Flag'.
$this->assertLink('Flag', 0, 'The flag link appears on the page.');
// Click the link to flag the node.
$this->clickLink($this->flag_data['flag_short']);
// clickLink() has the same problem, as it uses the same xpath expression as
// assertLink().
$this->clickLink('Flag');
$this->assertUrl('flag/confirm/flag/test_flag/' . $this->nid, array(
'query' => array(
@@ -688,12 +874,18 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
$this->assertText($this->flag_data['flag_confirmation'], 'The flag confirmation text appears as the confirmation page title.');
$this->assertPattern('@<input [^>]* value="' . $flag_short_label . '" [^>]*>@', 'The flag text, excluding HTML, is shown in the button.');
// Click the button to confirm the flagging.
$this->drupalPost(NULL, array(), $this->flag_data['flag_short']);
$this->drupalPost(NULL, array(), $flag_short_label);
$this->assertText($this->flag_data['flag_message'], 'The flag message appears once the item has been flagged.');
$this->assertLink($this->flag_data['unflag_short'], 0, 'The unflag link appears once the item has been flagged.');
// Reset the static cache before we get data from it.
drupal_static_reset('flag_get_user_flags');
$this->assertTrue($this->flag->is_flagged($this->nid, $this->flag_unflag_user->uid), "The node is recorded as flagged by the user.");
// Click the link to unflag the node.
$this->clickLink($this->flag_data['unflag_short']);
@@ -709,6 +901,10 @@ class FlagLinkTypeConfirmTestCase extends DrupalWebTestCase {
$this->drupalPost(NULL, array(), $this->flag_data['unflag_short']);
$this->assertText($this->flag_data['unflag_message'], 'The unflag message appears once the item has been flagged.');
// Reset the static cache before we get data from it.
drupal_static_reset('flag_get_user_flags');
$this->assertFalse($this->flag->is_flagged($this->nid, $this->flag_unflag_user->uid), "The node is recorded as not flagged by the user.");
}
}
@@ -723,7 +919,7 @@ class FlagHookFlagAccessTestCase extends FlagTestCaseBase {
*/
public static function getInfo() {
return array(
'name' => 'Flag hook_flag_access() tests',
'name' => 'hook_flag_access()',
'description' => 'Checks the ability of modules to use hook_flag_access().',
'group' => 'Flag',
);
@@ -831,7 +1027,8 @@ class FlagHookFlagAccessTestCase extends FlagTestCaseBase {
}
/**
* Verifies that the user sees the flag if a module returns TRUE (Allow) to override default access check.
* Verifies that the user sees the flag if a module returns TRUE (Allow) to
* override default access check.
*/
function testFlagAccessAllowOverride() {
variable_set('FlagHookFlagAccessTestCaseMode', 'allow');
@@ -855,7 +1052,8 @@ class FlagHookFlagAccessTestCase extends FlagTestCaseBase {
}
/**
* Verifies that the user does not see the flag if a module returns FALSE (Deny).
* Verifies that the user does not see the flag if a module returns FALSE
* (Deny).
*/
function testFlagAccessDeny() {
variable_set('FlagHookFlagAccessTestCaseMode', 'deny');
@@ -870,6 +1068,83 @@ class FlagHookFlagAccessTestCase extends FlagTestCaseBase {
}
/**
* Test use of fields on flagging entities.
*/
class FlagFlaggingFieldTestCase extends FlagTestCaseBase {
/**
* Implements getInfo().
*/
public static function getInfo() {
return array(
'name' => 'Flagging fields',
'description' => 'Fields on Flagging entities.',
'group' => 'Flag',
);
}
/**
* Implements setUp().
*/
function setUp() {
parent::setUp('flag', 'flag_fields_test');
}
function testFlaggingFields() {
$this->assertTrue(1);
$flag_user = $this->drupalCreateUser(array(
'flag flag_fields_test_flag',
'unflag flag_fields_test_flag',
));
$this->drupalLogin($flag_user);
$node = $this->drupalCreateNode();
$this->drupalGet('node/' . $node->nid);
$this->clickLink('Flag with the test flag');
// Try to fail the form validation by providing something non-numeric.
// This validation is only present in the widget validation: this is a core
// bug, but lets us test widget validation works correctly until it's fixed.
$edit = array(
'flag_fields_test_integer[und][0][value]' => 'banana',
);
$this->drupalPost(NULL, $edit, 'Flag with the test flag');
$this->assertText("Only numbers are allowed in Test integer.", "Form validation correctly failed the input.");
// Try to fail the form validation by a number that's out of bounds.
$edit = array(
'flag_fields_test_integer[und][0][value]' => 12,
);
$this->drupalPost(NULL, $edit, 'Flag with the test flag');
$this->assertText("Test integer: the value may be no greater than 11.", "Form validation correctly failed the input.");
$edit = array(
'flag_fields_test_integer[und][0][value]' => 6,
);
$this->drupalPost(NULL, $edit, 'Flag with the test flag');
$this->assertUrl('node/' . $node->nid, array(), "The flagging form submission succeeded.");
// Try to load the flagging, querying for the field value.
$query = new EntityFieldQuery();
$query->entityCondition('entity_type', 'flagging')
->entityCondition('bundle', 'flag_fields_test_flag')
->propertyCondition('entity_id', $node->nid)
->fieldCondition('flag_fields_test_integer', 'value', 6);
$result = $query->execute();
$this->assertEqual(count($result['flagging']), 1, "The Flagging entity was found with the correct field values.");
}
}
/**
* Test use of EntityFieldQueries with flagging entities.
*/
@@ -879,8 +1154,8 @@ class FlagEntityFieldQueryTestCase extends FlagTestCaseBase {
* Implements getInfo().
*/
public static function getInfo() {
return array(
'name' => 'Flagging Entity Field Query Extension',
return array(
'name' => 'Entity Field Query',
'description' => 'Entity Field Query for flagging entities.',
'group' => 'Flag',
);
@@ -928,7 +1203,12 @@ class FlagEntityFieldQueryTestCase extends FlagTestCaseBase {
$this->flag3 = $this->createFlag($flag_data);
// Create test user who can flag and unflag.
$this->flag_unflag_user = $this->drupalCreateUser(array('flag test_flag_1', 'unflag test_flag_1', 'flag test_flag_2', 'unflag test_flag_2'));
$this->flag_unflag_user = $this->drupalCreateUser(array(
'flag test_flag_1',
'unflag test_flag_1',
'flag test_flag_2',
'unflag test_flag_2',
));
$this->drupalLogin($this->flag_unflag_user);
}
@@ -937,7 +1217,7 @@ class FlagEntityFieldQueryTestCase extends FlagTestCaseBase {
* Test use of EntityFieldQuery with flagging entities.
*/
function testEntityFieldQuery() {
$node_settings = array(
$node_settings = array(
'title' => $this->randomName(),
'body' => array(LANGUAGE_NONE => array(array('value' => $this->randomName(32)))),
'uid' => 1,
@@ -969,3 +1249,410 @@ class FlagEntityFieldQueryTestCase extends FlagTestCaseBase {
}
}
/**
* Verifies the invocation of hooks when performing flagging and unflagging.
*/
class FlagHookInvocationsTestCase extends FlagTestCaseBase {
/**
* Implements getInfo().
*/
public static function getInfo() {
return array(
'name' => 'Hook invocations',
'description' => 'Invocation of flag and entity hooks and rules during flagging and unflagging.',
'group' => 'Flag',
);
}
/**
* Implements setUp().
*/
function setUp() {
parent::setUp('flag', 'rules', 'flag_hook_test');
// Note the test module contains our test flag.
// Create test user who can flag and unflag.
$this->flag_unflag_user = $this->drupalCreateUser(array('flag flag_hook_test_flag', 'unflag flag_hook_test_flag'));
$this->drupalLogin($this->flag_unflag_user);
}
/**
* Test invocation of hooks and their data during flagging and unflagging.
*
* For each operation (flagging, re-flagging, unflagging) we test:
* - the order in which Flag hooks, entity hooks, and rules are invoked.
* - the parameters each hook receives
* - the data that a hook implementation obtains when it calls the Flag data
* API functions.
*/
function testHookInvocation() {
// Create an article node that we try to create a flagging entity for.
$title = $this->randomName(8);
$node = array(
'title' => $title,
'body' => array(LANGUAGE_NONE => array(array('value' => $this->randomName(32)))),
'uid' => 1,
'type' => 'article',
'is_new' => TRUE,
);
$node = node_submit((object) $node);
node_save($node);
// Initialize a tracking variable. The test module will update this when
// its hooks are invoked.
variable_set('flag_hook_test_hook_tracking', array());
// Flag the node as the user.
$flag = flag_get_flag('flag_hook_test_flag');
$flag->flag('flag', $node->nid, $this->flag_unflag_user);
// Get the variable the test module sets the hook order into.
$hook_data_variable = variable_get('flag_hook_test_hook_tracking', array());
//debug($hook_data_variable['hook_entity_presave']);
//debug($hook_data_variable['hook_entity_insert']);
$expected_hook_order = array(
'hook_entity_presave',
'hook_entity_insert',
'hook_flag_flag',
'rules_event',
);
// Check the hooks are invoked in the correct order.
$this->assertIdentical($expected_hook_order, array_keys($hook_data_variable), "The hooks are invoked in the correct order when flagging a node.");
// Check the parameters received by hook_entity_presave().
// Param 0: $flagging.
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->flag_name, $flag->name, "The Flagging entity passed to hook_entity_presave() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->fid, $flag->fid, "The Flagging entity passed to hook_entity_presave() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->entity_type, 'node', "The Flagging entity passed to hook_entity_presave() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->entity_id, $node->nid, "The Flagging entity passed to hook_entity_presave() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_entity_presave() has the expected uid property.");
// Param 1: $entity_type.
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][1], 'flagging', "hook_entity_presave() is passed the correct entity type.");
// Check the API data available to hook_entity_presave().
//debug($hook_data_variable['hook_entity_presave']['api_calls']);
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_entity_flags'], array(), "hook_entity_presave() gets no data from from flag_get_entity_flags(), as the flagging has not yet taken place.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_user_flags'], array(), "hook_entity_presave() gets no data from from flag_get_user_flags(), as the flagging has not yet taken place.");
// The flag counts have not yet been increased.
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_counts'], array(), "hook_entity_presave() gets no data from from flag_get_counts(), as the flagging has not yet taken place.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_flag_counts'], 0, "hook_entity_presave() gets no data from from flag_get_flag_counts(), as the flagging has not yet taken place.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_entity_flag_counts'], 0, "hook_entity_presave() gets no data from from flag_get_entity_flag_counts(), as the flagging has not yet taken place.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['api_calls']['flag_get_user_flag_counts'], 0, "hook_entity_presave() gets no data from from flag_get_user_flag_counts(), as the flagging has not yet taken place.");
// Check the parameters received by hook_entity_insert().
// Param 0: $flagging.
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->flag_name, $flag->name, "The Flagging entity passed to hook_entity_insert() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->fid, $flag->fid, "The Flagging entity passed to hook_entity_insert() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->entity_type, 'node', "The Flagging entity passed to hook_entity_insert() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->entity_id, $node->nid, "The Flagging entity passed to hook_entity_insert() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_entity_insert() has the expected uid property.");
$this->assertTrue(!empty($hook_data_variable['hook_entity_insert']['parameters'][0]->flagging_id), "The Flagging entity passed to hook_entity_insert() has the flagging ID set.");
// Param 1: $entity_type.
$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][1], 'flagging', "hook_entity_insert() is passed the correct entity type.");
// Check the API data available to hook_entity_insert().
//debug($hook_data_variable['hook_entity_insert']['api_calls']);
$flag_get_entity_flags = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_entity_insert() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_entity_insert() gets a correct fid on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_entity_insert() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_entity_insert() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_entity_insert() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_entity_insert() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_entity_insert() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have been increased.
$flag_get_counts = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts[$flag->name], 1, "hook_entity_insert() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 1, "hook_entity_insert() gets a correct flag count from flag_get_flag_counts().");
$flag_get_entity_flag_counts = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_entity_insert() gets a correct flag count from flag_get_entity_flag_counts().");
$flag_get_user_flag_counts = $hook_data_variable['hook_entity_insert']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_entity_insert() gets a correct flag count from flag_get_user_flag_counts().");
// Check the parameters received by hook_flag_flag().
// Param 0: $flag.
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][0], $flag, "The flag object is passed to hook_flag_flag().");
// Param 1: $entity_id.
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][1], $node->nid, "The entity ID is passed to hook_flag_flag().");
// Param 2: $account.
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][2]->uid, $this->flag_unflag_user->uid, "The user account is passed to hook_flag_flag().");
// Param 3: $flagging.
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][3]->flag_name, $flag->name, "The Flagging entity passed to hook_flag_flag() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][3]->fid, $flag->fid, "The Flagging entity passed to hook_flag_flag() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][3]->entity_type, 'node', "The Flagging entity passed to hook_flag_flag() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][3]->entity_id, $node->nid, "The Flagging entity passed to hook_flag_flag() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_flag_flag']['parameters'][3]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_flag_flag() has the expected uid property.");
// Check the API data available to hook_flag_flag().
//debug($hook_data_variable['hook_flag_flag']['api_calls']);
$flag_get_entity_flags = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_flag_flag() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_flag_flag() gets a correct fid on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_flag_flag() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_flag_flag() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_flag_flag() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_flag_flag() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_flag_flag() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have been increased.
$flag_get_counts = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts[$flag->name], 1, "hook_flag_flag() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 1, "hook_flag_flag() gets a correct flag count from flag_get_flag_counts().");
$flag_get_entity_flag_counts = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_flag_flag() gets a correct flag count from flag_get_entity_flag_counts().");
$flag_get_user_flag_counts = $hook_data_variable['hook_flag_flag']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_flag_flag() gets a correct flag count from flag_get_user_flag_counts().");
// Clear the tracking variable.
variable_set('flag_hook_test_hook_tracking', array());
// Get the Flagging, and re-flag the node.
// This does nothing in our case, but is the API for updating a Flagging
// entity with changes to its Field API fields.
// Query the database to get the Flagging ID rather than Flag API so we
// don't interefere with any caches.
$query = db_select('flagging', 'f');
$query->addField('f', 'flagging_id');
$query->condition('fid', $flag->fid)
->condition('entity_id', $node->nid);
$flagging_id = $query
->execute()
->fetchField();
$flagging = flagging_load($flagging_id);
// Re-flag the node passing in the flagging entity.
$flag->flag('flag', $node->nid, $this->flag_unflag_user, FALSE, $flagging);
// Get the variable the test module sets the hook order into.
$hook_data_variable = variable_get('flag_hook_test_hook_tracking', array());
//debug($hook_data_variable);
$expected_hook_order = array(
'hook_entity_presave',
'hook_entity_update',
// Note that hook_flag() and the rule are not invoked, as this is not a
// new act of flagging.
);
// Check the hooks are invoked in the correct order.
$this->assertIdentical($expected_hook_order, array_keys($hook_data_variable), "The hooks are invoked in the correct order when re-flagging a node.");
// Check the parameters received by hook_entity_presave().
// Param 0: $flagging.
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->flag_name, $flag->name, "The Flagging entity passed to hook_entity_presave() has the expected flag name property.");
//$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->fid, $flag->fid);
//$this->assertEqual($hook_data_variable['hook_entity_insert']['parameters'][0]->entity_type, 'node');
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->entity_id, $node->nid, "The Flagging entity passed to hook_entity_presave() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_entity_presave() has the expected uid property.");
// Param 1: $entity_type.
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][1], 'flagging', "hook_entity_presave() is passed the correct entity type.");
// Check the API data available to hook_entity_presave().
//debug($hook_data_variable['hook_entity_presave']['api_calls']);
$flag_get_entity_flags = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_entity_presave() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_entity_presave() gets a correct fid on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_entity_presave() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_entity_presave() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_entity_presave() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_entity_presave() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_entity_presave() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have not changed.
$flag_get_counts = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts[$flag->name], 1, "hook_entity_presave() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 1, "hook_entity_presave() gets a correct flag count from flag_get_flag_counts().");
$flag_get_entity_flag_counts = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_entity_presave() gets a correct flag count from flag_get_entity_flag_counts().");
$flag_get_user_flag_counts = $hook_data_variable['hook_entity_presave']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_entity_presave() gets a correct flag count from flag_get_user_flag_counts().");
// Check the parameters received by hook_entity_update().
// Param 0: $flagging.
$this->assertEqual($hook_data_variable['hook_entity_update']['parameters'][0]->flag_name, $flag->name, "The Flagging entity passed to hook_entity_update() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->fid, $flag->fid, "The Flagging entity passed to hook_entity_presave() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_entity_presave']['parameters'][0]->entity_type, 'node', "The Flagging entity passed to hook_entity_presave() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_entity_update']['parameters'][0]->entity_id, $node->nid, "The Flagging entity passed to hook_entity_update() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_entity_update']['parameters'][0]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_entity_update() has the expected uid property.");
$this->assertTrue(!empty($hook_data_variable['hook_entity_update']['parameters'][0]->flagging_id), "The Flagging entity passed to hook_entity_update() has the flagging ID set.");
// Param 1: $entity_type.
$this->assertEqual($hook_data_variable['hook_entity_update']['parameters'][1], 'flagging', "hook_entity_update() is passed the correct entity type.");
// Check the API data available to hook_entity_update().
//debug($hook_data_variable['hook_entity_update']['api_calls']);
$flag_get_entity_flags = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_entity_update() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_entity_update() gets a correct fid on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_entity_update() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_entity_update() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_entity_update() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_entity_update() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_entity_update() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have not changed.
$flag_get_counts = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts[$flag->name], 1, "hook_entity_update() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 1, "hook_entity_update() gets a correct flag count from flag_get_flag_counts().");
$flag_get_entity_flag_counts = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_entity_update() gets a correct flag count from flag_get_entity_flag_counts().");
$flag_get_user_flag_counts = $hook_data_variable['hook_entity_update']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_entity_update() gets a correct flag count from flag_get_user_flag_counts().");
// Clear the tracking variable.
variable_set('flag_hook_test_hook_tracking', array());
// Unflag the node as the user.
$flag->flag('unflag', $node->nid, $this->flag_unflag_user);
// Get the variable the test module sets the hook order into.
$hook_data_variable = variable_get('flag_hook_test_hook_tracking', array());
//debug($hook_data_variable);
$expected_hook_order = array(
'hook_flag_unflag',
'rules_event',
'hook_entity_delete',
);
// Check the hooks are invoked in the correct order.
$this->assertIdentical($expected_hook_order, array_keys($hook_data_variable), "The hooks are invoked in the correct order when unflagging a node.");
// Check the parameters received by hook_flag_unflag().
// Param 0: $flag.
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][0], $flag, "The flag object is passed to hook_flag_unflag().");
// Param 1: $entity_id.
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][1], $node->nid, "The entity ID is passed to hook_flag_unflag().");
// Param 2: $account.
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][2]->uid, $this->flag_unflag_user->uid, "The user account is passed to hook_flag_unflag().");
// Param 3: $flagging.
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][3]->flag_name, $flag->name, "The Flagging entity passed to hook_flag_unflag() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][3]->fid, $flag->fid, "The Flagging entity passed to hook_entity_presave() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][3]->entity_type, 'node', "The Flagging entity passed to hook_entity_presave() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][3]->entity_id, $node->nid, "The Flagging entity passed to hook_flag_unflag() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_flag_unflag']['parameters'][3]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_flag_unflag() has the expected uid property.");
// Check the API data available to hook_flag_unflag().
//debug($hook_data_variable['hook_flag_unflag']['api_calls']);
// The unflagging is not yet done, so flag_get_entity_flags() will find the
// flagging data.
$flag_get_entity_flags = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_flag_unflag() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_flag_unflag() gets a correct fid on the Flagging obtained from flag_get_entity_flags(): the Flagging has not yet been deleted.");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_flag_unflag() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_flag_unflag() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_flag_unflag() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_flag_unflag() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_flag_unflag() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have already been decreased.
$flag_get_counts = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts, array(), "hook_flag_unflag() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 0, "hook_flag_unflag() gets a correct flag count from flag_get_flag_counts().");
// flag_get_entity_flag_counts() queries the {flagging} table, so is not
// updated yet.
$flag_get_entity_flag_counts = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_flag_unflag() gets a correct flag count from flag_get_entity_flag_counts().");
// flag_get_user_flag_counts() queries the {flagging} table, so is not
// updated yet.
$flag_get_user_flag_counts = $hook_data_variable['hook_flag_unflag']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_flag_unflag() gets a correct flag count from flag_get_user_flag_counts().");
// Check the parameters received by hook_entity_delete().
// Param 0: $flagging.
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][0]->flag_name, $flag->name, "The Flagging entity passed to hook_entity_delete() has the expected flag name property.");
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][0]->fid, $flag->fid, "The Flagging entity passed to hook_entity_presave() has the expected fid property.");
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][0]->entity_type, 'node', "The Flagging entity passed to hook_entity_presave() has the expected entity type property.");
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][0]->entity_id, $node->nid, "The Flagging entity passed to hook_entity_delete() has the expected entity ID property.");
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][0]->uid, $this->flag_unflag_user->uid, "The Flagging entity passed to hook_entity_delete() has the expected uid property.");
$this->assertTrue(!empty($hook_data_variable['hook_entity_delete']['parameters'][0]->flagging_id), "The Flagging entity passed to hook_entity_delete() has the flagging ID set.");
// Param 1: $entity_type.
$this->assertEqual($hook_data_variable['hook_entity_delete']['parameters'][1], 'flagging', "hook_entity_delete() is passed the correct entity type.");
// Check the API data available to hook_entity_delete().
//debug($hook_data_variable['hook_entity_delete']['api_calls']);
// The unflagging is not yet done, so hook_entity_delete() will find the
// flagging data.
$flag_get_entity_flags = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_entity_flags'];
$flag_get_entity_flags_uids = array_keys($flag_get_entity_flags);
$this->assertEqual($flag_get_entity_flags_uids, array($this->flag_unflag_user->uid), "hook_entity_delete() gets correct data for flagging users from flag_get_entity_flags()");
$flag_get_entity_flags_flagging = $flag_get_entity_flags[$this->flag_unflag_user->uid];
$this->assertEqual($flag_get_entity_flags_flagging->fid, $flag->fid, "hook_entity_delete() gets a correct fid on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_type, 'node', "hook_entity_delete() gets a correct entity type on the Flagging obtained from flag_get_entity_flags()");
$this->assertEqual($flag_get_entity_flags_flagging->entity_id, $node->nid, "hook_entity_delete() gets a correct entity ID on the Flagging obtained from flag_get_entity_flags()");
$flag_get_user_flags = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_user_flags'];
$flag_get_user_flags_flagging = $flag_get_user_flags[$flag->name];
$this->assertEqual($flag_get_user_flags_flagging->fid, $flag->fid, "hook_entity_delete() gets a correct fid on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_type, 'node', "hook_entity_delete() gets a correct entity type on the Flagging obtained from flag_get_user_flags()");
$this->assertEqual($flag_get_user_flags_flagging->entity_id, $node->nid, "hook_entity_delete() gets a correct entity ID on the Flagging obtained from flag_get_user_flags()");
// The flag counts have already been decreased.
$flag_get_counts = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_counts'];
$this->assertEqual($flag_get_counts, array(), "hook_entity_delete() gets a correct flag count from flag_get_counts().");
$flag_get_flag_counts = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_flag_counts'];
$this->assertEqual($flag_get_flag_counts, 0, "hook_entity_delete() gets a correct flag count from flag_get_flag_counts().");
// flag_get_entity_flag_counts() queries the {flagging} table, so is not
// updated yet.
$flag_get_entity_flag_counts = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_entity_flag_counts'];
$this->assertEqual($flag_get_entity_flag_counts, 1, "hook_entity_delete() gets a correct flag count from flag_get_entity_flag_counts().");
// flag_get_user_flag_counts() queries the {flagging} table, so is not
// updated yet.
$flag_get_user_flag_counts = $hook_data_variable['hook_entity_delete']['api_calls']['flag_get_user_flag_counts'];
$this->assertEqual($flag_get_user_flag_counts, 1, "hook_entity_delete() gets a correct flag count from flag_get_user_flag_counts().");
}
}

View File

@@ -0,0 +1,12 @@
name = Flag Fields Test
description = Test module for fields on Flagging entities.
dependencies[] = flag
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2015-03-02
version = "7.x-3.6"
core = "7.x"
project = "flag"
datestamp = "1425327793"

View File

@@ -0,0 +1,67 @@
<?php
/**
* @file flag_fields_test.install
* Contains install hooks.
*/
/**
* Implements hook_install().
*/
function flag_fields_test_install() {
// Add a number field to the flagging.
$field = array(
'field_name' => 'flag_fields_test_integer',
'type' => 'number_integer',
'cardinality' => '1',
'settings' => array(),
);
field_create_field($field);
$instance = array(
'field_name' => 'flag_fields_test_integer',
'entity_type' => 'flagging',
'bundle' => 'flag_fields_test_flag',
'label' => 'Test integer',
'widget' => array(
'weight' => 0,
'type' => 'number',
'module' => 'number',
'active' => 0,
'settings' => array(),
),
'settings' => array(
'min' => '',
'max' => '11',
'prefix' => '',
'suffix' => '',
'user_register_form' => FALSE,
),
'display' => array(
'default' => array(
'label' => 'above',
'type' => 'number_integer',
'settings' => array(
'thousand_separator' => ' ',
'decimal_separator' => '.',
'scale' => 0,
'prefix_suffix' => TRUE,
),
'module' => 'number',
'weight' => 1,
),
),
);
field_create_instance($instance);
}
/**
* Implements hook_uninstall().
*
* Not needed for testing, but useful for when developing tests as it allows
* use of Devel module's reinstall tool.
*/
function flag_fields_test_uninstall() {
// Delete our fields.
field_delete_field('flag_fields_test_integer');
}

View File

@@ -0,0 +1,45 @@
<?php
/**
* @file flag_fields_test.module
* Test module for fields on flagging entities.
*/
/**
* Implements hook_flag_default_flags().
*/
function flag_fields_test_flag_default_flags() {
$flags = array();
// Exported flag: "Flag fields test".
$flags['flag_fields_test_flag'] = array(
'entity_type' => 'node',
'title' => 'Flag fields test',
'global' => 1,
'types' => array(),
'flag_short' => 'Flag with the test flag',
'flag_long' => '',
'flag_message' => '',
'unflag_short' => 'Unflag',
'unflag_long' => '',
'unflag_message' => '',
'unflag_denied_text' => '',
'link_type' => 'confirm',
'weight' => -15,
'show_in_links' => array(
'full' => 'full',
'teaser' => 'teaser',
'rss' => 0,
'token' => 0,
'revision' => 0,
),
'show_as_field' => 0,
'show_on_form' => 0,
'access_author' => '',
'show_contextual_link' => 0,
'i18n' => 0,
'flag_confirmation' => 'Confirm flagging this node',
'unflag_confirmation' => 'Confirm unflagging this node',
'api_version' => 3,
);
return $flags;
}

View File

@@ -0,0 +1,13 @@
name = Flag Hooks Test
description = Test module for invocation of flag hooks.
dependencies[] = flag
dependencies[] = rules
core = 7.x
hidden = TRUE
; Information added by Drupal.org packaging script on 2015-03-02
version = "7.x-3.6"
core = "7.x"
project = "flag"
datestamp = "1425327793"

View File

@@ -0,0 +1,184 @@
<?php
/**
* @file flag_hook_test.module
* Test module for the hooks that Flag invokes.
*/
/**
* Store the hook name and parameters into a variable for retrieval by the test.
*
* Hook implementations should call this with their hook name and parameters.
*
* @param $hook_name
* The name of the hook invoked.
* @param $function_parameters
* The array of parameters the hook received.
* @param $flagging
* (optional) The flagging entity that the hook received. If this is given,
* then various flag API functions have their data set into the tracking
* variable for verification by the test case.
*/
function _flag_hook_test_record_invocation($hook_name, $function_parameters, $flagging = NULL) {
$variable = variable_get('flag_hook_test_hook_tracking', array());
$variable[$hook_name] = array();
$variable[$hook_name]['parameters'] = $function_parameters;
// If a Flagging entity was passed in, call API functions and store their data
// for the test case to check.
if (isset($flagging)) {
$flag = flag_get_flag(NULL, $flagging->fid);
$variable[$hook_name]['api_calls'] = array();
$variable[$hook_name]['api_calls']['flag_get_entity_flags'] = flag_get_entity_flags('node', $flagging->entity_id, $flag->name);
$variable[$hook_name]['api_calls']['flag_get_user_flags'] = flag_get_user_flags('node', $flagging->entity_id, $flagging->uid);
$variable[$hook_name]['api_calls']['flag_get_counts'] = flag_get_counts('node', $flagging->entity_id);
$variable[$hook_name]['api_calls']['flag_get_flag_counts'] = flag_get_flag_counts($flag->name);
$variable[$hook_name]['api_calls']['flag_get_entity_flag_counts'] = flag_get_entity_flag_counts($flag, 'node');
$account = user_load($flagging->uid);
$variable[$hook_name]['api_calls']['flag_get_user_flag_counts'] = flag_get_user_flag_counts($flag, $account);
}
variable_set('flag_hook_test_hook_tracking', $variable);
}
/**
* Implements hook_flag_flag().
*/
function flag_hook_test_flag_flag($flag, $entity_id, $account, $flagging) {
_flag_hook_test_record_invocation('hook_flag_flag', func_get_args(), $flagging);
}
/**
* Implements hook_flag_unflag().
*/
function flag_hook_test_flag_unflag($flag, $entity_id, $account, $flagging) {
_flag_hook_test_record_invocation('hook_flag_unflag', func_get_args(), $flagging);
}
/**
* Implements hook_entity_presave().
*/
function flag_hook_test_entity_presave($entity, $type) {
if ($type == 'flagging') {
_flag_hook_test_record_invocation('hook_entity_presave', func_get_args(), $entity);
}
}
/**
* Implements hook_entity_insert().
*/
function flag_hook_test_entity_insert($entity, $type) {
if ($type == 'flagging') {
_flag_hook_test_record_invocation('hook_entity_insert', func_get_args(), $entity);
}
}
/**
* Implements hook_entity_update().
*/
function flag_hook_test_entity_update($entity, $type) {
if ($type == 'flagging') {
_flag_hook_test_record_invocation('hook_entity_update', func_get_args(), $entity);
}
}
/**
* Implements hook_entity_delete().
*/
function flag_hook_test_entity_delete($entity, $type) {
if ($type == 'flagging') {
_flag_hook_test_record_invocation('hook_entity_delete', func_get_args(), $entity);
}
}
// ========================================================= Configuration
/**
* Implements hook_flag_default_flags().
*/
function flag_hook_test_flag_default_flags() {
$flags = array();
$flags['flag_hook_test_flag'] = array(
'entity_type' => 'node',
'title' => 'Test Flag',
'global' => FALSE,
'types' => array(
0 => 'article',
),
'flag_short' => 'Flag this',
'flag_long' => 'Flag this post',
'flag_message' => 'This post has been flagged',
'unflag_short' => 'Unflag this',
'unflag_long' => 'Remove this post from your flagged items',
'unflag_message' => 'This post has been unflagged',
'unflag_denied_text' => 'You may not unflag this item',
'link_type' => 'normal',
'weight' => 0,
'show_in_links' => array(
'full' => TRUE,
'teaser' => TRUE,
),
'show_as_field' => FALSE,
'show_on_form' => FALSE,
'access_author' => '',
'show_contextual_link' => TRUE,
'show_on_profile' => FALSE,
'access_uid' => '',
'api_version' => 3,
);
return $flags;
}
/**
* Implements hook_rules_action_info().
*/
function flag_hook_test_rules_action_info() {
return array(
'flag_test_action' => array(
'label' => t('Flag test action'),
'group' => t('Flag test'),
),
);
}
/**
* Test action for flagging.
*/
function flag_test_action() {
_flag_hook_test_record_invocation('rules_event', func_get_args());
}
/**
* Implements hook_default_rules_configuration().
*/
function flag_hook_test_default_rules_configuration() {
$configs['flag_test_rule_flag'] = rules_import('{ "flag_test_rule" : {
"LABEL" : "Flag test rule",
"PLUGIN" : "reaction rule",
"OWNER" : "rules",
"REQUIRES" : [ "flag_hook_test", "flag" ],
"ON" : { "flag_flagged_flag_hook_test_flag" : [] },
"DO" : [ { "flag_test_action" : [] } ]
}
}');
$configs['flag_test_rule_unflag'] = rules_import('{ "flag_test_rule" : {
"LABEL" : "Flag test rule",
"PLUGIN" : "reaction rule",
"OWNER" : "rules",
"REQUIRES" : [ "flag_hook_test", "flag" ],
"ON" : { "flag_unflagged_flag_hook_test_flag" : [] },
"DO" : [ { "flag_test_action" : [] } ]
}
}');
return $configs;
}

View File

@@ -5,9 +5,9 @@ dependencies[] = flag
package = Flags
hidden = TRUE
; Information added by drupal.org packaging script on 2013-09-13
version = "7.x-3.2"
; Information added by Drupal.org packaging script on 2015-03-02
version = "7.x-3.6"
core = "7.x"
project = "flag"
datestamp = "1379063829"
datestamp = "1425327793"