FlagCookieStorage::drop().
- */
-abstract class FlagCookieStorage {
-
- /**
- * Returns the actual storage object compatible with the flag.
- */
- static function factory($flag) {
- if ($flag->global) {
- return new FlagGlobalCookieStorage($flag);
- }
- else {
- return new FlagNonGlobalCookieStorage($flag);
- }
- }
-
- function __construct($flag) {
- $this->flag = $flag;
- }
-
- /**
- * "Flags" an item.
- *
- * It just records this fact in a cookie.
- */
- abstract function flag($content_id);
-
- /**
- * "Unflags" an item.
- *
- * It just records this fact in a cookie.
- */
- abstract function unflag($content_id);
-
- /**
- * Deletes all the cookies.
- *
- * (Etymology: "drop" as in "drop database".)
- */
- static function drop() {
- FlagGlobalCookieStorage::drop();
- FlagNonGlobalCookieStorage::drop();
- }
-}
-
-/**
- * Storage handler for global flags.
- */
-class FlagGlobalCookieStorage extends FlagCookieStorage {
-
- function flag($content_id) {
- $cookie_key = $this->cookie_key($content_id);
- setcookie($cookie_key, 1, REQUEST_TIME + $this->get_lifetime(), base_path());
- $_COOKIE[$cookie_key] = 1;
- }
-
- function unflag($content_id) {
- $cookie_key = $this->cookie_key($content_id);
- setcookie($cookie_key, 0, REQUEST_TIME + $this->get_lifetime(), base_path());
- $_COOKIE[$cookie_key] = 0;
- }
-
- // Global flags persist for the length of the minimum cache lifetime.
- protected function get_lifetime() {
- $cookie_lifetime = variable_get('cache', 0) ? variable_get('cache_lifetime', 0) : -1;
- // Do not let the cookie lifetime be 0 (which is the no cache limit on
- // anonymous page caching), since it would expire immediately. Usually
- // the no cache limit means caches are cleared on cron, which usually runs
- // at least once an hour.
- if ($cookie_lifetime == 0) {
- $cookie_lifetime = 3600;
- }
- return $cookie_lifetime;
- }
-
- protected function cookie_key($content_id) {
- return 'flag_global_' . $this->flag->name . '_' . $content_id;
- }
-
- /**
- * Deletes all the global cookies.
- */
- static function drop() {
- foreach ($_COOKIE as $key => $value) {
- if (strpos($key, 'flag_global_') === 0) {
- setcookie($key, FALSE, 0, base_path());
- unset($_COOKIE[$key]);
- }
- }
- }
-}
-
-/**
- * Storage handler for non-global flags.
- */
-class FlagNonGlobalCookieStorage extends FlagCookieStorage {
-
- // The anonymous per-user flaggings are stored in a single cookie, so that
- // all of them persist as long as the Drupal cookie lifetime.
-
- function __construct($flag) {
- parent::__construct($flag);
- $this->flaggings = isset($_COOKIE['flags']) ? explode(' ', $_COOKIE['flags']) : array();
- }
-
- function flag($content_id) {
- if (!$this->is_flagged($content_id)) {
- $this->flaggings[] = $this->cookie_key($content_id);
- $this->write();
- }
- }
-
- function unflag($content_id) {
- if (($index = $this->index_of($content_id)) !== FALSE) {
- unset($this->flaggings[$index]);
- $this->write();
- }
- }
-
- protected function get_lifetime() {
- return min((int) ini_get('session.cookie_lifetime'), (int) ini_get('session.gc_maxlifetime'));
- }
-
- protected function cookie_key($content_id) {
- return $this->flag->name . '_' . $content_id;
- }
-
- protected function write() {
- $serialized = implode(' ', array_filter($this->flaggings));
- setcookie('flags', $serialized, REQUEST_TIME + $this->get_lifetime(), base_path());
- $_COOKIE['flags'] = $serialized;
- }
-
- protected function is_flagged($content_id) {
- return $this->index_of($content_id) !== FALSE;
- }
-
- protected function index_of($content_id) {
- return array_search($this->cookie_key($content_id), $this->flaggings);
- }
-
- /**
- * Deletes the cookie.
- */
- static function drop() {
- if (isset($_COOKIE['flags'])) {
- setcookie('flags', FALSE, 0, base_path());
- unset($_COOKIE['flags']);
- }
- }
-}
-
diff --git a/flag.info b/flag.info
deleted file mode 100644
index 6933238..0000000
--- a/flag.info
+++ /dev/null
@@ -1,15 +0,0 @@
-name = Flag
-description = Create customized flags that users can set on content.
-core = 7.x
-package = Flags
-configure = admin/structure/flags
-
-; Files that contain classes.
-files[] = flag.inc
-files[] = flag.rules.inc
-files[] = includes/flag_handler_argument_content_id.inc
-files[] = includes/flag_handler_field_ops.inc
-files[] = includes/flag_handler_filter_flagged.inc
-files[] = includes/flag_handler_relationships.inc
-files[] = includes/flag_plugin_argument_validate_flaggability.inc
-files[] = tests/flag.test
diff --git a/flag.info.yml b/flag.info.yml
new file mode 100644
index 0000000..d62a74d
--- /dev/null
+++ b/flag.info.yml
@@ -0,0 +1,8 @@
+name: Flag
+description: Create customized flags that users can set on entities.
+core: 8.x
+type: module
+package: Flags
+configure: admin/structure/flags
+dependencies:
+ - views_ui
diff --git a/flag.install b/flag.install
index 7ebdf11..52e6bf5 100644
--- a/flag.install
+++ b/flag.install
@@ -6,377 +6,96 @@
*/
/**
- * Implements hook_install().
+ * Implements hook_schema().
*/
-function flag_install() {
-}
-
-/**
- * Implementation of hook_uninstall().
- */
-function flag_uninstall() {
- $result = db_select('variable', 'v')
- ->fields('v', array('name'))
- ->condition('name', 'flag_%', 'LIKE')
- ->execute();
- foreach ($result as $row) {
- variable_del($row->name);
- }
-
- drupal_set_message(t('Flag has been uninstalled.'));
-}
+function flag_schema() {
+ $schema = [];
-/**
- * Implementation of hook_enable().
- *
- * We create the demonstration flag on enable, so hook implementations in flag
- * module will fire correctly, as the APIs are not available on install.
- */
-function flag_enable() {
- // Load the flag API in case we want to use it when enabling.
- include_once(drupal_get_path('module', 'flag') .'/flag.module');
+ $schema['flag_counts'] = [
+ 'description' => 'The number of times an item has been flagged.',
+ 'fields' => [
+ 'fid' => [
+ 'type' => 'varchar',
+ 'length' => '32',
+ ],
+ 'entity_type' => [
+ 'description' => 'The flag type, usually one of "node", "comment", "user".',
+ 'type' => 'varchar',
+ 'length' => '128',
+ ],
+ 'entity_id' => [
+ 'description' => 'The unique ID of the content, usually either the {cid}, {uid}, or {nid}.',
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'disp-width' => '10',
+ ],
+ 'count' => [
+ 'description' => 'The number of times this object has been flagged for this flag.',
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'disp-width' => '10',
+ ],
+ 'last_updated' => [
+ 'description' => 'The UNIX time stamp representing when the flag was last updated.',
+ 'type' => 'int',
+ 'unsigned' => TRUE,
+ 'disp-size' => 11,
+ ],
+ ],
+ 'primary key' => ['fid', 'entity_id'],
+ 'indexes' => [
+ 'fid_entity_type' => ['fid', 'entity_type'],
+ 'entity_type_entity_id' => ['entity_type', 'entity_id'],
+ 'fid_count' => ['fid', 'count'],
+ 'fid_last_updated' => ['fid', 'last_updated'],
+ ],
+ ];
- if (!flag_get_flags()) {
- // Install a demonstration flag only if no flag exists. This is to prevent
- // a case where a disables and enables the module, and the demonstration
- // flag is overwritten or re-created.
- $flag = flag_flag::factory_by_content_type('node');
- $configuration = array(
- 'name' => 'bookmarks',
- 'global' => 0,
- 'show_on_page' => 1,
- 'show_on_teaser' => 1,
- 'show_on_form' => 1,
- // The following UI labels aren't wrapped in t() because they are written
- // to the DB in English. They are passed to t() later, thus allowing for
- // multilingual sites.
- 'title' => 'Bookmarks',
- 'flag_short' => 'Bookmark this',
- 'flag_long' => 'Add this post to your bookmarks',
- 'flag_message' => 'This post has been added to your bookmarks',
- 'unflag_short' => 'Unbookmark this',
- 'unflag_long' => 'Remove this post from your bookmarks',
- 'unflag_message' => 'This post has been removed from your bookmarks',
- 'types' => _flag_install_get_suggested_node_types(),
- );
- $flag->form_input($configuration);
- $flag->save();
- }
+ return $schema;
}
/**
- * Returns some node types to which the demonstration 'bookmarks' flag will apply.
+ * Implements hook_uninstall().
*/
-function _flag_install_get_suggested_node_types() {
- $preferred = array('article', 'story', 'forum', 'blog');
- $existing = array_intersect($preferred, array_keys(node_type_get_types()));
- if (!$existing) {
- // As a last resort, take the first preference.
- return array($preferred[0]);
- }
- return $existing;
+function flag_uninstall() {
+ drupal_set_message(t('Flag has been uninstalled.'));
}
/**
- * Implementation of hook_requirements().
- *
- * Prevent installing this module if the "Flag content" module is installed as well.
+ * Implements hook_requirements().
*/
function flag_requirements($phase) {
- $requirements = array();
- $t = get_t();
- if ($phase == 'install') {
- if (!defined('MAINTENANCE_MODE') && _flag_flag_content_installed()) {
- $requirements['flag_content_clash'] = array(
- 'title' => $t('Flag'),
- 'severity' => REQUIREMENT_ERROR,
- 'description' => _flag_flag_content_message(),
- );
- }
- }
+ $requirements = array();
+ /*
if ($phase == 'runtime') {
- if (module_exists('translation') && !module_exists('translation_helpers')) {
+ if (\Drupal::moduleHandler()->moduleExists('translation') && !\Drupal::moduleHandler()->moduleExists('translation_helpers')) {
$requirements['flag_translation'] = array(
- 'title' => $t('Flag'),
+ 'title' => t('Flag'),
'severity' => REQUIREMENT_ERROR,
- 'description' => $t('To have the flag module work with translations, you need to install and enable the Translation helpers module.'),
- 'value' => $t('Translation helpers module not found.'),
+ 'description' => t('To have the flag module work with translations, you need to install and enable the Translation helpers module.'),
+ 'value' => t('Translation helpers module not found.'),
);
}
- if (module_exists('session_api')) {
+ if (\Drupal::moduleHandler()->moduleExists('session_api')) {
if (file_exists('./robots.txt')) {
$flag_path = url('flag') . '/';
+ // We don't use url() because this may return an absolute URL when
+ // language negotiation is set to 'domain'.
+ $flag_path = parse_url($flag_path, PHP_URL_PATH);
$robots_string = 'Disallow: ' . $flag_path;
$contents = file_get_contents('./robots.txt');
if (strpos($contents, $robots_string) === FALSE) {
$requirements['flag_robots'] = array(
- 'title' => $t('Flag robots.txt problem'),
+ 'title' => t('Flag robots.txt problem'),
'severity' => REQUIREMENT_WARNING,
- 'description' => $t('Flag module may currently be used with anonymous users, however the robots.txt file does not exlude the "@flag-path" path, which may cause search engines to randomly flag and unflag content when they index the site. It is highly recommended to add "@robots-string" to your robots.txt file (located in the root of your Drupal installation).', array('@flag-path' => $flag_path, '@robots-string' => $robots_string)),
- 'value' => $t('Search engines flagging content'),
+ 'description' => t('Flag module may currently be used with anonymous users, however the robots.txt file does not exclude the "@flag-path" path, which may cause search engines to randomly flag and unflag content when they index the site. It is highly recommended to add "@robots-string" to your robots.txt file (located in the root of your Drupal installation).', array('@flag-path' => $flag_path, '@robots-string' => $robots_string)),
+ 'value' => t('Search engines flagging content'),
);
}
}
}
}
+ */
return $requirements;
}
-
-/**
- * Returns TRUE if the "Flag content" module, which we aren't compatible with,
- * is installed.
- */
-function _flag_flag_content_installed() {
- $version = @drupal_get_installed_schema_version('flag_content', TRUE);
- return (isset($version) && $version != SCHEMA_UNINSTALLED);
-}
-
-function _flag_flag_content_message() {
- $t = get_t();
- return $t("You are trying to install the Flag module. However, you have the \"Flag content\" module installed, and these two modules aren't compatible (because they happen to use a database table by the same name). To install the Flag module, you'll first have to disable and then uninstall the \"Flag content\" module.", array('@uninstall-url' => url('admin/modules/uninstall')));
-}
-
-/**
- * Implementation of hook_schema().
- */
-function flag_schema() {
- $schema = array();
-
- $schema['flags'] = array(
- 'fields' => array(
- 'fid' => array(
- 'type' => 'serial',
- 'size' => 'small',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- 'content_type' => array(
- 'type' => 'varchar',
- 'length' => '32',
- 'not null' => TRUE,
- 'default' => '',
- ),
- 'name' => array(
- 'type' => 'varchar',
- 'length' => '32',
- 'not null' => FALSE,
- 'default' => '',
- ),
- 'title' => array(
- 'type' => 'varchar',
- 'length' => '255',
- 'not null' => FALSE,
- 'default' => '',
- ),
- 'global' => array(
- 'type' => 'int',
- 'size' => 'tiny',
- 'not null' => FALSE,
- 'default' => 0,
- ),
- 'options' => array(
- 'type' => 'text',
- 'not null' => FALSE,
- ),
- ),
- 'primary key' => array('fid'),
- 'unique keys' => array(
- 'name' => array('name'),
- ),
- );
-
- $schema['flag_content'] = array(
- 'fields' => array(
- 'fcid' => array(
- 'type' => 'serial',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- ),
- 'fid' => array(
- 'type' => 'int',
- 'size' => 'small',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'content_type' => array(
- 'type' => 'varchar',
- 'length' => '32',
- 'not null' => TRUE,
- 'default' => '',
- ),
- 'content_id' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'uid' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'sid' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'timestamp' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- 'disp-size' => 11,
- )
- ),
- 'primary key' => array('fcid'),
- 'unique keys' => array(
- 'fid_content_id_uid_sid' => array('fid', 'content_id', 'uid', 'sid'),
- ),
- 'indexes' => array(
- 'content_type_content_id' => array('content_type', 'content_id'),
- 'content_type_uid_sid' => array('content_type', 'uid', 'sid'),
- ),
- );
-
- $schema['flag_types'] = array(
- 'fields' => array(
- 'fid' => array(
- 'type' => 'int',
- 'size' => 'small',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'type' => array(
- 'type' => 'varchar',
- 'length' => '32',
- 'not null' => TRUE,
- 'default' => '')
- ),
- 'indexes' => array(
- 'fid' => array('fid'),
- ),
- );
-
- $schema['flag_counts'] = array(
- 'fields' => array(
- 'fid' => array(
- 'type' => 'int',
- 'size' => 'small',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- ),
- 'content_type' => array(
- 'type' => 'varchar',
- 'length' => '32',
- 'not null' => TRUE,
- 'default' => '',
- ),
- 'content_id' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- 'disp-width' => '10',
- ),
- 'count' => array(
- 'type' => 'int',
- 'unsigned' => TRUE,
- 'not null' => TRUE,
- 'default' => 0,
- 'disp-width' => '10',
- )
- ),
- 'primary key' => array('fid', 'content_id'),
- 'indexes' => array(
- 'fid_content_type' => array('fid', 'content_type'),
- 'content_type_content_id' => array('content_type', 'content_id'),
- 'count' => array('count'),
- ),
- );
-
- return $schema;
-}
-
-function flag_update_last_removed() {
- return 6004;
-}
-
-/**
- * Convert role access to have separate "flag" and "unflag" permissions.
- */
-function flag_update_6200() {
- if (db_field_exists('flags', 'roles')) {
- $result = db_select('flags', 'f')
- ->fields('f')
- ->execute();
- foreach ($result as $flag) {
- $roles = array_filter(explode(',', $flag->roles));
- $options = unserialize($flag->options);
- $options['roles'] = array(
- 'flag' => $roles,
- 'unflag' => $roles,
- );
- db_update('flags')
- ->fields(array(
- 'options' => serialize($options),
- ))
- ->condition('fid', $flag->fid)
- ->execute();
- }
- db_drop_field('flags', 'roles');
- }
-}
-
-/**
- * Refine the indexes.
- *
- * The content type inclusion actually slowed down on unique key. And a count
- * index would be helpful for sorting by counts.
- */
-function flag_update_6201() {
- // Remove "content type" from one key, see http://drupal.org/node/612602.
- db_drop_unique_key('flag_content', 'fid_content_type_content_id_uid');
- db_add_unique_key('flag_content', 'fid_content_id_uid', array('fid', 'content_id', 'uid'));
-
- // Add a count index, see http://drupal.org/node/489610.
- db_add_index('flag_counts', 'count', array('count'));
-}
-
-/**
- * Add the sid column and unique index on the flag_content table.
- */
-function flag_update_6202() {
- // Drop the keys affected by the addition of the SID column.
- db_drop_unique_key('flag_content', 'fid_content_id_uid');
- db_drop_index('flag_content', 'content_type_uid');
-
- // Add the column.
- db_add_field('flag_content', 'sid', array('type' => 'int', 'unsigned' => TRUE, 'not null' => TRUE, 'default' => 0));
-
- // Re-add the removed keys.
- db_add_unique_key('flag_content', 'fid_content_id_uid_sid', array('fid', 'content_id', 'uid', 'sid'));
- db_add_index('flag_content', 'content_type_uid_sid', array('content_type', 'uid', 'sid'));
-}
-
-/**
- * Remove count = 0 rows from the count tables.
- */
-function flag_update_6203() {
- db_delete('flag_counts')
- ->condition('count', 0)
- ->execute();
-}
-
-/**
- * Remove "content type" from the flag_counts primary key.
- */
-function flag_update_6204() {
- db_drop_primary_key('flag_counts');
- db_add_primary_key('flag_counts', array('fid', 'content_id'));
-}
diff --git a/flag.links.action.yml b/flag.links.action.yml
new file mode 100644
index 0000000..ea4e830
--- /dev/null
+++ b/flag.links.action.yml
@@ -0,0 +1,5 @@
+flag_add_page_action:
+ route_name: flag.add_page
+ title: 'Add New Flag'
+ appears_on:
+ - flag.list
\ No newline at end of file
diff --git a/flag.links.menu.yml b/flag.links.menu.yml
new file mode 100644
index 0000000..e4282e8
--- /dev/null
+++ b/flag.links.menu.yml
@@ -0,0 +1,5 @@
+flag.admin.structure.flag:
+ title: 'Flags'
+ description: 'Configure flags for marking content with arbitrary information (such as offensive or bookmarked).'
+ parent: system.admin_structure
+ route_name: flag.list
\ No newline at end of file
diff --git a/flag.module b/flag.module
index b0728e8..e159c72 100644
--- a/flag.module
+++ b/flag.module
@@ -5,887 +5,354 @@
* The Flag module.
*/
-define('FLAG_API_VERSION', 2);
+define('FLAG_API_VERSION', 3);
define('FLAG_ADMIN_PATH', 'admin/structure/flags');
define('FLAG_ADMIN_PATH_START', 3);
-include_once dirname(__FILE__) .'/flag.inc';
+use Drupal\Component\Utility\String;
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\Entity\EntityViewDisplay;
+use Drupal\flag\Entity\Flag;
+use Drupal\node\NodeInterface;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\user\UserInterface;
+use Drupal\Core\Form\FormStateInterface;
/**
- * Implements hook_menu().
- */
-function flag_menu() {
- $items[FLAG_ADMIN_PATH] = array(
- 'title' => 'Flags',
- 'page callback' => 'flag_admin_page',
- 'access callback' => 'user_access',
- 'access arguments' => array('administer flags'),
- 'description' => 'Configure flags for marking content with arbitrary information (such as offensive or bookmarked).',
- 'file' => 'includes/flag.admin.inc',
- 'type' => MENU_NORMAL_ITEM,
- );
- $items[FLAG_ADMIN_PATH . '/list'] = array(
- 'title' => 'List',
- 'type' => MENU_DEFAULT_LOCAL_TASK,
- 'weight' => -10,
- );
- $items[FLAG_ADMIN_PATH . '/add'] = array(
- 'title' => 'Add a new flag',
- 'page callback' => 'flag_add_page',
- 'access callback' => 'user_access',
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.admin.inc',
- 'type' => MENU_LOCAL_ACTION,
- 'weight' => 1,
- );
- $items[FLAG_ADMIN_PATH . '/import'] = array(
- 'title' => 'Import',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_import_form'),
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.export.inc',
- 'type' => MENU_LOCAL_TASK,
- 'weight' => 2,
- );
- $items[FLAG_ADMIN_PATH . '/export'] = array(
- 'title' => 'Export',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_export_form'),
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.export.inc',
- 'type' => MENU_LOCAL_TASK,
- 'weight' => 3,
- );
-
- $items[FLAG_ADMIN_PATH . '/manage/%flag'] = array(
- 'load arguments' => array(TRUE), // Allow for disabled flags.
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_form', FLAG_ADMIN_PATH_START + 1),
- 'access callback' => 'user_access',
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.admin.inc',
- 'type' => MENU_CALLBACK,
- // Make the flag title the default title for descendant menu items.
- 'title callback' => '_flag_menu_title',
- 'title arguments' => array(FLAG_ADMIN_PATH_START + 1),
- );
- $items[FLAG_ADMIN_PATH . '/manage/%flag/edit'] = array(
- 'load arguments' => array(TRUE), // Allow for disabled flags.
- 'title' => 'Edit flag',
- 'type' => MENU_DEFAULT_LOCAL_TASK,
- 'weight' => -10,
- );
- $items[FLAG_ADMIN_PATH . '/manage/%flag/export'] = array(
- 'title' => 'Export',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_export_form', FLAG_ADMIN_PATH_START + 1),
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.export.inc',
- 'type' => MENU_LOCAL_TASK,
- 'weight' => 20,
- );
- $items[FLAG_ADMIN_PATH . '/manage/%flag/delete'] = array(
- 'title' => 'Delete flag',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_delete_confirm', FLAG_ADMIN_PATH_START + 1),
- 'access callback' => 'user_access',
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.admin.inc',
- 'type' => MENU_CALLBACK,
- );
- $items[FLAG_ADMIN_PATH . '/manage/%flag/update'] = array(
- 'load arguments' => array(TRUE), // Allow for disabled flags.
- 'title' => 'Update',
- 'page callback' => 'flag_update_page',
- 'page arguments' => array(FLAG_ADMIN_PATH_START + 1),
- 'access arguments' => array('administer flags'),
- 'file' => 'includes/flag.export.inc',
- 'type' => MENU_CALLBACK,
- );
-
- $items['flag/%/%flag/%'] = array(
- 'title' => 'Flag',
- 'page callback' => 'flag_page',
- 'page arguments' => array(1, 2, 3),
- 'access callback' => 'user_access',
- 'access arguments' => array('access content'),
- 'type' => MENU_CALLBACK,
- );
- $items['flag/confirm/%/%flag/%'] = array(
- 'title' => 'Flag confirm',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('flag_confirm', 2, 3, 4),
- 'access callback' => 'user_access',
- 'access arguments' => array('access content'),
- 'type' => MENU_CALLBACK,
- );
-
- return $items;
-}
-
-/**
- * Menu loader for '%flag' arguments.
- *
- * @param $include_disabled
- * Whether to return a disabled flag too. Normally only enabled flags are
- * returned. Some menu items operate on disabled flags and in this case
- * you need to turn on this switch by doing
- * 'load arguments' => array(TRUE) in your menu router.
- *
- * @return
- * Either the flag object, or FALSE if none was found.
+ * Implements hook_help().
*/
-function flag_load($flag_name, $include_disabled = FALSE) {
- if (($flag = flag_get_flag($flag_name))) {
- return $flag;
- }
- else {
- // No enabled flag was found. Search among the disabled ones.
- if ($include_disabled) {
- $default_flags = flag_get_default_flags(TRUE);
- if (isset($default_flags[$flag_name])) {
- return $default_flags[$flag_name];
+function flag_help($route_name, RouteMatchInterface $route_match) {
+ switch ($route_name) {
+ case 'flag.list':
+ $output = '' . t('This page lists all the flags that are currently defined on this system.') . '
'; + return $output; + case 'flag.add_page': + $output = '' . t('Select the type of flag to create. An individual flag can only affect one type of object. This cannot be changed once the flag is created.') . '
'; + return $output; + case 'field_ui.overview_flagging': + // @todo: Doesn't make sense at the moment, implement when form + // functionality is available. + /* + // Get the existing link types that provide a flagging form. + $link_types = flag_get_link_types(); + $form_link_types = array(); + foreach (flag_get_link_types() as $link_type) { + if ($link_type['provides form']) { + $form_link_types[] = '' . $link_type['title'] . ''; + } } - } - } - // A menu loader has to return FALSE (not NULL) when no object is found. - return FALSE; -} -/** - * Menu title callback. - */ -function _flag_menu_title($flag) { - // The following conditional it to handle a D7 bug (@todo: link). - return $flag ? $flag->get_title() : ''; -} + // Get the flag for which we're managing fields. + $flag = menu_get_object('flag', FLAG_ADMIN_PATH_START + 1); + + // Common text. + $output = '' . t('Flags can have fields added to them. For example, a "Spam" flag could have a Reason field where a user could type in why he believes the item flagged is spam. A "Bookmarks" flag could have a Folder field into which a user could arrange her bookmarks.') . '
'; + $output .= '' . t('On this page you can add fields to flags, delete them, and otherwise manage them.') . '
'; + + // Three cases: + if ($flag->link_type == 'form') { + // Case 1: the current link type is the flagging form. Don't tell the + // user anything extra, all is fine. + } + elseif ($link_types[$flag->link_type]['provides form']) { + // Case 2: the current link type shows the form for creation of the + // flagging, but it not the flagging form. Tell the user they can't edit + // existing flagging fields. + $output .= t("Field values may be edited when flaggings are created because this flag's link type shows a form for the flagging. However, to edit field values on existing flaggings, you will need to set your flag to use the Flagging form link type. This is provided by the Flagging Form module.", array( + '!flagging-form-url' => 'http://drupal.org/project/flagging_form', + )); + if (!\Drupal::moduleHandler()->moduleExists('flagging_form')) { + $output .= ' ' + . t("You do not currently have this module enabled.") + . ''; + } + $output .= ''; + } + else { + // Case 3: the current link type does not allow access to the flagging + // form. Tell the user they should change it. + $output .= '' . t("To allow users to enter values for fields you will need to set your flag to use one of the following link types which allow users to access the flagging form: !link-types-list. (In case a form isn't used, the fields are assigned their default values.)", array( + '!form-link-type-url' => url('admin/structure/flags/manage/' . $flag->name, array('fragment' => 'edit-link-type')), + // The list of labels from link types. These are all defined in code + // in hook_flag_link_type_info() and therefore safe to output raw. + '!link-types-list' => implode(', ', $form_link_types), + )) . '
'; + $output .= '' . t("Additionally, to edit field values on existing flaggings, you will need to set your flag to use the Flagging form link type. This is provided by the Flagging Form module.", array( + '!flagging-form-url' => 'http://drupal.org/project/flagging_form', + )); + if (!\Drupal::moduleHandler()->moduleExists('flagging_form')) { + $output .= ' ' + . t("You do not currently have this module enabled.") + . ''; + } + $output .= '
'; + } -/** - * Implements hook_help(). - */ -function flag_help($path, $arg) { - switch ($path) { - case FLAG_ADMIN_PATH: - $output = '' . t('This page lists all the flags that are currently defined on this system.') . '
'; return $output; + */ } } /** - * Implements hook_init(). + * Implements hook_form_FORM_ID_alter(): user_admin_permissions(). + * + * Disable permission on the permissions form that don't make sense for + * anonymous users when Session API module is not enabled. */ -function flag_init() { - $path = drupal_get_path('module', 'flag'); - include_once $path .'/includes/flag.token.inc'; - if (module_exists('trigger')) { - include_once $path .'/includes/flag.actions.inc'; - } - if (module_exists('session_api')) { - // Set the anonymous user SID immediately, in case the user logs in. - flag_set_sid(); +function flag_form_user_admin_permissions_alter(&$form, FormStateInterface $form_state, $form_id) { + if (!\Drupal::moduleHandler()->moduleExists('session_api')) { + $flags = \Drupal::service('flag')->getFlags(); + // Disable flag and unflag permission checkboxes for anonymous users. + foreach ($flags as $flag_name => $flag) { + $form['checkboxes'][DRUPAL_ANONYMOUS_RID]["flag $flag_name"]['#disabled'] = TRUE; + $form['checkboxes'][DRUPAL_ANONYMOUS_RID]["unflag $flag_name"]['#disabled'] = TRUE; + } } } /** - * Implements hook_views_api(). + * Implements hook_entity_extra_field_info(). */ -function flag_views_api() { - return array( - 'api' => 2.0, - 'path' => drupal_get_path('module', 'flag') . '/includes', - ); -} +function flag_entity_extra_field_info() { + $extra = []; + $flag_service = \Drupal::service('flag'); + $flags = $flag_service->getFlags(); + foreach ($flags as $flag) { + // Skip flags that aren't on entities. + $flag_type_plugin = $flag->getFlagTypePlugin(); + if (!($flag_type_plugin instanceof \Drupal\flag\Plugin\Flag\EntityFlagType)) { + continue; + } -/** - * Implements hook_features_api(). - */ -function flag_features_api() { - return array( - 'flag' => array( - 'name' => t('Flag'), - 'feature_source' => TRUE, - 'default_hook' => 'flag_default_flags', - 'file' => drupal_get_path('module', 'flag') . '/includes/flag.features.inc', - ), - ); + foreach ($flag->types as $bundle_name) { + if ($flag_type_plugin->showOnForm()) { + $extra[$flag->entity_type][$bundle_name]['form']['flag'] = [ + 'label' => t('Flags'), + 'description' => t('Checkboxes for toggling flags'), + 'weight' => 10, + ]; + } + + if ($flag_type_plugin->showAsField()) { + $extra[$flag->entity_type][$bundle_name]['display']['flag_' . $flag->id()] = [ + // It would be nicer to use % as the placeholder, but the label is + // run through check_plain() by field_ui_display_overview_form() + // (arguably incorrectly; see http://drupal.org/node/1991292). + 'label' => t('Flag: @title', [ + '@title' => $flag->label, + ]), + 'description' => t('Individual flag link'), + 'weight' => 10, + ]; + } + } + } + + return $extra; } -/** - * Implements hook_permission(). - */ -function flag_permission() { - return array( - 'administer flags' => array( - 'title' => t('administer flags'), - 'description' => t('Create and edit site-wide flags.'), - ), - ); +function flag_node_links_alter(array &$links, NodeInterface $entity, array &$context) { + //@todo: Define this for handling the showOnLinks() flag mode. } /** - * Implements hook_link(). + * Implements hook_entity_view(). * - * This hook does not exist in Drupal 7, it is called from flag_node_view() and - * flag_comment_view() functions. + * Handles the 'show_in_links' and 'show_as_field' flag options. */ -function flag_link($type, $object = NULL, $teaser = FALSE) { - if (!isset($object) || !flag_fetch_definition($type)) { +function flag_entity_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode) { + // Don't show on previews. + if ($entity->isNew()) { return; } - global $user; - // Get all possible flags for this content-type. - $flags = flag_get_flags($type); + // @todo: Add caching here PLZ. - foreach ($flags as $flag) { - $content_id = $flag->get_content_id($object); + // Get all possible flags for this entity type. + $flag_service = \Drupal::service('flag'); + $flags = $flag_service->getFlags($entity->getEntityTypeID(), $entity->bundle()); - if (!$flag->uses_hook_link($teaser)) { - // Flag is not configured to show its link here. - continue; - } - if (!$flag->access($content_id) && (!$flag->is_flagged($content_id) || !$flag->access($content_id, 'flag'))) { - // User has no permission to use this flag or flag does not apply to this - // content. The link is not skipped if the user has "flag" access but - // not "unflag" access (this way the unflag denied message is shown). + foreach ($flags as $flag) { + // Do not display the flag if disabled. + if(!$flag->isEnabled()){ continue; } - // The flag links are actually fully rendered theme functions. - // The HTML attribute is set to TRUE to allow whatever the themer desires. - $links['flag-'. $flag->name] = array( - 'title' => $flag->theme($flag->is_flagged($content_id) ? 'unflag' : 'flag', $content_id), - 'html' => TRUE, - ); - } - - if (isset($links)) { - return $links; - } -} + $link_type_plugin = $flag->getLinkTypePlugin(); + $flag_type_plugin = $flag->getFlagTypePlugin(); -/** - * Implements hook_flag_link(). - * - * When Flag uses a link type provided by this module, it will call this - * implementation of hook_flag_link(). It returns a single link's attributes, - * using the same structure as hook_link(). Note that "title" is provided by - * the Flag configuration if not specified here. - * - * @param $flag - * The full flag object of for the flag link being generated. - * @param $action - * The action this link will perform. Either 'flag' or 'unflag'. - * @param $content_id - * The ID of the node, comment, user, or other object being flagged. - * @return - * An array defining properties of the link. - */ -function flag_flag_link($flag, $action, $content_id) { - $token = flag_get_token($content_id); - return array( - 'href' => 'flag/'. ($flag->link_type == 'confirm' ? 'confirm/' : '') ."$action/$flag->name/$content_id", - 'query' => drupal_get_destination() + ($flag->link_type == 'confirm' ? array() : array('token' => $token)), - ); -} - -/** - * Implements hook_flag_link_types(). - */ -function flag_flag_link_types() { - return array( - 'toggle' => array( - 'title' => t('JavaScript toggle'), - 'description' => t('An AJAX request will be made and degrades to type "Normal link" if JavaScript is not available.'), - 'uses standard js' => TRUE, - 'uses standard css' => TRUE, - ), - 'normal' => array( - 'title' => t('Normal link'), - 'description' => t('A normal non-JavaScript request will be made and the current page will be reloaded.'), - 'uses standard js' => FALSE, - 'uses standard css' => FALSE, - ), - 'confirm' => array( - 'title' => t('Confirmation form'), - 'description' => t('The user will be taken to a confirmation form on a separate page to confirm the flag.'), - 'options' => array( - 'flag_confirmation' => '', - 'unflag_confirmation' => '', - ), - 'uses standard js' => FALSE, - 'uses standard css' => FALSE, - ), - ); -} + // Only add cache key if flag link is displayed. + if ($flag_type_plugin->showAsField() && !$display->getComponent('flag_' . $flag->id())) { + continue; + } -/** - * Implements hook_field_extra_fields(). - */ -function flag_field_extra_fields() { - $extra = array(); - $flags = flag_get_flags('node'); - - // Filter out flags which need to be included on the node form. - foreach ($flags as $name => $flag) { - if (!$flag->show_on_form) { - unset($flags[$name]); + $action = 'flag'; + if ($flag->isFlagged($entity)) { + $action = 'unflag'; } - } - if (!empty($flags)) { - foreach (node_type_get_types() as $type) { - $extra['node'][$type->type]['flag'] = array( - 'label' => t('Flags'), - 'description' => t('Flags fieldset.'), - 'weight' => 0 - ); + // If the user does not have permission, go to the next foreach loop and + // don't display this flag. + if(!$flag->hasActionAccess($action)){ + continue; } + + $link = $link_type_plugin->renderLink($action, $flag, $entity); + $build['flag_' . $flag->id()] = $link; } - return $extra; } /** - * Implements hook_form_alter(). + * Implements hook_entity_build_defaults_alter(). */ -function flag_form_alter(&$form, &$form_state, $form_id) { - global $user; +function flag_entity_build_defaults_alter(array &$build, EntityInterface $entity, $view_mode = 'full', $langcode = NULL) { + // Add the flag ID combined with the action to the cache key if render + // caching is enabled. + if (isset($build['#cache']) && isset($build['#cache']['keys'])) { - if ($form_id == 'node_type_form') { - $flags = flag_get_flags('node', $form['#node_type']->type, $user); - foreach ($flags as $flag) { - if ($flag->show_on_form) { - $var = 'flag_'. $flag->name .'_default'; - $form['workflow']['flag'][$var] = array( - '#type' => 'checkbox', - '#title' => $flag->get_label('flag_short', $form['#node_type']->type), - '#default_value' => variable_get($var .'_'. $form['#node_type']->type, 0), - '#return_value' => 1, - ); - } - } + // Get all possible flags for this entity type. + $flag_service = \Drupal::service('flag'); + $flags = $flag_service->getFlags($entity->getEntityTypeID(), + $entity->bundle()); - if (isset($form['workflow']['flag'])) { - $form['workflow']['flag'] += array( - '#type' => 'item', - '#title' => t('Default flags'), - '#description' => t('Above are the flags you elected to show on the node editing form. You may specify their initial state here.', array('@flag-url' => url(FLAG_ADMIN_PATH))), - // Make the spacing a bit more compact: - '#prefix' => '' . t('The Views module is not installed, or not enabled. It is recommended that you install the Views module to be able to easily produce lists of flagged content.', array('@views-url' => url('http://drupal.org/project/views'))) . '
'; - } - else { - $output .= ''; - $output .= t('Lists of flagged content can be displayed using views. You can configure these in the Views administration section.', array('@views-url' => url('admin/structure/views'))); - if (flag_get_flag('bookmarks')) { - $output .= ' ' . t('Flag module automatically provides a few default views for the bookmarks flag. You can use these as templates by cloning these views and then customizing as desired.', array('@views-url' => url('admin/structure/views', array('query' => array('tag' => 'flag'))))); - } - $output .= ' ' . t('The Flag module handbook contains extensive documentation on creating customized views using flags.', array('@flag-handbook-url' => 'http://drupal.org/handbook/modules/flag', '@customize-url' => 'http://drupal.org/node/296954')); - $output .= '
'; - } - - if (!module_exists('flag_actions')) { - $output .= '' . t('Flagging an item may trigger actions. However, you don\'t have the Flag actions module enabled, so you won\'t be able to enjoy this feature.', array('@actions-url' => url(FLAG_ADMIN_PATH . '/actions'), '@modules-url' => url('admin/modules'))) . '
'; - } - else { - $output .= '' . t('Flagging an item may trigger actions.', array('@actions-url' => url(FLAG_ADMIN_PATH . '/actions'))) . '
'; - } - - if (!module_exists('rules')) { - $output .= '' . t('Flagging an item may trigger rules. However, you don\'t have the Rules module enabled, so you won\'t be able to enjoy this feature. The Rules module is a more extensive solution than Flag actions.', array('@rules-url' => url('http://drupal.org/node/407070'))) . '
'; - } - else { - $output .= '' . t('Flagging an item may trigger rules.', array('@rules-url' => url('admin/config/workflow/rules'))) . '
'; - } - - $output .= '' . t('To learn about the various ways to use flags, please check out the Flag module handbook.', array('@handbook-url' => 'http://drupal.org/handbook/modules/flag')) . '
'; - - return $output; -} - -/** - * Menu callback for adding a new flag. - */ -function flag_add_page($type = NULL, $name = NULL) { - drupal_set_title(t('Add new flag')); - if (isset($type) && isset($name)) { - $flag = flag_flag::factory_by_content_type($type); - $flag->name = $name; - return drupal_get_form('flag_form', $flag); - } - else { - return drupal_get_form('flag_add_form'); - } -} - -/** - * Present a form for creating a new flag, setting the type of flag. - */ -function flag_add_form($form, &$form_state) { - $form['name'] = array( - '#type' => 'textfield', - '#title' => t('Flag name'), - '#description' => t('The machine-name for this flag. It may be up to 32 characters long and may only contain lowercase letters, underscores, and numbers. It will be used in URLs and in all API calls.'), - '#maxlength' => 32, - '#required' => TRUE, - ); - - $types = array(); - foreach (flag_fetch_definition() as $type => $info) { - $types[$type] = $info['title'] . '' . t('The above six texts may contain any of the tokens listed below. For example, "Flag link text" could be entered as:') . '
' . - theme('item_list', array('items' => array( - t('Add <em>[node:title]</em> to your favorites'), - t('Add this [node:type] to your favorites'), - t('Vote for this proposal ([node:flag-vote-count] people have already done so)'), - ), 'attributes' => array('class' => 'token-examples'))) . - '' . t('These tokens will be replaced with the appropriate fields from the node (or user, or comment).') . '
' . - theme('flag_tokens_browser', array('types' => $flag->get_labels_token_types())), - '#collapsible' => TRUE, - '#collapsed' => TRUE, - ); - - $form['access'] = array( - '#type' => 'fieldset', - '#title' => t('Flag access'), - '#tree' => FALSE, - '#weight' => 10, - ); - - $options = array(); - $node_types = node_type_get_types(); - foreach ($node_types as $node_type) { - $options[$node_type->type] = check_plain($node_type->name); - } - $form['access']['types'] = array( - '#type' => 'checkboxes', - '#title' => t('Flaggable content'), - '#options' => $options, - '#default_value' => $flag->types, - '#description' => t('Check any node types that this flag may be used on. You must check at least one node type.'), - '#required' => TRUE, - '#weight' => 10, - '#access' => empty($flag->locked['types']), - ); - - // Disabled access breaks checkboxes unless #value is hard coded. - if (!empty($flag->locked['types'])) { - $form['access']['types']['#value'] = $flag->types; - } - - $form['access']['roles'] = array( - '#title' => t('Roles that may use this flag'), - '#access' => empty($flag->locked['roles']), - '#description' => t('Users may only unflag content if they have access to flag the content initially. Checking authenticated user will allow access for all logged-in users.'), - '#theme' => 'flag_form_roles', - '#theme_wrappers' => array('form_element'), - '#weight' => -2, - '#attached' => array( - 'js' => array(drupal_get_path('module', 'flag') . '/theme/flag-admin.js'), - 'css' => array(drupal_get_path('module', 'flag') . '/theme/flag-admin.css'), - ), - ); - if (module_exists('session_api')) { - $form['access']['roles']['#description'] .= ' ' . t('Support for anonymous users is being provided by Session API.'); - } - else { - $form['access']['roles']['#description'] .= ' ' . t('Anonymous users may flag content if the Session API module is installed.'); - } - - $form['access']['roles']['flag'] = array( - '#type' => 'checkboxes', - '#options' => user_roles(!module_exists('session_api')), - '#default_value' => $flag->roles['flag'], - '#parents' => array('roles', 'flag'), - ); - $form['access']['roles']['unflag'] = array( - '#type' => 'checkboxes', - '#options' => user_roles(!module_exists('session_api')), - '#default_value' => $flag->roles['unflag'], - '#parents' => array('roles', 'unflag'), - ); - - // Disabled access breaks checkboxes unless #value is hard coded. - if (!empty($flag->locked['roles'])) { - $form['access']['roles']['#type'] = 'value'; - $form['access']['roles']['#value'] = $flag->roles; - } - - $form['access']['unflag_denied_text'] = array( - '#type' => 'textfield', - '#title' => t('Unflag not allowed text'), - '#default_value' => $flag->unflag_denied_text, - '#description' => t('If a user is allowed to flag but not unflag, this text will be displayed after flagging. Often this is the past-tense of the link text, such as "flagged".'), - '#access' => empty($flag->locked['unflag_denied_text']), - '#weight' => -1, - ); - - $form['display'] = array( - '#type' => 'fieldset', - '#title' => t('Display options'), - '#description' => t('Flags are usually controlled through links that allow users to toggle their behavior. You can choose how users interact with flags by changing options here. It is legitimate to have none of the following checkboxes ticked, if, for some reason, you wish to place the the links on the page yourself.', array('@placement-url' => 'http://drupal.org/node/295383')), - '#tree' => FALSE, - '#weight' => 20, - ); - - $form['display']['link_type'] = array( - '#type' => 'radios', - '#title' => t('Link type'), - '#options' => _flag_link_type_options(), - '#option_descriptions' => _flag_link_type_descriptions(), - '#flag_link_fields' => _flag_link_type_fields(), - '#after_build' => array('flag_expand_link_option', 'flag_check_link_types'), - '#default_value' => $flag->link_type, - '#weight' => 2, - '#access' => empty($flag->locked['link_type']), - ); - - $form['display']['link_options_intro'] = array( - '#markup' => '' . t('The selected link type may require these additional settings:') . '
', - '#weight' => 20, - ); - - $form['display']['link_options_confirm'] = array( - '#type' => 'fieldset', - '#title' => t('Options for the "Confirmation form" link type'), - // Any "link type" provider module must put its settings fields inside - // a fieldset whose HTML ID is link-options-LINKTYPE, where LINKTYPE is - // the machine-name of the link type. This is necessary for the - // radiobutton's JavaScript dependency feature to work. - '#id' => 'link-options-confirm', - '#weight' => 21, - ); - - $form['display']['link_options_confirm']['flag_confirmation'] = array( - '#type' => 'textfield', - '#title' => t('Flag confirmation message'), - '#default_value' => isset($flag->flag_confirmation) ? $flag->flag_confirmation : '', - '#description' => t('Message displayed if the user has clicked the "flag this" link and confirmation is required. Usually presented in the form of a question such as, "Are you sure you want to flag this content?"'), - '#access' => empty($flag->locked['flag_confirmation']), - ); - - $form['display']['link_options_confirm']['unflag_confirmation'] = array( - '#type' => 'textfield', - '#title' => t('Unflag confirmation message'), - '#default_value' => isset($flag->unflag_confirmation) ? $flag->unflag_confirmation : '', - '#description' => t('Message displayed if the user has clicked the "unflag this" link and confirmation is required. Usually presented in the form of a question such as, "Are you sure you want to unflag this content?"'), - '#access' => empty($flag->locked['unflag_confirmation']), - ); - - $form['submit'] = array( - '#type' => 'submit', - '#value' => t('Submit'), - // We put this button on the form before calling $flag->options_form() - // to give the flag handler a chance to remove it (e.g. flag_broken). - '#weight' => 999, - ); - - $flag->options_form($form); - - return $form; -} - -/** - * Add/Edit flag form validate. - */ -function flag_form_validate($form, &$form_state) { - $form_values = $form_state['values']; - - if ($form_values['link_type'] == 'confirm') { - if (empty($form_values['flag_confirmation'])) { - form_set_error('flag_confirmation', t('A flag confirmation message is required when using the confirmation link type.')); - } - if (empty($form_values['unflag_confirmation'])) { - form_set_error('unflag_confirmation', t('An unflag confirmation message is required when using the confirmation link type.')); - } - } - - - $flag = $form['#flag']; - $flag->form_input($form_values); - $errors = $flag->validate(); - foreach ($errors as $field => $field_errors) { - foreach ($field_errors as $error) { - form_set_error($field, $error['message']); - } - } -} - -/** - * Add/Edit flag form submit. - */ -function flag_form_submit($form, &$form_state) { - $flag = $form['#flag']; - $flag->form_input($form_state['values']); - $flag->save(); - $flag->enable(); - drupal_set_message(t('Flag @name has been saved.', array('@name' => $flag->get_title()))); - _flag_clear_cache(); - $form_state['redirect'] = FLAG_ADMIN_PATH; -} - -/** - * Output the access options for roles in a table. - */ -function theme_flag_form_roles($variables) { - $element = $variables['element']; - - $header = array( - array('class' => array('checkbox'), 'data' => t('Flag')), - array('class' => array('checkbox'), 'data' => t('Unflag')), - t('Role'), - ); - $rows = array(); - foreach (element_children($element['flag']) as $role) { - $row = array(); - $role_name = $element['flag'][$role]['#title']; - unset($element['flag'][$role]['#title']); - unset($element['unflag'][$role]['#title']); - $element['flag'][$role]['#attributes']['class'] = array('flag-access'); - $element['unflag'][$role]['#attributes']['class'] = array('unflag-access'); - $row[] = array('class' => array('checkbox'), 'data' => drupal_render($element['flag'][$role])); - $row[] = array('class' => array('checkbox'), 'data' => drupal_render($element['unflag'][$role])); - $row[] = $role_name; - $rows[] = $row; - } - - return theme('table', array('header' => $header, 'rows' => $rows, 'attributes' => array('class' => array('flag-admin-table'), 'id' => 'flag-roles'))); -} - -/** - * Delete flag page. - */ -function flag_delete_confirm($form, &$form_state, $flag) { - $form['fid'] = array('#type' => 'value', '#value' => $flag->fid); - - return confirm_form($form, - t('Are you sure you want to delete %title?', array('%title' => $flag->get_title())), - !empty($_GET['destination']) ? $_GET['destination'] : FLAG_ADMIN_PATH, - isset($flag->module) ? t('This flag is provided by the %module module. It will loose any customizations and be disabled.', array('%module' => $flag->module)) : t('This action cannot be undone.'), - t('Delete'), t('Cancel') - ); -} - -function flag_delete_confirm_submit($form, &$form_state) { - $flag = flag_get_flag(NULL, $form_state['values']['fid']); - if ($form_state['values']['confirm']) { - $flag->delete(); - $flag->disable(); - _flag_clear_cache(); - } - drupal_set_message(t('Flag @name has been deleted.', array('@name' => $flag->get_title()))); - $form_state['redirect'] = FLAG_ADMIN_PATH; -} - -/** - * FormAPI after_build function to add descriptions to radio buttons. - */ -function flag_expand_link_option($element) { - $element['#attached'] = array( - 'js' => array(drupal_get_path('module', 'flag') . '/theme/flag-admin.js'), - ); - - foreach (element_children($element) as $key) { - // Add a description to the link option. - if (isset($element['#option_descriptions'][$key])) { - $element[$key]['#description'] = $element['#option_descriptions'][$key]; - } - } - $element['#attributes']['class'] = array('flag-link-options'); - - return $element; -} - -/** - * FormAPI after_build function to check that the link type exists. - */ -function flag_check_link_types($element) { - $link_types = flag_get_link_types(); - if (!isset($link_types[$element['#value']])) { - drupal_set_message(t('This flag uses a link type of %type, which does not exist.', array('%type' => $element['#value'])), 'error'); - } - return $element; -} - -/** - * Clears various caches when a flag is modified. - */ -function _flag_clear_cache() { - if (module_exists('views')) { - views_invalidate_cache(); - } - // Reset our flags cache, thereby making the following code aware of the - // modifications. - flag_get_flags(NULL, NULL, NULL, TRUE); - // The title of a flag may appear in the menu (indirectly, via our "default - // views"), so we need to clear the menu cache. This call also clears the - // page cache, which is desirable too because the flag labels may have - // changed. - menu_rebuild(); -} diff --git a/includes/flag.export.inc b/includes/flag.export.inc deleted file mode 100644 index 26ffc0e..0000000 --- a/includes/flag.export.inc +++ /dev/null @@ -1,245 +0,0 @@ -is_compatible()) { - drupal_set_message(t('Could not export flag %flag-name: Your flag was created by a different version of the Flag module than is now being used.', array('%flag-name' => $flag->name)), 'error'); - continue; - } - - $flag->api_version = FLAG_API_VERSION; - $new_flag = (array) $flag; - - if (!empty($module)) { - // Even though Flag adds the module name itself later, we add the module - // name here for reference by other modules (such as Features). - $new_flag['module'] = $module; - // Lock the flag name, as is normally desired by modules using - // hook_flag_default_flags(), and needed by Features. - $new_flag['locked'] = array('name'); - } - // Allow other modules to change the exported flag. - drupal_alter('flag_export', $new_flag); - - // Remove the flag ID. - unset($new_flag['fid']); - // The name is emitted as the key for the array. - unset($new_flag['name']); - - $output .= $indent . '// Exported flag: "'. check_plain($flag->get_title()) . '"' . ".\n"; - $output .= $indent . '$flags[\'' . $flag->name . '\'] = ' . (function_exists('features_var_export') ? features_var_export($new_flag, $indent) : var_export($new_flag, TRUE)) . ";\n"; - } - $output .= $indent . 'return $flags;'; - return $output; -} - -/** - * Form to import a flag. - */ -function flag_import_form() { - $form = array(); - - $form['import'] = array( - '#title' => t('Flag import code'), - '#type' => 'textarea', - '#default_value' => '', - '#rows' => 15, - '#required' => TRUE, - '#description' => t('Paste the code from a flag export here to import it into you site. Flags imported with the same name will update existing flags. Flags with a new name will be created.', array('@export-url' => url(FLAG_ADMIN_PATH . '/export'))), - ); - $form['submit'] = array( - '#value' => t('Import'), - '#type' => 'submit', - ); - - return $form; -} - -/** - * Validate handler; Import a flag. - */ -function flag_import_form_validate($form, &$form_state) { - $flags = array(); - ob_start(); - eval($form_state['values']['import']); - ob_end_clean(); - - if (!isset($flags) || !is_array($flags)) { - form_set_error('import', t('A valid list of flags could be found in the import code.')); - return; - } - - // Create the flag object. - foreach ($flags as $flag_name => $flag_info) { - // Backward compatibility: old exported flags have their names in $flag_info - // instead, so we use the += operator to not overwrite it. - $flag_info += array( - 'name' => $flag_name, - ); - $new_flag = flag_flag::factory_by_array($flag_info); - - // Give new flags with the same name a matching FID, which tells Flag to - // update the existing flag, rather than creating a new one. - if ($existing_flag = flag_get_flag($new_flag->name)) { - $new_flag->fid = $existing_flag->fid; - } - - if ($errors = $new_flag->validate()) { - $message = t('The import of the %flag flag failed because the following errors were encountered during the import:', array('%flag' => $new_flag->name)); - $message_errors = array(); - foreach ($errors as $field => $field_errors) { - foreach ($field_errors as $error) { - $message_errors[] = $error['message']; - } - } - form_set_error('import', $message . theme('item_list', array('items' => $message_errors))); - } - else { - // Save the new flag for the submit handler. - $form_state['flags'][] = $new_flag; - } - } -} - -/** - * Submit handler; Import a flag. - */ -function flag_import_form_submit($form, &$form_state) { - module_load_include('inc', 'flag', 'includes/flag.admin'); - - foreach ($form_state['flags'] as $flag) { - $flag->save(); - if (!empty($flag->status)) { - $flag->enable(); - } - if ($flag->is_new) { - drupal_set_message(t('Flag @name has been imported.', array('@name' => $flag->name))); - } - else { - drupal_set_message(t('Flag @name has been updated.', array('@name' => $flag->name))); - } - } - _flag_clear_cache(); - - $form_state['redirect'] = FLAG_ADMIN_PATH; -} - -/** - * Export a flag and display it in a form. - */ -function flag_export_form($form, &$form_state, $flag = NULL) { - // If we were passed a flag, use it as the list of flags to export. - if ($flag) { - $flags = array($flag); - } - - // Display a list of flags to export. - if (!isset($flags)) { - if (isset($form_state['values']['flags'])) { - $flags = array(); - foreach ($form_state['values']['flags'] as $flag_name) { - if ($flag_name && $flag = flag_get_flag($flag_name)) { - $flags[] = $flag; - } - } - } - else { - $form['flags'] = array( - '#type' => 'checkboxes', - '#title' => t('Flags to export'), - '#options' => drupal_map_assoc(array_keys(flag_get_flags())), - '#description' => t('Exporting your flags is useful for moving flags from one site to another, or when including your flag definitions in a module.'), - ); - $form['submit'] = array( - '#type' => 'submit', - '#value' => t('Export'), - ); - } - } - - if (isset($flags)) { - $code = flag_export_flags($flags); - - // Link to the Features page if module is present, otherwise link to the - // Drupal project page. - $features_link = module_exists('features') ? url('admin/build/features') : url('http://drupal.org/project/features'); - - $form['export'] = array( - '#type' => 'textarea', - '#title' => t('Flag exports'), - '#description' => t('Use the exported code to later import it. Exports can be included in modules using hook_flag_default_flags() or using the Features module.', array('@import-flag' => url(FLAG_ADMIN_PATH . '/import'), '@features-url' => $features_link)), - '#value' => $code, - '#rows' => 15, - ); - } - - return $form; -} - -/** - * Submit handler; Rebuild the export form after the list of flags has been set. - */ -function flag_export_form_submit($form, &$form_state) { - $form_state['rebuild'] = TRUE; -} - -/** - * Page for displaying an upgrade message and export form for Flag 1.x flags. - */ -function flag_update_page($flag) { - if ($flag->is_compatible()) { - drupal_set_message(t('The flag %name is already up-to-date with the latest Flag API and does not need upgrading.')); - drupal_goto(FLAG_ADMIN_PATH); - } - - drupal_set_message(t('The flag %name is currently using the Flag API version @version, which is not compatible with the current version of Flag. You can upgrade this flag by pasting the below code into @module_flag_default_flags() function in the @module.module file.', array('%name' => $flag->name, '@version' => $flag->api_version, '@module' => $flag->module)), 'warning'); - - flag_update_export($flag); - - return drupal_get_form('flag_export_form', $flag); -} - -/** - * Update a flag before export. - * - * @param $flag - * The flag object passed by reference. - */ -function flag_update_export(&$flag) { - // Update differences. - if (empty($flag->api_version) || $flag->api_version == 1) { - if (isset($flag->roles) && !isset($flag->roles['flag'])) { - $flag->roles = array( - 'flag' => $flag->roles, - 'unflag' => $flag->roles, - ); - } - $flag->api_version = FLAG_API_VERSION; - } -} diff --git a/includes/flag.features.inc b/includes/flag.features.inc deleted file mode 100644 index eff1081..0000000 --- a/includes/flag.features.inc +++ /dev/null @@ -1,97 +0,0 @@ - $flag) { - // Get the module that provided the flag definition. - if ($flag = flag_load($flag, TRUE)) { - $module = $modules[$flag->content_type]; - $export['dependencies'][$module] = $module; - $export['features']['flag'][$flag->name] = $flag->name; - } - } - - return $pipe; -} - -/** - * Implementation of hook_features_export_options(). - */ -function flag_features_export_options() { - $options = array(); - // Get all flags, including disabled defaults. - $flags = flag_get_flags() + flag_get_default_flags(TRUE); - foreach ($flags as $name => $flag) { - $options[$name] = ucfirst(check_plain($flag->content_type)) .': '. check_plain($flag->title); - } - return $options; -} - -/** - * Implementation of hook_features_export_render(). - */ -function flag_features_export_render($module, $data) { - module_load_include('inc', 'flag', '/includes/flag.export'); - $code = flag_export_flags($data, $module, ' '); - return array('flag_default_flags' => $code); -} - -/** - * Implementation of hook_features_revert(). - * - * @param $module - * The name of module for which to revert content. - */ -function flag_features_revert($module = NULL) { - // Get default flags from features. - if (module_hook($module, 'flag_default_flags')) { - module_load_include('inc', 'flag', '/includes/flag.admin'); - $default_flags = module_invoke($module, 'flag_default_flags'); - - // Revert flags that are defined in code. - foreach ($default_flags as $flag_name => $flag_info) { - if (is_numeric($flag_name)) { - // Backward compatibility. - $flag_name = $flag_info['name']; - } - $flag = flag_load($flag_name, TRUE); - if ($flag && $flag->revert() === FALSE) { - drupal_set_message(t('Could not revert flag %flag-name to the state described in your code: Your flag was created by a different version of the Flag module than is now being used.', array('%flag-name' => $flag->name)), 'error'); - } - } - _flag_clear_cache(); - } - else { - drupal_set_message(t('Could not load default flag.'), 'error'); - return FALSE; - } - return TRUE; -} - -/** - * Helper function; Retrieve the providing modules defining the flags. - */ -function flag_features_providing_module() { - $modules = array(); - $hook = 'flag_definitions'; - foreach (module_implements($hook) as $module) { - foreach (module_invoke($module, $hook) as $key => $value) { - $modules[$key] = $module; - } - } - return $modules; -} diff --git a/includes/flag.services.inc b/includes/flag.services.inc deleted file mode 100644 index 872b560..0000000 --- a/includes/flag.services.inc +++ /dev/null @@ -1,90 +0,0 @@ -access($content_id, $action, $account)) { - // User has no permission to use this flag. - return FALSE; - } - return TRUE; - } -} - -/** - * Service wrapper to flag a content. - * - * @param $flag_name - * The flag name. - * @param $content_id - * The content ID to check if it was flagged. - * @param $uid - * The user ID to check if they flagged the content. - * @param $action - * The action. Should be "flag" or "unflag". - * @return - * TRUE if content was flagged. - */ -function flag_service_flag($flag_name, $content_id, $uid = NULL, $action = 'flag', $skip_permission_check = FALSE) { - global $user; - $account = empty($uid) ? $user : user_load($uid); - $flag = flag_get_flag($flag_name); - $skip_permission_check = (boolean) $skip_permission_check; - return $flag->flag($action, $content_id, $account, $skip_permission_check); -} - -/** - * Service wrapper to check if a content is flagged by a user. - * - * @param $flag_name - * The flag name. - * @param $content_id - * The content ID to check if it was flagged. - * @param $uid - * The user ID to check if they flagged the content. - * @return - * TRUE if content was flagged. - */ -function flag_service_is_flagged($flag_name, $content_id, $uid = NULL) { - $flag = flag_get_flag($flag_name); - return $flag->is_flagged($content_id, $uid); -} diff --git a/includes/flag.views.inc b/includes/flag.views.inc deleted file mode 100644 index 630ea26..0000000 --- a/includes/flag.views.inc +++ /dev/null @@ -1,255 +0,0 @@ - array( - 'path' => drupal_get_path('module', 'flag') . '/includes', - ), - 'handlers' => array( - 'flag_handler_relationship_content' => array( - 'parent' => 'views_handler_relationship', - 'file' => 'flag_handler_relationships.inc', - ), - 'flag_handler_relationship_counts' => array( - 'parent' => 'views_handler_relationship', - 'file' => 'flag_handler_relationships.inc', - ), - 'flag_handler_relationship_user_content' => array( - 'parent' => 'views_handler_relationship', - 'file' => 'flag_handler_relationships.inc', - ), - 'flag_handler_field_ops' => array( - 'parent' => 'views_handler_field', - ), - 'flag_handler_filter_flagged' => array( - 'parent' => 'views_handler_filter_boolean_operator', - ), - 'flag_handler_argument_content_id' => array( - 'parent' => 'views_handler_argument_numeric', - ), - ), - ); -} - -/** - * Implementation of hook_views_plugins(). - */ -function flag_views_plugins() { - return array( - 'argument validator' => array( - 'flag_flaggable_node' => array( - 'title' => t('Flaggable node'), - 'flag type' => 'node', - 'handler' => 'flag_plugin_argument_validate_flaggability', - 'path' => drupal_get_path('module', 'flag') . '/includes', - ), - 'flag_flaggable_user' => array( - 'title' => t('Flaggable user'), - 'flag type' => 'user', - 'handler' => 'flag_plugin_argument_validate_flaggability', - 'path' => drupal_get_path('module', 'flag') . '/includes', - ), - // A comment validator won't be very useful. Moreover, having it will - // contribute to the argument object's $options polution, so let's skip - // it. - ), - ); -} -/** - * Implementation of hook_views_data(). - */ -function flag_views_data() { - $data = array(); - - $data['flag_content']['table']['group'] = t('Flags'); - $data['flag_counts']['table']['group'] = t('Flags'); - - $data['flag_content']['uid'] = array( - 'title' => t('User'), - 'help' => t('The user that flagged an item.'), - 'relationship' => array( - 'base' => 'users', - 'handler' => 'views_handler_relationship', - 'label' => t('Flag user'), - ), - ); - - $data['flag_content']['timestamp'] = array( - 'title' => t('Flagged time'), - 'help' => t('Display the time the content was flagged by a user.'), - 'field' => array( - 'handler' => 'views_handler_field_date', - 'click sortable' => TRUE, - ), - 'sort' => array( - 'handler' => 'views_handler_sort_date', - ), - 'filter' => array( - 'handler' => 'views_handler_filter_date', - ), - 'argument' => array( - 'handler' => 'views_handler_argument_date', - ), - ); - - // Argument for content ID, used for "Who's flagged this" views. - $data['flag_content']['content_id'] = array( - 'title' => t('Content ID'), - 'help' => t('The unique ID of the object that has been flagged.'), - 'argument' => array( - 'handler' => 'flag_handler_argument_content_id', - ), - ); - - // Specialized is null/is not null filter. - $data['flag_content']['flagged'] = array( - 'title' => t('Flagged'), - 'help' => t('Filter to ensure content has or has not been flagged.'), - 'real field' => 'uid', - 'filter' => array( - 'handler' => 'flag_handler_filter_flagged', - 'label' => t('Flagged'), - ), - ); - - // Flag content links. - $data['flag_content']['ops'] = array( - 'title' => t('Flag link'), - 'help' => t('Display flag/unflag link.'), - 'field' => array( - 'handler' => 'flag_handler_field_ops', - ), - ); - - $data['flag_counts']['count'] = array( - 'title' => t('Flag counter'), - 'help' => t('The number of times a piece of content is flagged by any user.'), - 'field' => array( - 'handler' => 'views_handler_field_numeric', - 'click sortable' => TRUE, - ), - 'sort' => array( - 'handler' => 'views_handler_sort', - ), - 'filter' => array( - 'handler' => 'views_handler_filter_numeric', - ), - 'argument' => array( - 'handler' => 'views_handler_argument_numeric', - ), - ); - - return $data; -} - -/** - * Implementation of hook_views_data_alter(). - */ -function flag_views_data_alter(&$data) { - - foreach (array_keys(flag_fetch_definition()) as $flag_type) { - $flag = flag_flag::factory_by_content_type($flag_type); - $info = $flag->get_views_info(); - - // Add the flag relationship. - $data[$info['views table']]['flag_content_rel'] = array( - 'group' => t('Flags'), - 'title' => $info['title'], - 'help' => $info['help'], - 'relationship' => array( - 'flag type' => $flag_type, - 'handler' => 'flag_handler_relationship_content', - 'label' => t('flag'), - 'base' => 'flag_content', - 'base field' => 'content_id', - 'relationship field' => $info['join field'], - ), - ); - - // Add the flag counter relationship. - $data[$info['views table']]['flag_count_rel'] = array( - 'group' => t('Flags'), - 'title' => $info['counter title'], - 'help' => $info['counter help'], - 'relationship' => array( - 'flag type' => $flag_type, - 'handler' => 'flag_handler_relationship_counts', - 'label' => t('counter'), - 'base' => 'flag_counts', - 'base field' => 'content_id', - 'relationship field' => $info['join field'], - ), - ); - } - - // Add a relationship for the user that flagged any type of content. - $data['users']['flag_user_content_rel'] = array( - 'group' => t('Flags'), - 'title' => t("User's flagged content"), - 'help' => t('Limit results to users that have flagged certain content.'), - 'relationship' => array( - 'base' => 'flag_content', - 'base field' => 'uid', - 'relationship field' => 'uid', - 'handler' => 'flag_handler_relationship_user_content', - 'label' => t('user flagged content'), - ), - ); -} - -/** - * Implements hook_views_query_substitutions(). - * - * Allow replacement of current user's session id so we can cache these queries. - */ -function flag_views_query_substitutions() { - return array( - '***FLAG_CURRENT_USER_SID***' => flag_get_sid(), - ); -} -/** - * A helper function that creates a radio list of available flags. - * - * This function is used to select the desired flag when setting up flag - * relationships and fields. - */ -function flag_views_flag_config_form($form_type, $content_type, $current_flag) { - $flags = flag_get_flags($content_type); - - $options = array(); - foreach ($flags as $flag) { - $options[$flag->name] = $flag->get_title(); - } - - $form = array( - '#type' => $form_type, - '#title' => t('Flag'), - '#options' => $options, - '#default_value' => $current_flag, - '#required' => TRUE, - ); - - return $form; -} - -/** - * Helper function that gets the first defined flag and returns its name. - */ -function flag_views_flag_default($content_type) { - static $default_flag = array(); - - if (!array_key_exists($content_type, $default_flag)) { - $flag = array_shift(flag_get_flags($content_type)); - $default_flag[$content_type] = $flag ? $flag->name : NULL; - } - - return $default_flag[$content_type]; -} diff --git a/includes/flag.views_convert.inc b/includes/flag.views_convert.inc deleted file mode 100644 index 4cc815d..0000000 --- a/includes/flag.views_convert.inc +++ /dev/null @@ -1,234 +0,0 @@ -add_item() won't produce - * the right results, usually needed to set field options or values. - */ -function flag_views_convert($display, $type, &$view, $field, $id) { - static $flag_name; - - // First, replace any sign of views_bookmark with flag's Views 1 equivelant. - $key_search = array( - '^views_bookmark_ops_([0-9]+)' => 'flag_ops_', - '^views_bookmark_nodes_([0-9]+)' => 'flag_content_', - '^views_bookmark_users_([0-9]+)' => 'flag_users_', - '^views_bookmark_node_count_([0-9]+)' => 'flag_counts_', - ); - foreach ($field as $property => $value) { - foreach ($key_search as $search => $replace) { - if (!empty($value) && is_string($value) && preg_match('/'. $search .'/', $value, $matches)) { - $flag = flag_get_flag(NULL, $matches[1]); - $replace = $replace . $flag->name; - $field[$property] = preg_replace('/'. $search .'/', $replace, $value); - } - } - } - - // Create a table/field identifier for this field. - foreach (array('flag_ops_', 'flag_content_', 'flag_users_', 'flag_counts_') as $table) { - if (strpos($field['tablename'], $table) === 0) { - $name = str_replace($table, '', $field['tablename']); - if (!empty($name) && !isset($flag_name)) { - $flag_name = $name; - } - } - } - - // Now update values, options, etc. to those selected in the imported view. - switch ($type) { - case 'field': - switch ($id) { - case 'ops': - $new_field = array( - 'label' => $field['label'], - 'id' => 'ops', - 'table' => 'flag_content', - 'field' => 'ops', - 'relationship' => 'flag_content_rel', - ); - $new_rel = 'flag_content_rel'; - $flag_content_rel_user = 'current'; - break; - case 'count': - $new_field = array( - 'label' => $field['label'], - 'id' => 'count', - 'table' => 'flag_counts', - 'field' => 'count', - 'relationship' => 'flag_counts_rel', - ); - $new_rel = 'flag_counts_rel'; - break; - case 'name': - $new_field = array( - 'label' => $field['label'], - 'link_to_user' => 1, - 'id' => 'name', - 'table' => 'users', - 'field' => 'name', - 'relationship' => 'uid', - ); - $new_rel = 'uid'; - break; - } - break; - - case 'filter': - case 'exposed_filter': - switch ($id) { - case 'uid': - // The flag_content uid filter means "Include content only flagged by - // the current user". In D6, this is no longer a filter, but instead - // part of the relationship. Make the relationship join on the uid. - if ($field['value'] == '***CURRENT_USER***') { - $new_rel = 'flag_content_rel'; - $flag_content_rel_user = 'current'; - } - // Remove the old filter. - $view->set_item('default', $type, $id, NULL); - break; - case 'timestamp': - $new_field = array( - 'operator' => $field['operator'], - 'value' => flag_views_convert_timestamp_value($field['value']), - 'group' => 0, - 'id' => 'timestamp', - 'table' => 'flag_content', - 'field' => 'timestamp', - 'relationship' => 'flag_content_rel', - 'exposed' => $type == 'exposed_filter' ? 1 : 0, - ); - $new_rel = 'flag_content_rel'; - drupal_set_message(t('Flag is not able to convert the Flagged time filter. It\'s value is currently empty, but needs to be populated to work properly.'), 'warning'); - break; - case 'count': - $new_field = array( - 'operator' => $field['operator'], - 'value' => array('value' => $field['value']), - 'group' => 0, - 'id' => 'count', - 'table' => 'flag_counts', - 'field' => 'count', - 'relationship' => 'flag_counts_rel', - 'exposed' => $type == 'exposed_filter' ? 1 : 0, - ); - $new_rel = 'flag_counts_rel'; - break; - } - break; - - case 'argument': - // Flag in Drupal 5 only provides one argument, and in Views 1 arguments - // weren't given and ID, so we use the field type. - if (strpos($field['type'], 'flag_content_') === 0) { - $new_field = array( - 'id' => 'uid', - 'table' => 'users', - 'field' => 'uid', - 'relationship' => 'uid', - ); - $new_rel = 'uid'; - } - break; - - case 'sort': - switch ($id) { - case 'count': - $new_field = array( - 'order' => $field['sortorder'], - 'id' => 'count', - 'table' => 'flag_counts', - 'field' => 'count', - 'relationship' => 'flag_counts_rel', - ); - $new_rel = 'flag_counts_rel'; - break; - case 'timestamp': - $new_field = array( - 'order' => $field['sortorder'], - 'id' => 'timestamp', - 'table' => 'flag_content', - 'field' => 'timestamp', - 'relationship' => 'flag_content_rel', - ); - $new_rel = 'flag_content_rel'; - break; - } - break; - } - - // Add any new fields. - if (isset($new_field)) { - // Exposed filters are now wrapped into filters. - $type = $type == 'exposed_filter' ? 'filter' : $type; - // Update the type in the view options. - $view->set_item('default', $type, $id, $new_field); - } - - // Add any new relationships (but only once per view). - if (isset($new_rel) && !isset($view->display[$display]->display_options['relationships'][$new_rel])) { - if ($new_rel == 'flag_content_rel') { - $view->display[$display]->display_options['relationships'][$new_rel] = array( - 'label' => $flag_name, - 'required' => 1, - 'flag' => $flag_name, - 'user_scope' => 'any', - 'id' => 'flag_content_rel', - 'table' => 'node', - 'field' => 'flag_content_rel', - 'relationship' => 'none', - ); - } - elseif ($new_rel == 'flag_counts_rel') { - $view->display[$display]->display_options['relationships'][$new_rel] = array( - 'label' => $flag_name .' counts', - 'required' => 0, - 'flag' => $flag_name, - 'id' => 'flag_counts_rel', - 'table' => 'node', - 'field' => 'flag_counts_rel', - 'relationship' => 'none', - ); - } - elseif ($new_rel == 'uid') { - $view->display[$display]->display_options['relationships'][$new_rel] = array( - 'label' => isset($flag_name) ? $flag_name .' user' : 'user', - 'required' => 0, - 'id' => 'uid', - 'table' => 'flag_content', - 'field' => 'uid', - 'relationship' => 'flag_content_rel', - ); - } - } - - // Modify relationships if needed. - if (isset($flag_content_rel_user) && isset($view->display[$display]->display_options['relationships']['flag_content_rel'])) { - $view->display[$display]->display_options['relationships']['flag_content_rel']['user_scope'] = 'current'; - } -} - -/** - * In Views 1, dates were simply stored as a single string. In Views 2, the - * value is stored as an array of options. - */ -function flag_views_convert_timestamp_value($value) { - $type = 'date'; - if (stripos($value, 'now') !== FALSE) { - $type = 'offset'; - $value = trim(str_ireplace('now', '', $value)); - } - return array( - 'type' => $type, - 'value' => $value, - 'min' => '', - 'max' => '', - ); -} diff --git a/includes/flag.views_default.inc b/includes/flag.views_default.inc deleted file mode 100644 index 21acacc..0000000 --- a/includes/flag.views_default.inc +++ /dev/null @@ -1,279 +0,0 @@ - array( - 'id' => 'type', - 'table' => 'node', - 'field' => 'type', - 'label' => 'Type', - ), - 'title' => array( - 'id' => 'title', - 'table' => 'node', - 'field' => 'title', - 'label' => 'Title', - 'link_to_node' => 1, - ), - 'name' => array( - 'label' => 'Author', - 'link_to_user' => 1, - 'id' => 'name', - 'table' => 'users', - 'field' => 'name', - ), - ); - - $style_options = array( - 'grouping' => '', - 'override' => 0, - 'sticky' => 1, - 'columns' => array(), - 'default' => 'title', - 'order' => 'asc', - 'columns' => array( - 'type' => 'type', - 'title' => 'title', - 'name' => 'name', - ), - 'info' => array( - 'type' => array( - 'sortable' => TRUE, - ), - 'title' => array( - 'sortable' => TRUE, - ), - 'name' => array( - 'sortable' => TRUE, - ), - ), - 'override' => FALSE, - 'order' => 'asc', - ); - - $filters = array( - 'status' => array( - 'operator' => '=', - 'value' => 1, - 'group' => '0', - 'exposed' => FALSE, - 'expose' => array( - 'operator' => FALSE, - 'label' => '', - ), - 'id' => 'status', - 'table' => 'node', - 'field' => 'status', - 'relationship' => 'none', - ), - ); - - $relationships = array( - 'flag_content_rel' => array( - 'label' => 'bookmarks', - 'required' => 1, - 'flag' => 'bookmarks', - 'user_scope' => 'current', - 'id' => 'flag_content_rel', - 'table' => 'node', - 'field' => 'flag_content_rel', - 'relationship' => 'none', - 'override' => array( - 'button' => 'Override', - ), - ), - ); - - $access = array( - 'type' => 'role', - 'role' => drupal_map_assoc($flag->roles['flag']), - 'perm' => '', - ); - - // Additional fields and style options if comment exists. - if (module_exists('comment')) { - $fields += array( - 'comment_count' => array( - 'id' => 'comment_count', - 'table' => 'node_comment_statistics', - 'field' => 'comment_count', - 'label' => 'Replies', - ), - 'last_comment_timestamp' => array( - 'id' => 'last_comment_timestamp', - 'table' => 'node_comment_statistics', - 'field' => 'last_comment_timestamp', - 'label' => 'Last Post', - ), - ); - - $style_options['default'] = 'last_comment_timestamp'; - $style_options['order'] = 'desc'; - $style_options['info'] += array( - 'comment_count' => array( - 'sortable' => TRUE, - ), - 'last_comment_timestamp' => array( - 'sortable' => TRUE, - ), - ); - $style_options['columns'] += array( - 'comment_count' => 'comment_count', - 'last_comment_timestamp' => 'last_comment_timestamp', - ); - } - - $views = array(); - - /* Individual users user/%/bookmarks tab. */ - - // Additional relationship for this view. - $relationships_tab = $relationships; - $relationships_tab['flag_content_rel']['user_scope'] = 'any'; - $relationships_tab += array( - 'uid' => array( - 'label' => 'bookmarks_user', - 'required' => 1, - 'id' => 'uid', - 'table' => 'flag_content', - 'field' => 'uid', - 'relationship' => 'flag_content_rel', - ), - ); - - // Additional argument for this view. - $arguments_tab = array( - 'uid' => array( - 'default_action' => 'empty', - 'style_plugin' => 'default_summary', - 'style_options' => array(), - 'wildcard' => 'all', - 'wildcard_substitution' => 'All', - 'title' => '%1\'s bookmarks', - 'default_argument_type' => 'fixed', - 'default_argument' => '', - 'validate_type' => 'none', - 'validate_fail' => 'not found', - 'break_phrase' => 0, - 'not' => 0, - 'id' => 'uid', - 'table' => 'users', - 'field' => 'uid', - 'override' => array( - 'button' => 'Override', - ), - 'relationship' => 'uid', - 'default_options_div_prefix' => '', - 'default_argument_user' => 0, - 'default_argument_fixed' => '', - 'default_argument_php' => '', - ), - ); - - $view = new view; - $view->name = 'flag_bookmarks_tab'; - $view->description = 'Provides a tab on all user\'s profile pages containing bookmarks for that user.'; - $view->tag = 'flag'; - $view->view_php = ''; - $view->base_table = 'node'; - $view->is_cacheable = FALSE; - $view->api_version = 2; - $view->disabled = FALSE; - $handler = $view->new_display('default', 'Defaults', 'default'); - $handler->override_option('relationships', $relationships_tab); - $handler->override_option('fields', $fields); - $handler->override_option('arguments', $arguments_tab); - $handler->override_option('filters', $filters); - $handler->override_option('access', $access); - $handler->override_option('title', 'User bookmarks'); - $handler->override_option('empty', 'This user has not yet bookmarked any content.'); - $handler->override_option('empty_format', filter_fallback_format()); - $handler->override_option('items_per_page', '25'); - $handler->override_option('use_pager', TRUE); - $handler->override_option('style_plugin', 'table'); - $handler->override_option('style_options', $style_options); - - $handler = $view->new_display('page', 'Page', 'page'); - $handler->override_option('path', 'user/%/bookmarks'); - $handler->override_option('menu', array( - 'type' => 'tab', - 'title' => 'Bookmarks', - 'weight' => '0', - 'name' => 'navigation', - )); - $handler->override_option('tab_options', array( - 'type' => 'none', - 'title' => NULL, - 'weight' => NULL, - )); - - $views[$view->name] = $view; - - /* User bookmarks page with Ops. */ - - // Add some unique options for this view. - $style_options['columns'] += array('ops' => 'ops'); - $fields += array( - 'ops' => array( - 'label' => 'Ops', - 'id' => 'ops', - 'table' => 'flag_content', - 'field' => 'ops', - 'relationship' => 'flag_content_rel', - ), - ); - - $view = new view; - $view->name = 'flag_'. $flag->name; - $view->description = 'A page listing the current user\'s bookmarks at /bookmarks.'; - $view->tag = 'flag'; - $view->view_php = ''; - $view->base_table = 'node'; - $view->is_cacheable = '0'; - $view->api_version = 2; - $view->disabled = FALSE; - $handler = $view->new_display('default', 'Defaults', 'default'); - $handler->override_option('relationships', $relationships); - $handler->override_option('fields', $fields); - $handler->override_option('filters', $filters); - $handler->override_option('access', $access); - $handler->override_option('title', t('My bookmarks')); - $handler->override_option('items_per_page', '25'); - $handler->override_option('use_pager', TRUE); - $handler->override_option('empty', 'You have not yet bookmarked any content. Click the "'. $flag->flag_short .'" link when viewing a piece of content to add it to this list.'); - $handler->override_option('empty_format', filter_fallback_format()); - $handler->override_option('style_plugin', 'table'); - $handler->override_option('style_options', $style_options); - $handler = $view->new_display('page', 'Page', 'page'); - $handler->override_option('path', 'bookmarks'); - $handler->override_option('menu', array( - 'type' => 'normal', - 'title' => t('My bookmarks'), - 'weight' => '0', - )); - $handler->override_option('tab_options', array( - 'type' => 'none', - 'title' => NULL, - 'weight' => NULL, - )); - - $views[$view->name] = $view; - - return $views; -} diff --git a/includes/flag_handler_argument_content_id.inc b/includes/flag_handler_argument_content_id.inc deleted file mode 100644 index ee18743..0000000 --- a/includes/flag_handler_argument_content_id.inc +++ /dev/null @@ -1,46 +0,0 @@ -view->relationship[$this->options['relationship']]->get_flag(); - } - - /** - * Override the behavior of title(). Get the title of the appropriate objects. - */ - function title_query() { - if (!($flag = $this->get_flag())) { - return array(); // Error message is printed by get_flag(). - } - $views_info = $flag->get_views_info(); - - $titles = array(); - $placeholders = implode(', ', array_fill(0, sizeof($this->value), '%d')); - - $result = db_select($views_info['views table'], 'o') - ->fields('o', array($views_info['title field'])) - ->condition('o.' . $views_info['join field'], $this->value, 'IN') - ->execute(); - foreach ($result as $title) { - $titles[] = check_plain($title->$views_info['title field']); - } - return $titles; - } -} diff --git a/includes/flag_handler_field_ops.inc b/includes/flag_handler_field_ops.inc deleted file mode 100644 index 116ff67..0000000 --- a/includes/flag_handler_field_ops.inc +++ /dev/null @@ -1,146 +0,0 @@ -view->relationship[$this->options['relationship']])) { - return $this->view->relationship[$this->options['relationship']]->get_flag(); - } - } - - /** - * Return the the relationship we're linked to. That is, the alias for its - * table (which is suitbale for use with the various methods of the 'query' - * object). - */ - function get_parent_relationship() { - $parent = $this->view->relationship[$this->options['relationship']]->options['relationship']; - if (!$parent || $parent == 'none') { - return NULL; // Base query table. - } - else { - return $this->view->relationship[$parent]->alias; - } - } - - function option_definition() { - $options = parent::option_definition(); - $options['link_type'] = array('default' => ''); - return $options; - } - - function options_form(&$form, &$form_state) { - parent::options_form($form, $form_state); - - $form['link_type'] = array( - '#type' => 'radios', - '#title' => t('Link type'), - '#options' => array('' => t('Use flag link settings')) + _flag_link_type_options(), - '#default_value' => $this->options['link_type'], - ); - } - - /** - * Override base ::query(). The purpose here is to make it possible for the - * render() method to know two things: what's the content ID, and whether - * it's flagged. - */ - function query() { - if (!($flag = $this->get_flag())) { - return; // Error message is printed in render(). - } - $info = $flag->get_views_info(); - $parent = $this->get_parent_relationship(); - - // Find out if the content is flagged. We can't just peek at some field in - // our loaded table because it doesn't always reflect the user browsing the - // page. So we explicitly add the flag_content table to find this out. - $join = new views_join(); - $join->construct('flag_content', $info['views table'], $info['join field'], 'content_id'); - $join->extra[] = array( - 'field' => 'fid', - 'value' => $flag->fid, - 'numeric' => TRUE, - ); - if (!$flag->global) { - $join->extra[] = array( - 'field' => 'uid', - 'value' => '***CURRENT_USER***', - 'numeric' => TRUE, - ); - $join->extra[] = array( - 'field' => 'sid', - 'value' => '***FLAG_CURRENT_USER_SID***', - 'numeric' => TRUE, - ); - } - $flag_table = $this->query->add_table('flag_content', $parent, $join); - $this->aliases['is_flagged'] = $this->query->add_field($flag_table, 'content_id'); - - // Next, find out the content ID. We can't add_field() on this table - // (flag_content), because its content_id may be NULL (in case no user has - // flagged this content, and it's a LEFT JOIN). So we reach to the parent - // relationship and add_field() *its* content ID column. - $left_table = $this->view->relationship[$this->options['relationship']]->table_alias; - $this->aliases['content_id'] = $this->query->add_field($left_table, $info['join field']); - } - - /** - * Find out if the flag applies to each item seen on the page. It's done in a - * separate DB query to to avoid complexity and to make 'many to one' tests - * (e.g. checking user roles) possible without causing duplicate rows. - */ - function pre_render($values) { - if (!($flag = $this->get_flag())) { - return; // Error message is printed in render(). - } - - $ids = array(); - foreach ($values as $row) { - $content_id = $row->{$this->aliases['content_id']}; - $is_flagged = $row->{$this->aliases['is_flagged']}; - if (isset($content_id)) { - $ids[$content_id] = $is_flagged ? 'unflag' : 'flag'; - } - } - $this->flag_applies = $ids ? $flag->access_multiple($ids) : array(); - } - - function render($values) { - if (!($flag = $this->get_flag())) { - return t('Missing flag'); // get_flag() itself will print a more detailed message. - } - - $content_id = $values->{$this->aliases['content_id']}; - $is_flagged = $values->{$this->aliases['is_flagged']}; - - if (empty($this->flag_applies[$content_id])) { - // Flag does not apply to this content. - return; - } - - if (!empty($this->options['link_type'])) { - $flag->link_type = $this->options['link_type']; - } - return $flag->theme($is_flagged ? 'unflag' : 'flag', $content_id); - } -} diff --git a/includes/flag_handler_filter_flagged.inc b/includes/flag_handler_filter_flagged.inc deleted file mode 100644 index ea04d93..0000000 --- a/includes/flag_handler_filter_flagged.inc +++ /dev/null @@ -1,36 +0,0 @@ - 1); - return $options; - } - - function options_form(&$form, &$form_state) { - parent::options_form($form, $form_state); - $form['value']['#type'] = 'radios'; - $form['value']['#title'] = t('Status'); - $form['value']['#options'] = array(1 => t('Flagged'), 0 => t('Not flagged')); - if ($this->options['expose']['optional']) { - $form['value']['#options']['All'] = t('All'); - } - $form['value']['#default_value'] = empty($this->options['value']) ? 0 : $this->options['value']; - $form['value']['#description'] = '' . t('This filter is only needed if the relationship used has the "Include only flagged content" option unchecked. Otherwise, this filter is useless, because all records are already limited to flagged content.') . '
' . t('By choosing Not flagged, it is possible to create a list of content that is specifically not flagged.', array('@unflagged-url' => 'http://drupal.org/node/299335')) . '
'; - } - - function query() { - $operator = $this->value ? 'IS NOT' : 'IS'; - $this->query->add_where($this->options['group'], $this->relationship . '.uid', NULL, $operator . ' NULL'); - } -} diff --git a/includes/flag_handler_relationships.inc b/includes/flag_handler_relationships.inc deleted file mode 100644 index 0ac60af..0000000 --- a/includes/flag_handler_relationships.inc +++ /dev/null @@ -1,266 +0,0 @@ - NULL); - $options['required'] = array('default' => 1); - return $options; - } - - /** - * Make sure the flag exists. - * - * When importing views, or when deleting flags, inconsistent views may - * result. This validator is called by Views before saving or previewing a - * view. - */ - function validate() { - $errors = array(); - $tokens = array( - '@relationship-name' => $this->ui_name() . ' ' . $this->admin_summary(), - '@flag-name' => $this->options['flag'], - ); - if (!$this->options['flag']) { - $errors[] = t('You must pick a flag to use for the relationship "@relationship-name".', $tokens); - } - else if (!flag_get_flag($this->options['flag'])) { - $errors[] = t('This view is looking for a flag by the name "@flag-name", but there is no such flag. Perhaps it was deleted. Please update the relationship "@relationship-name" in this view to use an existing flag.', $tokens); - } - return $errors; - } - - function get_flag_type() { - return isset($this->definition['flag type']) ? $this->definition['flag type'] : NULL; - } - - /** - * Returns the flag object. - */ - function get_flag() { - - // Backward compatibility: There may exist old views on the system whose - // 'flag' option isn't set. (This happens if the admin had skippped - // clicking the 'Update' button.) When run, these views should behave as - // if the first flag was selected. - if (!isset($this->options['flag'])) { - $this->options['flag'] = flag_views_flag_default($this->get_flag_type()); - } - - // Validation: Since validate() is called only when in Views's - // administrative UI, we need to do validation at "run time" ourselves. - if (($errors = $this->validate())) { - foreach ($errors as $error) { - drupal_set_message($error, 'error'); - } - } - - return flag_get_flag($this->options['flag']); - } - - // @todo: It's logical that this class should also implement options_form(), - // to show the flag selector, and query(), to filter on the flag. -} - -/** - * Specialized relationship handler associating flags and content. - * - * @ingroup views - */ -class flag_handler_relationship_content extends flag_handler_relationship { - - function option_definition() { - $options = parent::option_definition(); - $options['user_scope'] = array('default' => 'current'); - return $options; - } - - function options_form(&$form, &$form_state) { - parent::options_form($form, $form_state); - $content_type = $this->definition['flag type']; - $form['label']['#description'] .= ' '. t('The name of the selected flag makes a good label.'); - $form['flag'] = flag_views_flag_config_form('radios', $content_type, $this->options['flag']); - - $form['user_scope'] = array( - '#type' => 'radios', - '#title' => t('By'), - '#options' => array('current' => t('Current user'), 'any' => t('Any user')), - '#default_value' => $this->options['user_scope'], - ); - - $form['required']['#title'] = t('Include only flagged content'); - $form['required']['#description'] = t('If checked, only content that has this flag will be included. Leave unchecked to include all content; or, in combination with the Flagged filter, to limit the results to specifically unflagged content.', array('@unflagged-url' => 'http://drupal.org/node/299335')); - - if (!$form['flag']['#options']) { - $form = array( - 'error' => array( - '#markup' => '' . t('No %type flags exist. You must first create a %type flag before being able to use this relationship type.', array('%type' => $content_type, '@create-url' => url(FLAG_ADMIN_PATH))) . '
', - ), - ); - $form_state['no flags exist'] = TRUE; - } - if (module_exists('session_api')) { - $form['session_warning'] = array( - '#markup' => '' . t('Warning: Adding this relationship for any flag that contains anonymous flagging access will disable page caching for anonymous users when this view is executed. (But this is only true when the relationship is constrained to "Current user", not to "Any user".) It is recommended to create a dedicated page for views containing anonymous user data.') . '
', - ); - } - } - - function options_validate($form, &$form_state) { - if (!empty($form_state['no flags exist'])) { - form_error($form, t('You must first create a flag')); - } - } - - function admin_summary() { - return $this->options['user_scope'] == 'current' ? t('by current user') : t('by any user'); - } - - function ui_name() { - // We put the bookmark name in the UI string to save space. - return t('!group: !title', array('!group' => $this->definition['group'], '!title' => empty($this->options['flag']) ? t('(Please select a flag)') : $this->options['flag'])); - } - - /** - * Called to implement a relationship in a query. - */ - function query() { - if (!($flag = $this->get_flag())) { - return; - } - - $this->definition['extra'][] = array( - 'field' => 'fid', - 'value' => $flag->fid, - 'numeric' => TRUE, - ); - if ($this->options['user_scope'] == 'current' && !$flag->global) { - $this->definition['extra'][] = array( - 'field' => 'uid', - 'value' => '***CURRENT_USER***', - 'numeric' => TRUE, - ); - if (array_search(DRUPAL_ANONYMOUS_RID, $flag->roles['flag']) !== FALSE) { - // Disable page caching for anonymous users. - $GLOBALS['conf']['cache'] = 0; - - // Add in the SID from Session API for anonymous users. - $this->definition['extra'][] = array( - 'field' => 'sid', - 'value' => '***FLAG_CURRENT_USER_SID***', - 'numeric' => TRUE, - ); - } - } - parent::query(); - } -} - -/** - * Specialized relationship handler associating flag counts and content. - * - * @ingroup views - */ -class flag_handler_relationship_counts extends flag_handler_relationship { - - function options_form(&$form, &$form_state) { - parent::options_form($form, $form_state); - $content_type = $this->definition['flag type']; - $form['flag'] = flag_views_flag_config_form('radios', $content_type, $this->options['flag']); - - $form['required']['#title'] = t('Include only flagged content'); - $form['required']['#description'] = t('If checked, only content that is flagged will be included.'); - } - - function admin_summary() { - // Nothing to show. - } - - function ui_name() { - // We put the bookmark name in the UI string to save space. - return t('!group: !title counter', array('!group' => $this->definition['group'], '!title' => $this->options['flag'])); - } - - /** - * Called to implement a relationship in a query. - */ - function query() { - if (!($flag = $this->get_flag())) { - return; - } - - $this->definition['extra'][] = array( - 'field' => 'fid', - 'value' => $flag->fid, - 'numeric' => TRUE, - ); - if (!empty($this->options['required'])) { - // Unfortunately, we may have zeros in our table, so having - // parent::query() do INNER JOIN doesn't suffice. We need to filter these - // zeros out. - // @todo Make sure zero records aren't written in the first place, and - // remove this code. - $this->definition['extra'][] = array( - 'field' => 'count', - 'operator' => '>', - 'value' => '0', - 'numeric' => TRUE, - ); - } - parent::query(); - } -} - -/** - * Specialized relationship handler associating flags and users. - * - * @ingroup views - */ -class flag_handler_relationship_user_content extends flag_handler_relationship { - - function options_form(&$form, &$form_state) { - parent::options_form($form, $form_state); - $form['label']['#description'] .= ' '. t('Including name of the selected flag helps identify this relationship.'); - - $form['flag'] = flag_views_flag_config_form('radios', NULL, $this->options['flag']); - $form['flag']['#title'] = t('Flagged'); - - $form['required']['#title'] = t('Include only users who have flagged content.'); - $form['required']['#description'] = t('If checked, only users that have flagged any content with this flag will be included.'); - } - - function admin_summary() { - return $this->options['flag']; - } - - /** - * Called to implement a relationship in a query. - */ - function query() { - if (!($flag = $this->get_flag())) { - return; - } - - $this->definition['extra'][] = array( - 'field' => 'fid', - 'value' => $flag->fid, - 'numeric' => TRUE, - ); - parent::query(); - } -} - diff --git a/includes/flag_plugin_argument_validate_flaggability.inc b/includes/flag_plugin_argument_validate_flaggability.inc deleted file mode 100644 index 1efe9af..0000000 --- a/includes/flag_plugin_argument_validate_flaggability.inc +++ /dev/null @@ -1,233 +0,0 @@ -flag_type = $this->definition['flag type']; - } - - function option_definition() { - $options = parent::option_definition(); - $options['flag_name'] = array('default' => '*relationship*'); - $options['flag_test'] = array('default' => 'flaggable'); - $options['flag_id_type'] = array('default' => 'id'); - return $options; - } - - function options_form(&$form, &$form_state) { - $options = $this->flags_options(); - - $form[$this->_option_name('flag_name')] = array( - '#type' => 'radios', - '#title' => t('Flag'), - '#options' => $options, - '#default_value' => $this->_get_option('flag_name', '*relationship*'), - '#description' => t('Select the flag to validate against.'), - ); - if (!$options) { - $form[$this->_option_name('flag_name')]['#description'] = '' . t('No %type flags exist. You must first create a %type flag before being able to use one.', array('%type' => $this->flag_type, '@create-url' => FLAG_ADMIN_PATH)) . '
'; - } - - $form[$this->_option_name('flag_test')] = array( - '#type' => 'select', - '#title' => t('Validate the @type only if', array('@type' => $this->flag_type)), - '#options' => $this->tests_options(), - '#default_value' => $this->_get_option('flag_test', 'flaggable'), - ); - - // This validator supports the "multiple IDs" syntax. It may not be - // extremely useful, but similar validators do support this and it's a good - // thing to be compatible. - $form[$this->_option_name('flag_id_type')] = array( - '#type' => 'select', - '#title' => t('Argument type'), - '#options' => array( - 'id' => t('ID'), - 'ids' => t('IDs separated by , or +'), - ), - '#default_value' => $this->_get_option('flag_id_type', 'id'), - ); - } - - /** - * Returns form #options for the flags. Returns empty array if no flags were - * found. - */ - function flags_options() { - $flags = flag_get_flags($this->flag_type); - if (!$flags) { - return array(); - } - else { - foreach ($flags as $flag) { - $options[$flag->name] = $flag->get_title(); - } - $options['*relationship*'] = t('Pick the first flag mentioned in the relationships.'); - return $options; - } - } - - // This function seems useless, but in the Drupal 6 branch it allows for - // compatibility between Views 3 and Views 2. - function _get_option($option, $default) { - return $this->options[$option]; - } - - // This function seems useless, but in the Drupal 6 branch it allows for - // compatibility between Views 3 and Views 2. - function _option_name($option) { - return $option; - } - - /** - * Migrate existing Views 2 options to Views 3. - */ - function convert_options(&$options) { - $prefix = 'validate_argument_' . $this->flag_type . '_'; - if (!isset($options['flag_name']) && !empty($this->argument->options[$prefix . 'flag_name'])) { - $options['flag_name'] = $this->argument->options[$prefix . 'flag_name']; - $options['flag_test'] = $this->argument->options[$prefix . 'flag_test']; - $options['flag_id_type'] = $this->argument->options[$prefix . 'flag_id_type']; - } - } - - /** - * Declares all tests. This scheme makes it easy for derived classes to add - * and remove tests. - */ - function tests_info($which = NULL) { - return array( - 'flaggable' => array( - 'title' => t('It is flaggable'), - 'callback' => 'test_flaggable', - ), - 'flagged' => array( - 'title' => t('It is flagged at least once'), - 'callback' => 'test_flagged', - ), - 'flagged_by_current_user' => array( - 'title' => t('It is flagged by the current user'), - 'callback' => 'test_flagged_by_current_user', - ), - ); - } - - function tests_options() { - $options = array(); - foreach ($this->tests_info() as $id => $info) { - $options[$id] = $info['title']; - } - return $options; - } - - function get_flag() { - $flag_name = $this->_get_option('flag_name', '*relationship*'); - - if ($flag_name == '*relationship*') { - // Pick the first flag mentioned in the relationships. - foreach ($this->view->relationship as $id => $handler) { - // Note: we can't do $handler->field, because the relationship handler's init() may overwrite it. - if (strpos($handler->options['field'], 'flag') !== FALSE && !empty($handler->options['flag'])) { - $flag = flag_get_flag($handler->options['flag']); - if ($flag && $flag->content_type == $this->flag_type) { - return $flag; - } - } - } - } - - return flag_get_flag($flag_name); - } - - /** - * Tests whether the argument is flaggable, or flagged, or flagged by current - * user. These are three possible tests, and which of the three to actually - * carry out is determined by 'flag_test'. - */ - function validate_argument($argument) { - $flag_test = $this->_get_option('flag_test', 'flaggable'); - $id_type = $this->_get_option('flag_id_type', 'id'); - - $flag = $this->get_flag(); - if (!$flag) { - // Validator is misconfigured somehow. - return TRUE; - } - - if ($id_type == 'id') { - if (!is_numeric($argument)) { - // If a user is being smart and types several IDs where only one is - // expected, we invalidate this. - return FALSE; - } - } - - $ids = views_break_phrase($argument, $this); - if ($ids->value == array(-1)) { - // Malformed argument syntax. Invalidate. - return FALSE; - } - $ids = $ids->value; - - // Delegate the testing to the particual test method. $passed then - // holds the IDs that passed the test. - $tests_info = $this->tests_info(); - $method = $tests_info[$flag_test]['callback']; - if (method_exists($this, $method)) { - $passed = $this->$method($ids, $flag); - } - else { - $passed = array(); - } - - // If some IDs exist that haven't $passed our test then validation fails. - $failed = array_diff($ids, $passed); - return empty($failed); - } - - // - // The actual tests. They return the IDs that passed. - // - - function test_flaggable($ids, $flag) { - return array_filter($ids, array($flag, 'applies_to_content_id')); - } - - function test_flagged($ids, $flag) { - // view_break_phrase() is guaranteed to return only integers, so this is SQL safe. - $flattened_ids = implode(',', $ids); - return $this->_test_by_sql("SELECT content_id FROM {flag_counts} WHERE fid = :fid AND content_id IN ($flattened_ids) AND count > 0", array(':fid' => $flag->fid)); - } - - function test_flagged_by_current_user($ids, $flag) { - global $user; - if (!$user->uid) { - // Anonymous user - return FALSE; - } - $flattened_ids = implode(',', $ids); - return $this->_test_by_sql("SELECT content_id FROM {flag_content} WHERE fid = :fid AND content_id IN ($flattened_ids) AND uid = :uid", array(':fid' => $flag->fid, ':uid' => $user->uid)); - } - - // Helper: executes an SQL query and returns all the content_id's. - function _test_by_sql($sql, $args) { - $passed = array(); - $result = db_query($sql, $args); - foreach ($result as $row) { - $passed[] = $row->content_id; - } - return $passed; - } -} - diff --git a/src/ActionLinkPluginManager.php b/src/ActionLinkPluginManager.php new file mode 100644 index 0000000..f577b36 --- /dev/null +++ b/src/ActionLinkPluginManager.php @@ -0,0 +1,48 @@ +alterInfo('flag_link_type_info'); + $this->setCacheBackend($cache_backend, 'flag_link_type_plugins'); + } + + /** + * Get an array of all link type labels keyed by plugin ID. + * + * @return array + * An array of all link type plugins. + */ + public function getAllLinkTypes() { + $link_types = []; + foreach ($this->getDefinitions() as $plugin_id => $plugin_def) { + $link_types[$plugin_id] = t($plugin_def['label']); + } + + return $link_types; + } + +} diff --git a/src/ActionLinkTypeBase.php b/src/ActionLinkTypeBase.php new file mode 100644 index 0000000..85856ba --- /dev/null +++ b/src/ActionLinkTypeBase.php @@ -0,0 +1,193 @@ +configuration += $this->defaultConfiguration(); + } + + /** + * Returns a route name given an $action. + * + * @param string|null $action + * A string containing the action name. + * + * @return string + * A string containing a route name. + */ + abstract public function routeName($action = NULL); + + /** + * {@inheritdoc} + */ + public function buildLink($action, FlagInterface $flag, EntityInterface $entity) { + $parameters = [ + 'flag_id' => $flag->id(), + 'entity_id' => $entity->id(), + ]; + + return new Url($this->routeName($action), $parameters); + } + + /** + * Helper method to generate a destination URL parameter. + * + * @return string + * A string containing a destination URL parameter. + */ + protected function getDestination() { + $current_url = Url::fromRoute('' . t('The Views module is not installed, or not enabled. It is recommended that you install the Views module to be able to easily produce lists of flagged content.', ['@views-url' => Url::fromUri('http://drupal.org/project/views')]) . '
'; + } + else { + $output .= ''; + $output .= t('Lists of flagged content can be displayed using views. You can configure these in the Views administration section.', ['@views-url' => Url::fromRoute('views_ui.list')->toString()]); + if (\Drupal::service('flag')->getFlagById('bookmarks')) { + $output .= ' ' . t('Flag module automatically provides a few default views for the bookmarks flag. You can use these as templates by cloning these views and then customizing as desired.', ['@views-url' => Url::fromRoute('views_ui.list', ['query' => ['tag' => 'flag']])->toString()]); + } + $output .= ' ' . t('The Flag module handbook contains extensive documentation on creating customized views using flags.', ['@flag-handbook-url' => 'http://drupal.org/handbook/modules/flag', '@customize-url' => 'http://drupal.org/node/296954']); + $output .= '
'; + } + + if (!\Drupal::moduleHandler()->moduleExists('rules')) { + $output .= '' . t('Flagging an item may trigger rules. However, you don\'t have the Rules module enabled, so you won\'t be able to enjoy this feature. The Rules module is a more extensive solution than Flag actions.', ['@rules-url' => Url::fromUri('http://drupal.org/node/407070')->toString()]) . '
'; + } + + /* + * Commented out because the rules route name has yet to be established. + else { + $output .= '' . t('Flagging an item may trigger rules.', ['@rules-url' => Url::fromUri('base://admin/config/workflow/rules')]) . '
'; + } + */ + + $output .= '' . t('To learn about the various ways to use flags, please check out the Flag module handbook.', ['@handbook-url' => 'http://drupal.org/handbook/modules/flag']) . '
'; + + $build['markup'] = [ + '#type' => 'markup', + '#markup' => $output, + ]; + + return $build; + } + +} diff --git a/src/Controller/ReloadLinkController.php b/src/Controller/ReloadLinkController.php new file mode 100644 index 0000000..730928e --- /dev/null +++ b/src/Controller/ReloadLinkController.php @@ -0,0 +1,102 @@ +flagService = $flag; + } + + /** + * Create. + * + * @param ContainerInterface $container + * The container object. + * + * @return ReloadLinkController + * The reload link controller. + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('flag') + ); + } + + /** + * Performs a flagging when called via a route. + * + * @param int $flag_id + * The flag ID. + * @param int $entity_id + * The flaggable ID. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + * The response object. + * + * @see \Drupal\flag\Plugin\Reload + */ + public function flag($flag_id, $entity_id) { + /* @var \Drupal\flag\FlaggingInterface $flagging */ + $flagging = $this->flagService->flag($flag_id, $entity_id); + + // Redirect back to the entity. A passed in destination query parameter + // will automatically override this. + $url_info = $flagging->getFlaggable()->urlInfo(); + return $this->redirect($url_info->getRouteName(), $url_info->getRouteParameters()); + } + + /** + * Performs a flagging when called via a route. + * + * @param int $flag_id + * The flag ID. + * @param int $entity_id + * The flagging ID. + * + * @return \Symfony\Component\HttpFoundation\RedirectResponse + * The response object. + * + * @see \Drupal\flag\Plugin\Reload + */ + public function unflag($flag_id, $entity_id) { + $this->flagService->unflag($flag_id, $entity_id); + + $flag = $this->flagService->getFlagById($flag_id); + $entity = $this->flagService->getFlaggableById($flag, $entity_id); + + // Redirect back to the entity. A passed in destination query parameter + // will automatically override this. + $url_info = $entity->urlInfo(); + return $this->redirect($url_info->getRouteName(), $url_info->getRouteParameters()); + } + +} diff --git a/src/Entity/Flag.php b/src/Entity/Flag.php new file mode 100644 index 0000000..91169b9 --- /dev/null +++ b/src/Entity/Flag.php @@ -0,0 +1,571 @@ +flag_type) { + $this->flagTypeCollection = new DefaultSingleLazyPluginCollection( + \Drupal::service('plugin.manager.flag.flagtype'), + $this->flag_type, $this->flagTypeConfig + ); + } + + if ($this->link_type) { + $this->linkTypeCollection = new DefaultSingleLazyPluginCollection( + \Drupal::service('plugin.manager.flag.linktype'), + $this->link_type, $this->linkTypeConfig + ); + } + } + + /** + * {@inheritdoc} + */ + public function enable() { + $this->enabled = TRUE; + } + + /** + * {@inheritdoc} + */ + public function disable() { + $this->enabled = FALSE; + } + + /** + * {@inheritdoc} + */ + public function isEnabled() { + return $this->enabled; + } + + /** + * {@inheritdoc} + */ + public function isFlagged(EntityInterface $entity, AccountInterface $account = NULL) { + if ($account == NULL) { + $account = \Drupal::currentUser(); + } + + $result = \Drupal::entityQuery('flagging') + ->condition('uid', $account->id()) + ->condition('fid', $this->id()) + ->condition('entity_type', $entity->getEntityTypeId()) + ->condition('entity_id', $entity->id()) + ->execute(); + + if (!empty($result)) { + return TRUE; + } + + return FALSE; + } + + /** + * {@inheritdoc} + */ + public function getFlaggableEntityType() { + return $this->entity_type; + } + + /** + * {@inheritdoc} + */ + public function getPluginCollections() { + return [ + 'flagTypeConfig' => $this->flagTypeCollection, + 'linkTypeConfig' => $this->linkTypeCollection, + ]; + } + + /** + * {@inheritdoc} + */ + public function getFlagTypePlugin() { + return $this->flagTypeCollection->get($this->flag_type); + } + + /** + * {@inheritdoc} + */ + public function setFlagTypePlugin($plugin_id) { + $this->flag_type = $plugin_id; + // $this->flagTypeBag->addInstanceId($pluginID); + // Workaround for https://www.drupal.org/node/2288805 + $this->flagTypeCollection = new DefaultSingleLazyPluginCollection( + \Drupal::service('plugin.manager.flag.flagtype'), + $this->flag_type, $this->flagTypeConfig + ); + + // Get the entity type from the plugin definition. + $plugin = $this->getFlagTypePlugin(); + $plugin_def = $plugin->getPluginDefinition(); + $this->entity_type = $plugin_def['entity_type']; + } + + /** + * {@inheritdoc} + */ + public function getLinkTypePlugin() { + return $this->linkTypeCollection->get($this->link_type); + } + + /** + * {@inheritdoc} + */ + public function setlinkTypePlugin($plugin_id) { + $this->link_type = $plugin_id; + + // $this->linkTypeBag->addInstanceId($pluginID); + // Workaround for https://www.drupal.org/node/2288805 + $this->linkTypeCollection = new DefaultSingleLazyPluginCollection( + \Drupal::service('plugin.manager.flag.linktype'), + $this->link_type, $this->linkTypeConfig + ); + } + + /** + * {@inheritdoc} + */ + public function getPermissions() { + return [ + "flag $this->id" => [ + 'title' => t('Flag %flag_title', [ + '%flag_title' => $this->label, + ]), + ], + "unflag $this->id" => [ + 'title' => t('Unflag %flag_title', [ + '%flag_title' => $this->label, + ]), + ], + ]; + } + + /** + * {@inheritdoc} + */ + public function hasActionAccess($action, AccountInterface $account = NULL) { + if ($action === 'flag' || $action === 'unflag') { + $account = $account ?: \Drupal::currentUser(); + return $account->hasPermission($action . ' ' . $this->id); + } + else { + // @todo: Is this the correct response? + return FALSE; + } + } + + /** + * {@inheritdoc} + */ + public function isGlobal() { + return $this->is_global; + } + + /** + * {@inheritdoc} + */ + public function setGlobal($is_global = TRUE) { + if ($is_global) { + $this->is_global = TRUE; + } + else { + $this->is_global = FALSE; + } + } + + /** + * {@inheritdoc} + */ + public function setFlagShortText($text) { + $this->flag_short; + } + + /** + * {@inheritdoc} + */ + public function getFlagShortText() { + return $this->flag_short; + } + + /** + * {@inheritdoc} + */ + public function getFlagLongText() { + return $this->flag_long; + } + + /** + * {@inheritdoc} + */ + public function setFlagLongText($flag_long) { + $this->flag_long = $flag_long; + } + + /** + * {@inheritdoc} + */ + public function getFlagMessage() { + return $this->flag_message; + } + + /** + * {@inheritdoc} + */ + public function setFlagMessage($flag_message) { + $this->flag_message = $flag_message; + } + + /** + * {@inheritdoc} + */ + public function getUnflagLongText() { + return $this->unflag_long; + } + + /** + * {@inheritdoc} + */ + public function setUnflagLongText($unflag_long) { + $this->unflag_long = $unflag_long; + } + + /** + * {@inheritdoc} + */ + public function getUnflagMessage() { + return $this->unflag_message; + } + + /** + * {@inheritdoc} + */ + public function setUnflagMessage($unflag_message) { + $this->unflag_message = $unflag_message; + } + + /** + * {@inheritdoc} + */ + public function getUnflagShortText() { + return $this->unflag_short; + } + + /** + * {@inheritdoc} + */ + public function setUnflagShortText($unflag_short) { + $this->unflag_short = $unflag_short; + } + + /** + * {@inheritdoc} + */ + public function getUnflagDeniedText() { + return $this->unflag_denied_text; + } + + /** + * {@inheritdoc} + */ + public function setUnflagDeniedText($unflag_denied_text) { + $this->unflag_denied_text = $unflag_denied_text; + } + + /** + * {@inheritdoc} + */ + public function getWeight() { + return $this->weight; + } + + /** + * {@inheritdoc} + */ + public function setWeight($weight) { + $this->weight = $weight; + } + /** + * {@inheritdoc} + */ + public function preSave(EntityStorageInterface $storage) { + parent::preSave($storage); + /* + // Save the Flag Type configuration. + $flagTypePlugin = $this->getFlagTypePlugin(); + $this->set('flagTypeConfig', $flagTypePlugin->getConfiguration()); + + // Save the Link Type configuration. + $linkTypePlugin = $this->getLinkTypePlugin(); + $this->set('linkTypeConfig', $linkTypePlugin->getConfiguration()); + */ + // Reset the render cache for the entity. + // @todo Inject the entity manager into the object? + \Drupal::entityManager() + ->getViewBuilder($this->getFlaggableEntityType()) + ->resetCache(); + // Clear entity extra field caches. + \Drupal::entityManager()->clearCachedFieldDefinitions(); + + } + + /** + * {@inheritdoc} + */ + public static function preDelete(EntityStorageInterface $storage, array $entities) { + parent::preDelete($storage, $entities); + + foreach ($entities as $entity) { + \Drupal::service('event_dispatcher') + ->dispatch(FlagEvents::FLAG_DELETED, new FlagDeleteEvent($entity)); + } + } + + /** + * Sorts the flag entities, putting disabled flags at the bottom. + * + * @see \Drupal\Core\Config\Entity\ConfigEntityBase::sort() + */ + public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) { + + // Check if the entities are flags, if not go with the default. + if ($a instanceof FlagInterface && $b instanceof FlagInterface) { + + if ($a->isEnabled() && $b->isEnabled()) { + return parent::sort($a, $b); + } + elseif (!$a->isEnabled()) { + return -1; + } + elseif (!$b->isEnabled()) { + return 1; + } + } + + return parent::sort($a, $b); + } + + /** + * {@inheritdoc} + */ + public function toArray() { + // @todo Do we need Flag::toArray() any longer? + $properties = parent::toArray(); + $names = [ + 'flag_type', + 'link_type', + 'flagTypeConfig', + 'linkTypeConfig', + ]; + + foreach ($names as $name) { + $properties[$name] = $this->get($name); + } + + return $properties; + } + +} diff --git a/src/Entity/FlagDisabledException.php b/src/Entity/FlagDisabledException.php new file mode 100644 index 0000000..90030a9 --- /dev/null +++ b/src/Entity/FlagDisabledException.php @@ -0,0 +1,31 @@ + $flag->label()))); + } + +} \ No newline at end of file diff --git a/src/Entity/Flagging.php b/src/Entity/Flagging.php new file mode 100644 index 0000000..a07c680 --- /dev/null +++ b/src/Entity/Flagging.php @@ -0,0 +1,145 @@ +get('fid')->value; + } + + /** + * Gets the parent flag entity. + * + * @return \Drupal\Core\Entity\EntityInterface|\Drupal\flag\FlagInterface + * The flag related this this flagging. + */ + public function getFlag() { + return $this->entityManager()->getStorage('flag')->load($this->getFlagId()); + } + + /** + * Gets the entity type of the flaggable. + * + * @return string + * A string containing the flaggable type ID. + */ + public function getFlaggableType() { + return $this->get('entity_type')->value; + } + + /** + * Gets the entity ID of the flaggable. + * + * @return string + * A string containing the flaggable ID. + */ + public function getFlaggableId() { + return $this->get('entity_id')->value; + } + + /** + * Gets the flaggable entity. + * + * @return \Drupal\Core\Entity\EntityInterface + * The flaggable entity. + */ + public function getFlaggable() { + return $this->entityManager()->getStorage($this->getFlaggableType())->load($this->getFlaggableId()); + } + + /** + * {@inheritdoc} + */ + public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { + $fields['id'] = BaseFieldDefinition::create('integer') + ->setLabel(t('Flagging ID')) + ->setDescription(t('The flagging ID.')) + ->setReadOnly(TRUE); + + $fields['uuid'] = BaseFieldDefinition::create('uuid') + ->setLabel(t('UUID')) + ->setDescription(t('The flagging UUID.')) + ->setReadOnly(TRUE); + + $fields['fid'] = BaseFieldDefinition::create('string') + ->setLabel(t('Flag ID')) + ->setDescription(t('The Flag ID.')) + ->setReadOnly(TRUE); + + $fields['entity_type'] = BaseFieldDefinition::create('string') + ->setLabel(t('Entity Type')) + ->setDescription(t('The Entity Type.')); + + $fields['entity_id'] = BaseFieldDefinition::create('string') + ->setLabel(t('Entity ID')) + ->setDescription(t('The Entity ID.')); + + $fields['type'] = BaseFieldDefinition::create('entity_reference') + ->setLabel(t('Type')) + ->setDescription(t('The flag type.')) + ->setSetting('target_type', 'flag') + ->setReadOnly(TRUE); + + $fields['uid'] = BaseFieldDefinition::create('entity_reference') + ->setLabel(t('User ID')) + ->setDescription(t('The user ID of the flagging user.')) + ->setSettings([ + 'target_type' => 'user', + 'default_value' => 0, + ]); + + $fields['created'] = BaseFieldDefinition::create('created') + ->setLabel(t('Created')) + ->setDescription(t('The time that the flagging was created.')); + + return $fields; + } + +} diff --git a/src/Event/FlagDeleteEvent.php b/src/Event/FlagDeleteEvent.php new file mode 100644 index 0000000..9c27fbc --- /dev/null +++ b/src/Event/FlagDeleteEvent.php @@ -0,0 +1,26 @@ +flag = $flag; + } + +} diff --git a/src/Event/FlagEvents.php b/src/Event/FlagEvents.php new file mode 100644 index 0000000..10981e5 --- /dev/null +++ b/src/Event/FlagEvents.php @@ -0,0 +1,28 @@ +entity = $entity; + $this->action = $action; + } + +} diff --git a/src/FlagInterface.php b/src/FlagInterface.php new file mode 100644 index 0000000..2e0ad87 --- /dev/null +++ b/src/FlagInterface.php @@ -0,0 +1,269 @@ +getFlags(); + + // Provide flag and unflag permissions for each flag. + foreach ($flags as $flag_name => $flag) { + $permissions += $flag->getPermissions(); + } + + return $permissions; + } +} diff --git a/src/FlagService.php b/src/FlagService.php new file mode 100644 index 0000000..e3f3ef7 --- /dev/null +++ b/src/FlagService.php @@ -0,0 +1,459 @@ +flagTypeManager = $flag_type; + $this->eventDispatcher = $event_dispatcher; + $this->entityQueryManager = $entity_query; + $this->currentUser = $current_user; + $this->entityManager = $entity_manager; + } + + /** + * Get a flag type definition. + * + * @param string $entity_type + * (optional) The entity type to get the definition for, or NULL to return + * all flag types. + * + * @return array + * The flag type definition array. + * + * @see hook_flag_type_info() + */ + public function fetchDefinition($entity_type = NULL) { + // @todo Add caching, PLS! + if (!empty($entity_type)) { + return $this->flagTypeManager->getDefinition($entity_type); + } + + return $this->flagTypeManager->getDefinitions(); + } + + /** + * List all flags available. + * + * If node type or account are entered, a list of all possible flags will be + * returned. + * + * @param string $entity_type + * (optional) The type of entity for which to load the flags. + * @param string $bundle + * (optional) The bundle for which to load the flags. + * @param AccountInterface $account + * (optional) The user account to filter available flags. If not set, all + * flags for the given entity and bundle will be returned. + * + * @return array + * An array of the structure [fid] = flag_object. + */ + public function getFlags($entity_type = NULL, $bundle = NULL, AccountInterface $account = NULL) { + $query = $this->entityQueryManager->get('flag'); + + if ($entity_type != NULL) { + $query->condition('entity_type', $entity_type); + } + + if ($bundle != NULL && $entity_type != $bundle) { + $query->condition("types.$bundle", $bundle); + } + + $result = $query->execute(); + + $flags = $this->entityManager->getStorage('flag')->loadMultiple($result); + + if ($account == NULL) { + return $flags; + } + + $filtered_flags = []; + foreach ($flags as $flag) { + if ($flag->hasActionAccess('flag ' . $flag->id(), $account) || $flag->hasActionAccess('unflag ' . $flag->id(), $account)) { + $filtered_flags[] = $flag; + } + } + + return $filtered_flags; + } + + /** + * Get all flaggings for the given entity, flag, and optionally, user. + * + * @param EntityInterface $entity + * Optional. The flaggable entity. If NULL, flaggins for any entity will be + * returned. + * @param FlagInterface $flag + * Optional. The flag entity. If NULL, flaggings for any flag will be + * returned. + * @param AccountInterface $account + * Optional. The account of the flagging user. If NULL, flaggings for any + * user will be returned. + * + * @return array + * An array of flaggings. + */ + public function getFlaggings(EntityInterface $entity = NULL, FlagInterface $flag = NULL, AccountInterface $account = NULL) { + $query = $this->entityQueryManager->get('flagging'); + + if (!empty($account)) { + $query = $query->condition('uid', $account->id()); + } + + if (!empty($flag)) { + $query = $query->condition('fid', $flag->id()); + } + + if (!empty($entity)) { + $query = $query->condition('entity_type', $entity->getEntityTypeId()) + ->condition('entity_id', $entity->id()); + } + + $result = $query->execute(); + + $flaggings = []; + foreach ($result as $flagging_id) { + $flaggings[$flagging_id] = $this->entityManager->getStorage('flagging')->load($flagging_id); + } + + return $flaggings; + } + + /** + * Load the flag entity given the ID. + * + * @param int $flag_id + * The ID of the flag to load. + * + * @return FlagInterface|null + * The flag entity. + */ + public function getFlagById($flag_id) { + return $this->entityManager->getStorage('flag')->load($flag_id); + } + + /** + * Loads the flaggable entity given the flag entity and entity ID. + * + * @param FlagInterface $flag + * The flag entity. + * @param int $entity_id + * The ID of the flaggable entity. + * + * @return EntityInterface|null + * The flaggable entity object. + */ + public function getFlaggableById(FlagInterface $flag, $entity_id) { + return $this->entityManager->getStorage($flag->getFlaggableEntityType())->load($entity_id); + } + + /** + * Get a list of users that have flagged an entity. + * + * @param EntityInterface $entity + * The entity object. + * @param FlagInterface $flag + * Optional. The flag entity to which to restrict results. + * + * @return array + * An array of users who have flagged the entity. + */ + public function getFlaggingUsers(EntityInterface $entity, FlagInterface $flag = NULL) { + $query = $this->entityQueryManager->get('users') + ->condition('entity_type', $entity->getEntityTypeId()) + ->condition('entity_id', $entity->id()); + + if (!empty($flag)) { + $query = $query->condition('fid', $flag->id()); + } + + $result = $query->execute(); + + $flaggings = []; + foreach ($result as $flagging_id) { + $flaggings[$flagging_id] = $this->entityManager->getStorage('flagging')->load($flagging_id); + } + + return $flaggings; + } + + /** + * Flags the given entity given the flag and entity objects. + * + * @param FlagInterface $flag + * The flag entity. + * @param EntityInterface $entity + * The entity to flag. + * @param AccountInterface $account + * Optional. The account of the user flagging the entity. If not given, + * the current user is used. + * + * @throws \Drupal\flag\Entity\FlagDisabledException + * Thrown when a flag operation is being performed against a disabled flag. + * + * @return FlaggingInterface|null + * The flagging. + */ + public function flagByObject(FlagInterface $flag, EntityInterface $entity, AccountInterface $account = NULL) { + if (empty($account)) { + $account = $this->currentUser; + } + + // Throw an exception if the flag is disabled. + if (!$flag->isEnabled()) { + throw new FlagDisabledException($flag); + } + + $flagging = $this->entityManager->getStorage('flagging')->create([ + 'type' => 'flag', + 'uid' => $account->id(), + 'fid' => $flag->id(), + 'entity_id' => $entity->id(), + 'entity_type' => $entity->getEntityTypeId(), + ]); + + $flagging->save(); + + $this->incrementFlagCounts($flag, $entity); + + $this->entityManager + ->getViewBuilder($entity->getEntityTypeId()) + ->resetCache([ + $entity, + ]); + + $this->eventDispatcher->dispatch(FlagEvents::ENTITY_FLAGGED, new FlaggingEvent($flag, $entity, 'flag')); + + return $flagging; + } + + /** + * Flags an entity given the flag ID and entity ID. + * + * @param int $flag_id + * The ID of the flag. + * @param int $entity_id + * The ID of the entity to flag. + * @param AccountInterface $account + * Optional. The account of user flagging the entity. If not given, the + * current user is used. + * + * @return FlaggingInterface|null + * The flagging entity. + * + * @api + */ + public function flag($flag_id, $entity_id, AccountInterface $account = NULL) { + if (empty($account)) { + $account = $this->currentUser; + } + + $flag = $this->getFlagById($flag_id); + $entity = $this->getFlaggableById($flag, $entity_id); + + return $this->flagByObject($flag, $entity, $account); + } + + /** + * Unflags an entity given the flag ID and entity ID. + * + * @param int $flag_id + * The ID of the flag. + * @param int $entity_id + * The ID of the flagged entity to unflag. + * @param AccountInterface $account + * Optional. The account of the user that created the flagging. + * + * @return array + * An array of flagging IDs to delete. + * + * @api + */ + public function unflag($flag_id, $entity_id, AccountInterface $account = NULL) { + if (empty($account)) { + $account = $this->currentUser; + } + + $flag = $this->getFlagById($flag_id); + $entity = $this->getFlaggableById($flag, $entity_id); + + $this->decrementFlagCounts($flag, $entity); + + return $this->unflagByObject($flag, $entity, $account); + } + + /** + * Unflags the given entity for the given flag. + * + * @param FlagInterface $flag + * The flag being unflagged. + * @param EntityInterface $entity + * The entity to unflag. + * @param AccountInterface $account + * Optional. The account of the user that created the flagging. + * + * @throws \Drupal\flag\Entity\FlagDisabledException + * Thrown when an unflag is being performed on a disabled flag. + * + * @return array + * An array of flagging IDs to delete. + */ + public function unflagByObject(FlagInterface $flag, EntityInterface $entity, AccountInterface $account = NULL) { + // Throw an exception if the flag is disabled. + if (!$flag->isEnabled()) { + throw new FlagDisabledException($flag); + } + + $this->eventDispatcher->dispatch(FlagEvents::ENTITY_UNFLAGGED, new FlaggingEvent($flag, $entity, 'unflag')); + + $out = []; + $flaggings = $this->getFlaggings($entity, $flag, $account); + foreach ($flaggings as $flagging) { + $out[] = $flagging->id(); + + $this->unflagByFlagging($flagging); + } + + return $out; + } + + /** + * Deletes the given flagging. + * + * @param FlaggingInterface $flagging + * The flagging to delete. + */ + public function unflagByFlagging(FlaggingInterface $flagging) { + $flagging->delete(); + } + + /** + * Increments count of flagged entities. + * + * @param FlagInterface $flag + * The flag to increment. + * @param EntityInterface $entity + * The flaggable entity. + */ + protected function incrementFlagCounts(FlagInterface $flag, EntityInterface $entity) { + db_merge('flag_counts') + ->key([ + 'fid' => $flag->id(), + 'entity_id' => $entity->id(), + 'entity_type' => $entity->getEntityTypeId(), + ]) + ->fields([ + 'last_updated' => REQUEST_TIME, + 'count' => 1, + ]) + ->expression('count', 'count + :inc', [':inc' => 1]) + ->execute(); + } + + /** + * Reverts incrementation of count of flagged entities. + * + * @param FlagInterface $flag + * The flag to decrement. + * @param EntityInterface $entity + * The flaggable entity. + */ + protected function decrementFlagCounts(FlagInterface $flag, EntityInterface $entity) { + $count_result = db_select('flag_counts') + ->fields(NULL, ['fid', 'entity_id', 'entity_type', 'count']) + ->condition('fid', $flag->id()) + ->condition('entity_id', $entity->id()) + ->condition('entity_type', $entity->getEntityTypeId()) + ->execute() + ->fetchAll(); + if (count($count_result) == 1) { + db_delete('flag_counts') + ->condition('fid', $flag->id()) + ->condition('entity_id', $entity->id()) + ->condition('entity_type', $entity->getEntityTypeId()) + ->execute(); + } + else { + db_update('flag_counts') + ->expression('count', 'count - 1') + ->condition('fid', $flag->id()) + ->condition('entity_id', $entity->id()) + ->condition('entity_id', $entity->id()) + ->execute(); + } + } + +} diff --git a/src/FlagTypeBase.php b/src/FlagTypeBase.php new file mode 100644 index 0000000..24f1652 --- /dev/null +++ b/src/FlagTypeBase.php @@ -0,0 +1,118 @@ +configuration += $this->defaultConfiguration(); + } + + /** + * Provides the default configuration values for the flag type. + * + * @return array + * The flag type's default plugin configuration. + */ + public function defaultConfiguration() { + return []; + } + + /** + * {@inheritdoc} + */ + public function calculateDependencies() { + return []; + } + + /** + * Returns this flag type plugin's configuration array. + * + * @return array + * The plugin configuration array. + */ + public function getConfiguration() { + return $this->configuration; + } + + /** + * Replaces the plugin's configurations with those given in the parameter. + * + * @param array $configuration + * The plugin configuration array. + */ + public function setConfiguration(array $configuration) { + $this->configuration = $configuration; + } + + /** + * Provides a form for this action link plugin settings. + * + * The form provided by this method is displayed by the FlagAddForm when + * creating or editing the Flag. Derived classes should override this. + * + * @param array $form + * The form array. + * @param FormStateInterface $form_state + * The form state. + * + * @return array + * The form array + * @see \Drupal\flag\Form\FlagAddForm + */ + public function buildConfigurationForm(array $form, FormStateInterface $form_state) { + return $form; + } + + /** + * Handles the form submit for this action link plugin. + * + * Derived classes will want to override this. + * + * @param array $form + * The form array. + * @param FormStateInterface $form_state + * The form state. + */ + public function submitConfigurationForm(array &$form, FormStateInterface $form_state) { + // Override this. + } + + /** + * Handles the validation for the action link plugin settings form. + * + * @param array $form + * The form array. + * @param FormStateInterface $form_state + * The form state. + */ + public function validateConfigurationForm(array &$form, FormStateInterface $form_state) { + // Override this. + } + + /** + * {@inheritdoc} + */ + public function typeAccessMultiple(array $entity_ids, AccountInterface $account) { + return []; + } +} diff --git a/src/FlagTypePluginInterface.php b/src/FlagTypePluginInterface.php new file mode 100644 index 0000000..0958348 --- /dev/null +++ b/src/FlagTypePluginInterface.php @@ -0,0 +1,37 @@ +alterInfo('flag_type_info'); + $this->setCacheBackend($cache_backend, 'flag'); + } + + /** + * Gets all flag types. + * + * @return array + * Returns all flag types. + */ + public function getAllFlagTypes() { + $flag_types = []; + + foreach ($this->getDefinitions() as $plugin_id => $plugin_def) { + $flag_types[$plugin_id] = $plugin_def['title']; + } + asort($flag_types); + + return $flag_types; + } + +} diff --git a/src/FlaggingAccessController.php b/src/FlaggingAccessController.php new file mode 100644 index 0000000..1338df0 --- /dev/null +++ b/src/FlaggingAccessController.php @@ -0,0 +1,47 @@ +hasActionAccess('flag')); + } + + /** + * Checks unflagging permission. + * + * @param Request $request + * The request object. + * + * @return string + * Returns indication value for unflagging access permission. + */ + public function checkUnflag($flag_id) { + $flag = Flag::load($flag_id); + return AccessResult::allowedIf($flag->hasActionAccess('unflag')); + } + +} diff --git a/src/FlaggingInterface.php b/src/FlaggingInterface.php new file mode 100644 index 0000000..9206b86 --- /dev/null +++ b/src/FlaggingInterface.php @@ -0,0 +1,33 @@ +get('flag'); + $step1_form = $tempstore->get('FlagAddPage'); + + $flag = $this->entity; + $flag->label = $step1_form['label']; + $flag->id = $step1_form['id']; + + $flag->setFlagTypePlugin($step1_form['flag_entity_type']); + $flag->setLinkTypePlugin($step1_form['flag_link_type']); + + // Mark the flag as new. + $flag->is_new = TRUE; + + $form = parent::buildForm($form, $form_state); + + return $form; + } + + /** + * {@inheritdoc} + */ + protected function actions(array $form, FormStateInterface $form_state) { + $actions = parent::actions($form, $form_state); + $actions['submit']['#value'] = t('Create Flag'); + return $actions; + } +} diff --git a/src/Form/FlagAddPageForm.php b/src/Form/FlagAddPageForm.php new file mode 100644 index 0000000..d158b2d --- /dev/null +++ b/src/Form/FlagAddPageForm.php @@ -0,0 +1,139 @@ + 'fieldset', + '#title' => t('Flag basic info'), + '#collapsable' => FALSE, + '#weight' => -10, + ]; + $form['flag_basic_info']['label'] = [ + '#type' => 'textfield', + '#title' => t('Label'), + '#description' => t('A short, descriptive title for this flag. It will be used in administrative interfaces to refer to this flag, and in page titles and menu items of some views this module provides (theses are customizable, though). Some examples could be Bookmarks, Favorites, or Offensive.', array('@insite-views-url' => Url::fromRoute('views_ui.list')->toString())), + '#maxlength' => 255, + '#required' => TRUE, + '#weight' => -3, + ]; + $form['flag_basic_info']['id'] = [ + '#type' => 'machine_name', + '#title' => t('Machine name'), + '#description' => t('The machine-name for this flag. It may be up to 32 characters long and may only contain lowercase letters, underscores, and numbers. It will be used in URLs and in all API calls.'), + '#weight' => -2, + '#machine_name' => [ + 'exists' => [$this, 'exists'], + 'source' => ['flag_basic_info', 'label'], + ], + ]; + + $form['flag_type_info'] = [ + '#type' => 'fieldset', + '#title' => t('Type and Action'), + '#attributes' => [ + 'class' => ['container-inline'], + ], + ]; + + $form['flag_type_info']['flag_entity_type'] = [ + '#type' => 'select', + '#title' => t('Flag'), + '#options' => \Drupal::service('plugin.manager.flag.flagtype')->getAllFlagTypes(), + '#default_value' => 'flagtype_node', + ]; + + $form['flag_type_info']['flag_link_type'] = [ + '#type' => 'select', + '#title' => t('using'), + '#options' => \Drupal::service('plugin.manager.flag.linktype')->getAllLinkTypes(), + '#default_value' => 'reload', + ]; + + $types = []; + + $plugins = \Drupal::service('plugin.manager.flag.flagtype')->getDefinitions(); + + $form['actions'] = [ + '#type' => 'actions', + ]; + + $form['actions']['submit'] = [ + '#type' => 'submit', + '#value' => t('Continue'), + ]; + + return $form; + } + + /** + * {@inheritdoc} + */ + public function validateForm(array &$form, FormStateInterface $form_state) { + /* + $flag = AbstractFlag::factory_by_entity_type($form_state->getValue('type')); + if (get_class($flag) == 'BrokenFlag') { + form_set_error('type', + t("This flag type, %type, isn't valid.", + array('%type' => $form_state->getValue('type')))); + } + */ + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $form_state->setRedirect('flag.add', [ + 'entity_type' => $form_state->getValue('flag_entity_type') + ]); + + $tempstore = \Drupal::service('user.tempstore')->get('flag'); + $tempstore->set('FlagAddPage', $form_state->getValues()); + } + + /** + * Determines if the flag already exists. + * + * @param string $id + * The flag ID + * + * @return bool + * TRUE if the flag exists, FALSE otherwise. + */ + public function exists($id) { + // @todo: Make this injected like ActionFormBase::exists(). + return \Drupal::entityManager()->getStorage('flag')->load($id); + } +} diff --git a/src/Form/FlagDeleteForm.php b/src/Form/FlagDeleteForm.php new file mode 100644 index 0000000..1042fa3 --- /dev/null +++ b/src/Form/FlagDeleteForm.php @@ -0,0 +1,60 @@ + $this->entity->label(), + ]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return t('Delete'); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('flag.list'); + } + + /** + * {@inheritdoc} + */ + public function submit(array $form, FormStateInterface $form_state) { + $this->entity->delete(); + drupal_set_message(t('Flag %label was deleted.', [ + '%label' => $this->entity->label(), + ])); + + $form_state->setRedirectUrl($this->getCancelUrl()); + } + +} diff --git a/src/Form/FlagDisableConfirmForm.php b/src/Form/FlagDisableConfirmForm.php new file mode 100644 index 0000000..e7ac0e8 --- /dev/null +++ b/src/Form/FlagDisableConfirmForm.php @@ -0,0 +1,79 @@ +flag = $flag; + return parent::buildForm($form, $form_state); + } + + public function getFormID() { + return 'flag_disable_confirm_form'; + } + + public function getQuestion() { + if ($this->flag->isEnabled()) { + return t('Disable flag @name?', array('@name' => $this->flag->label())); + } + + return t('Enable flag @name?', array('@name' => $this->flag->label())); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('flag.list'); + } + + public function getDescription() { + if ($this->flag->isEnabled()) { + return t('Users will no longer be able to use the flag, but no data will be lost.'); + } + + return t('The flag will appear once more on configured nodes.'); + } + + public function getConfirmText() { + if ($this->flag->isEnabled()) { + return $this->t('Disable'); + } + + return $this->t('Enable'); + } + + public function submitForm(array &$form, FormStateInterface $form_state) { + // Toggle the flag state. + if ($this->flag->isEnabled()) { + $this->flag->disable(); + } + else { + $this->flag->enable(); + } + + // Invalidate the flaggable render cache. + \Drupal::entityManager() + ->getViewBuilder($this->flag->entity_type) + ->resetCache(); + + // Save The flag entity. + $this->flag->save(); + + // Redirect to the flag admin page. + $form_state->setRedirect('flag.list'); + } + +} diff --git a/src/Form/FlagEditForm.php b/src/Form/FlagEditForm.php new file mode 100644 index 0000000..7695520 --- /dev/null +++ b/src/Form/FlagEditForm.php @@ -0,0 +1,32 @@ +entity; + + $form['#flag'] = $flag; + $form['#flag_name'] = $flag->id; + + $form['label'] = [ + '#type' => 'textfield', + '#title' => t('Label'), + '#default_value' => $flag->label, + '#description' => t('A short, descriptive title for this flag. It will be used in administrative interfaces to refer to this flag, and in page titles and menu items of some views this module provides (theses are customizable, though). Some examples could be Bookmarks, Favorites, or Offensive.', array('@insite-views-url' => Url::fromRoute('views_ui.list')->toString())), + '#maxlength' => 255, + '#required' => TRUE, + '#weight' => -3, + ]; + + $form['id'] = [ + '#type' => 'machine_name', + '#title' => t('Machine name'), + '#default_value' => $flag->id, + '#description' => t('The machine-name for this flag. It may be up to 32 characters long and may only contain lowercase letters, underscores, and numbers. It will be used in URLs and in all API calls.'), + '#weight' => -2, + '#machine_name' => [ + 'exists' => [$this, 'exists'], + ], + '#disabled' => !$flag->isNew(), + '#required' => TRUE, + ]; + + $form['is_global'] = [ + '#type' => 'checkbox', + '#title' => t('Global flag'), + '#default_value' => $flag->isGlobal(), + '#description' => t('If checked, flag is considered "global" and each entity is either flagged or not. If unchecked, each user has individual flags on entities.'), + '#weight' => -1, + ]; + + $form['messages'] = [ + '#type' => 'fieldset', + '#title' => t('Messages'), + ]; + + $flag_short = $flag->getFlagShortText(); + $form['messages']['flag_short'] = [ + '#type' => 'textfield', + '#title' => t('Flag link text'), + '#default_value' => !empty($flag_short) ? $flag_short : t('Flag this item'), + '#description' => t('The text for the "flag this" link for this flag.'), + '#required' => TRUE, + ]; + + $form['messages']['flag_long'] = [ + '#type' => 'textfield', + '#title' => t('Flag link description'), + '#default_value' => $flag->getFlagLongText(), + '#description' => t('The description of the "flag this" link. Usually displayed on mouseover.'), + ]; + + $form['messages']['flag_message'] = [ + '#type' => 'textfield', + '#title' => t('Flagged message'), + '#default_value' => $flag->getFlagMessage(), + '#description' => t('Message displayed after flagging content. If JavaScript is enabled, it will be displayed below the link. If not, it will be displayed in the message area.'), + ]; + + $unflag_short = $flag->getUnflagShortText(); + $form['messages']['unflag_short'] = [ + '#type' => 'textfield', + '#title' => t('Unflag link text'), + '#default_value' => !empty($unflag_short) ? $unflag_short : t('Unflag this item'), + '#description' => t('The text for the "unflag this" link for this flag.'), + '#required' => TRUE, + ]; + + $form['messages']['unflag_long'] = [ + '#type' => 'textfield', + '#title' => t('Unflag link description'), + '#default_value' => $flag->getUnflagLongText(), + '#description' => t('The description of the "unflag this" link. Usually displayed on mouseover.'), + ]; + + $form['messages']['unflag_message'] = [ + '#type' => 'textfield', + '#title' => t('Unflagged message'), + '#default_value' => $flag->getUnflagMessage(), + '#description' => t('Message displayed after content has been unflagged. If JavaScript is enabled, it will be displayed below the link. If not, it will be displayed in the message area.'), + ]; + + $form['access'] = [ + '#type' => 'fieldset', + '#title' => t('Flag access'), + '#tree' => FALSE, + '#weight' => 10, + ]; + + // Switch plugin type in case a different is chosen. + + $flag_type_plugin = $flag->getFlagTypePlugin(); + $flag_type_def = $flag_type_plugin->getPluginDefinition(); + + $bundles = entity_get_bundles($flag_type_def['entity_type']); + $entity_bundles = []; + foreach ($bundles as $bundle_id => $bundle_row) { + $entity_bundles[$bundle_id] = $bundle_row['label']; + } + + // Flag classes will want to override this form element. + $form['access']['types'] = [ + '#type' => 'checkboxes', + '#title' => t('Flaggable types'), + '#options' => $entity_bundles, + '#default_value' => $flag->types, + '#description' => t('Check any sub-types that this flag may be used on.'), + '#required' => TRUE, + '#weight' => 10, + ]; + + $form['access']['unflag_denied_text'] = [ + '#type' => 'textfield', + '#title' => t('Unflag not allowed text'), + '#default_value' => $flag->getUnflagDeniedText(), + '#description' => t('If a user is allowed to flag but not unflag, this text will be displayed after flagging. Often this is the past-tense of the link text, such as "flagged".'), + '#weight' => -1, + ]; + + $form['display'] = [ + '#type' => 'fieldset', + '#title' => t('Display options'), + '#description' => t('Flags are usually controlled through links that allow users to toggle their behavior. You can choose how users interact with flags by changing options here. It is legitimate to have none of the following checkboxes ticked, if, for some reason, you wish to place the the links on the page yourself.', array('@placement-url' => 'http://drupal.org/node/295383')), + '#tree' => FALSE, + '#weight' => 20, + // @todo: Move flag_link_type_options_states() into controller? + // '#after_build' => array('flag_link_type_options_states'), + ]; + + $form['display']['settings'] = [ + '#type' => 'container', + '#prefix' => '' . t('This filter is only needed if the relationship used has the "Include only flagged content" option unchecked. Otherwise, this filter is useless, because all records are already limited to flagged content.') . '
' . t('By choosing Not flagged, it is possible to create a list of content that is specifically not flagged.', array('@unflagged-url' => 'http://drupal.org/node/299335')) . '
'; + + $form['relationship']['#default_value'] = $this->options['relationship']; + + parent::buildOptionsForm($form, $form_state); + } + + /** + * {@inheritdoc} + */ + public function query() { + $this->ensureMyTable(); + + $operator = $this->options['value'] ? 'IS NOT' : 'IS'; + $operator .= ' NULL'; + + $this->query->addWhere($this->options['group'], "$this->tableAlias.uid", NULL, $operator); + } +} diff --git a/src/Plugin/views/relationship/FlagViewsRelationship.php b/src/Plugin/views/relationship/FlagViewsRelationship.php new file mode 100644 index 0000000..62f1f0e --- /dev/null +++ b/src/Plugin/views/relationship/FlagViewsRelationship.php @@ -0,0 +1,128 @@ + NULL]; + $options['required'] = ['default' => 1]; + $options['user_scope'] = ['default' => 'current']; + return $options; + } + + /** + * {@inheritdoc} + */ + public function buildOptionsForm(&$form, FormStateInterface $form_state) { + parent::buildOptionsForm($form, $form_state); + + $entity_type = $this->definition['flaggable']; + $form['label']['#description'] .= ' ' . t('The name of the selected flag makes a good label.'); + + $flags = \Drupal::service('flag')->getFlags($entity_type); + + $default_value = $this->options['flag']; + if (!empty($flags)) { + $default_value = current(array_keys($flags)); + } + + $form['flag'] = [ + '#type' => 'radios', + '#title' => t('Flag'), + '#default_value' => $default_value, + '#required' => TRUE, + ]; + + foreach ($flags as $fid => $flag) { + if (!empty($flag)) { + $form['flag']['#options'][$fid] = $flag->label(); + } + } + + $form['user_scope'] = [ + '#type' => 'radios', + '#title' => t('By'), + '#options' => ['current' => t('Current user'), 'any' => t('Any user')], + '#default_value' => $this->options['user_scope'], + ]; + + $form['required']['#title'] = t('Include only flagged content'); + $form['required']['#description'] = t('If checked, only content that has this flag will be included. Leave unchecked to include all content; or, in combination with the Flagged filter, to limit the results to specifically unflagged content.', ['@unflagged-url' => 'http://drupal.org/node/299335']); + + if (!$form['flag']['#options']) { + $form = [ + 'error' => [ + '#markup' => '' . t('No %type flags exist. You must first create a %type flag before being able to use this relationship type.', ['%type' => $entity_type, '@create-url' => Url::fromRoute('flag.list')->toString()]) . '
', + ], + ]; + } + } + + /** + * {@inheritdoc} + */ + public function query() { + if (!($flag = $this->getFlag())) { + return; + } + + $this->definition['extra'][] = [ + 'field' => 'fid', + 'value' => $flag->id, + 'numeric' => TRUE, + ]; + + if ($this->options['user_scope'] == 'current' && !$flag->isGlobal()) { + $this->definition['extra'][] = [ + 'field' => 'uid', + 'value' => '***CURRENT_USER***', + 'numeric' => TRUE, + ]; + $flag_roles = user_roles(FALSE, "flag $flag->label"); + if (isset($flag_roles[DRUPAL_ANONYMOUS_RID])) { + // Disable page caching for anonymous users. + \Drupal::service('page_cache_kill_switch')->trigger(); + + // Add in the SID from Session API for anonymous users. + $this->definition['extra'][] = [ + 'field' => 'sid', + 'value' => '***FLAG_CURRENT_USER_SID***', + 'numeric' => TRUE, + ]; + } + } + + // parent::query(); + } + + /** + * Get the flag of the relationship. + * + * @return \Drupal\flag\FlagInterface|null + * The flag being selected by in the view. + */ + public function getFlag() { + $flaggable = $this->definition['flaggable']; + $flag = \Drupal::service('flag')->getFlags($flaggable); + $this->options['flag'] = $flag; + return current($flag); + } +} diff --git a/src/Plugin/views/sort/FlagViewsSortFlagged.php b/src/Plugin/views/sort/FlagViewsSortFlagged.php new file mode 100644 index 0000000..186ee77 --- /dev/null +++ b/src/Plugin/views/sort/FlagViewsSortFlagged.php @@ -0,0 +1,52 @@ + t('Unflagged first'), + 'DESC' => t('Flagged first'), + ]; + } + + /** + * Display whether or not the sort order is ascending or descending. + */ + public function adminSummary() { + if (!empty($this->options['exposed'])) { + return t('Exposed'); + } + + // Get the labels defined in sortOptions(). + $sort_options = $this->sortOptions(); + return $sort_options[strtoupper($this->options['order'])]; + } + + /** + * {@inheritdoc} + */ + public function query() { + $this->ensureMyTable(); + + $this->query->addOrderBy(NULL, "$this->tableAlias.uid", $this->options['order']); + } +} diff --git a/src/Tests/FlagConfirmFormTest.php b/src/Tests/FlagConfirmFormTest.php new file mode 100644 index 0000000..edb6a24 --- /dev/null +++ b/src/Tests/FlagConfirmFormTest.php @@ -0,0 +1,146 @@ +adminUser = $this->drupalCreateUser([ + 'administer flags', + 'administer flagging display', + 'administer node display', + ]); + + $this->drupalLogin($this->adminUser); + $this->doCreateFlag(); + $this->doCreateNode(); + } + + /** + * Create a node type and a flag. + */ + public function doCreateFlag() { + // Create content type. + $this->drupalCreateContentType(['type' => $this->nodeType]); + + // Test with minimal value requirement. + $edit = [ + 'label' => $this->label, + 'id' => $this->id, + 'flag_entity_type' => 'flagtype_node', + 'flag_link_type' => 'confirm', + ]; + $this->drupalPostForm('admin/structure/flags/add', $edit, t('Continue')); + + // Check confirm form field entry. + $this->assertText(t('Flag confirmation message')); + $this->assertText(t('Unflag confirmation message')); + + // Update the flag. + $edit = [ + 'types[' . $this->nodeType . ']' => $this->nodeType, + 'flag_confirmation' => $this->flagConfirmMessage, + 'unflag_confirmation' => $this->unflagConfirmMessage, + ]; + $this->drupalPostForm(NULL, $edit, t('Create Flag')); + + // Check to see if the flag was created. + $this->assertText(t('Flag @this_label has been added.', ['@this_label' => $this->label])); + } + + /** + * Create a node and flag it. + */ + public function doCreateNode() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $node_id = $node->id(); + + // Grant the flag permissions to the authenticated role, so that both + // users have the same roles and share the render cache. + $role = Role::load(DRUPAL_AUTHENTICATED_RID); + $role->grantPermission('flag ' . $this->id); + $role->grantPermission('unflag ' . $this->id); + $role->save(); + + // Create and login a new user. + $user_1 = $this->drupalCreateUser(); + $this->drupalLogin($user_1); + + // Click the flag link. + $this->drupalGet('node/' . $node_id); + $this->clickLink(t('Flag this item')); + + // Check if we have the confirm form message displayed. + $this->assertText($this->flagConfirmMessage); + + // Submit the confirm form. + $this->drupalPostForm('flag/confirm/flag/' . $this->id . '/' . $node_id, [], t('Flag')); + $this->assertResponse(200); + + // Check that the node is flagged. + $this->drupalGet('node/' . $node_id); + $this->assertLink(t('Unflag this item')); + } + +} diff --git a/src/Tests/FlagEnableDisableTest.php b/src/Tests/FlagEnableDisableTest.php new file mode 100644 index 0000000..8f533a3 --- /dev/null +++ b/src/Tests/FlagEnableDisableTest.php @@ -0,0 +1,161 @@ +adminUser = $this->drupalCreateUser([ + 'administer flags', + 'administer flagging display', + 'administer node display', + ]); + + $this->drupalLogin($this->adminUser); + + $this->doCreateFlag(); + $this->doCreateNode(); + $this->doDisableFlag(); + $this->doEnableFlag(); + } + + /** + * Create a node type and a flag. + */ + public function doCreateFlag() { + // Create content type. + $this->drupalCreateContentType(['type' => $this->nodeType]); + + // Test with minimal value requirement. + $edit = [ + 'label' => $this->label, + 'id' => $this->id, + 'flag_entity_type' => 'flagtype_node', + ]; + $this->drupalPostForm('admin/structure/flags/add', $edit, t('Continue')); + + $edit = [ + 'types[' . $this->nodeType . ']' => $this->nodeType, + 'flag_short' => $this->flagShortText, + 'unflag_short' => $this->unflagShortText, + ]; + $this->drupalPostForm(NULL, $edit, t('Create Flag')); + } + + /** + * Create a node and flag it. + */ + public function doCreateNode() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $this->node_id = $node->id(); + + // Grant the flag permissions to the authenticated role, so that both + // users have the same roles and share the render cache. + $role = Role::load(DRUPAL_AUTHENTICATED_RID); + $role->grantPermission('flag ' . $this->id); + $role->grantPermission('unflag ' . $this->id); + $role->save(); + + // Click the flag link. + $this->drupalGet('node/' . $this->node_id); + + $this->assertText($this->flagShortText); + } + + /** + * Disable the flag and ensure the link does not appear on entities. + */ + public function doDisableFlag() { + $this->drupalGet('admin/structure/flags'); + $this->assertText(t('enabled')); + + $this->drupalPostForm('flag/disable/' . $this->id, [], t('Disable')); + $this->assertResponse(200); + + $this->drupalGet('admin/structure/flags'); + $this->assertText(t('disabled')); + + $this->drupalGet('node/' . $this->node_id); + $this->assertNoText($this->flagShortText); + } + + /** + * Enable the flag and ensure it appears on target entities. + */ + public function doEnableFlag() { + $this->drupalGet('admin/structure/flags'); + $this->assertText(t('disabled')); + + $this->drupalPostForm('flag/enable/' . $this->id, [], t('Enable')); + $this->assertResponse(200); + + $this->drupalGet('admin/structure/flags'); + $this->assertText(t('enabled')); + + $this->drupalGet('node/' . $this->node_id); + $this->assertText($this->flagShortText); + } +} diff --git a/src/Tests/FlagFieldEntryTest.php b/src/Tests/FlagFieldEntryTest.php new file mode 100644 index 0000000..49537aa --- /dev/null +++ b/src/Tests/FlagFieldEntryTest.php @@ -0,0 +1,206 @@ +adminUser = $this->drupalCreateUser([ + 'administer flags', + 'administer flagging display', + 'administer flagging fields', + 'administer node display', + ]); + + $this->drupalLogin($this->adminUser); + $this->doCreateFlag(); + $this->doAddFields(); + $this->doCreateFlagNode(); + $this->doEditFlagField(); + } + + /** + * Create a node type and flag. + */ + public function doCreateFlag() { + // Create content type. + $this->drupalCreateContentType(['type' => $this->nodeType]); + + // Test with minimal value requirement. + $edit = [ + 'label' => $this->label, + 'id' => $this->id, + 'flag_entity_type' => 'flagtype_node', + 'flag_link_type' => 'field_entry', + ]; + $this->drupalPostForm('admin/structure/flags/add', $edit, t('Continue')); + + // Check confirm form field entry. + $this->assertText(t('Flag confirmation message')); + $this->assertText(t('Enter flagging details message')); + $this->assertText(t('Unflag confirmation message')); + + // Update the flag. + $edit = [ + 'types[' . $this->nodeType . ']' => $this->nodeType, + 'flag_confirmation' => $this->flagConfirmMessage, + 'flagging_edit_title' => $this->flagDetailsMessage, + 'unflag_confirmation' => $this->unflagConfirmMessage, + ]; + $this->drupalPostForm(NULL, $edit, t('Create Flag')); + + // Check to see if the flag was created. + $this->assertText(t('Flag @this_label has been added.', ['@this_label' => $this->label])); + } + + /** + * Add fields to flag. + */ + public function doAddFields() { + $edit = [ + 'fields[_add_new_field][label]' => $this->flagFieldLabel, + 'fields[_add_new_field][field_name]' => $this->flagFieldId, + 'fields[_add_new_field][type]' => 'text', + ]; + $this->drupalPostForm('admin/structure/flags/manage/' . $this->id . '/fields', $edit, t('Save')); + + $edit = [ + 'field_storage[cardinality]' => '-1', + 'field_storage[cardinality_number]' => '1', + ]; + $this->drupalPostForm(NULL, $edit, t('Save field settings')); + + $this->assertText(t('Updated field') . ' ' . $this->flagFieldLabel . ' ' . t('field settings.')); + } + + /** + * Create a node and flag it. + */ + public function doCreateFlagNode() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $this->nodeId = $node->id(); + + // Grant the flag permissions to the authenticated role, so that both + // users have the same roles and share the render cache. + $role = Role::load(DRUPAL_AUTHENTICATED_RID); + $role->grantPermission('flag ' . $this->id); + $role->grantPermission('unflag ' . $this->id); + $role->save(); + + // Create and login a new user. + $user_1 = $this->drupalCreateUser(); + $this->drupalLogin($user_1); + + // Click the flag link. + $this->drupalGet('node/' . $this->nodeId); + $this->clickLink(t('Flag this item')); + + // Check if we have the confirm form message displayed. + $this->assertText($this->flagConfirmMessage); + + // Enter the field value and submit it. + $this->flagFieldValue = $this->randomString(); + $edit = [ + 'field_' . $this->flagFieldId . '[0][value]' => $this->flagFieldValue, + ]; + $this->drupalPostForm(NULL, $edit, t('Update Flagging')); + + // Check that the node is flagged. + $this->assertLink(t('Unflag this item')); + } + + /** + * Edit the field value of the existing flagging. + */ + public function doEditFlagField() { + // Get the details form. + $this->drupalGet('flag/details/edit/' . $this->id . '/' . $this->nodeId); + + // See if the details message is displayed. + $this->assertText($this->flagDetailsMessage); + + // See if the field value was preserved. + $this->assertFieldByName('field_' . $this->flagFieldId . '[0][value]', $this->flagFieldValue); + + // Update the field value. + $this->flagFieldValue = $this->randomString(); + $edit = [ + 'field_' . $this->flagFieldId . '[0][value]' => $this->flagFieldValue, + ]; + $this->drupalPostForm(NULL, $edit, t('Update Flagging')); + + // Get the details form. + $this->drupalGet('flag/details/edit/' . $this->id . '/' . $this->nodeId); + + // See if the field value was preserved. + $this->assertFieldByName('field_' . $this->flagFieldId . '[0][value]', $this->flagFieldValue); + } + +} diff --git a/src/Tests/FlagSimpleTest.php b/src/Tests/FlagSimpleTest.php new file mode 100644 index 0000000..2d99134 --- /dev/null +++ b/src/Tests/FlagSimpleTest.php @@ -0,0 +1,301 @@ +adminUser = $this->drupalCreateUser([ + 'administer flags', + 'administer flagging display', + 'administer node display', + ]); + + $this->drupalLogin($this->adminUser); + + $this->doTestFlagAdd(); + $this->doTestHideFlagLinkFromTeaser(); + } + + /** + * Flag creation. + */ + public function doTestFlagAdd() { + // Create content type. + $this->drupalCreateContentType(['type' => $this->nodeType]); + + // Test with minimal value requirement. + $edit = [ + 'label' => $this->label, + 'id' => $this->id, + ]; + $this->drupalPostForm('admin/structure/flags/add', $edit, t('Continue')); + // Check for fieldset titles. + $this->assertText(t('Messages')); + $this->assertText(t('Flag access')); + $this->assertText(t('Display options')); + + $edit = [ + 'types[' . $this->nodeType . ']' => $this->nodeType, + ]; + $this->drupalPostForm(NULL, $edit, t('Create Flag')); + + $this->assertText(t('Flag @this_label has been added.', ['@this_label' => $this->label])); + + // Continue test process. + $this->doTestCreateNodeAndFlagIt(); + } + + /** + * Node creation and flagging. + */ + public function doTestCreateNodeAndFlagIt() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $node_id = $node->id(); + + // Grant the flag permissions to the authenticated role, so that both + // users have the same roles and share the render cache. + $role = Role::load(DRUPAL_AUTHENTICATED_RID); + $role->grantPermission('flag ' . $this->id); + $role->grantPermission('unflag ' . $this->id); + $role->save(); + + // Create and login a new user. + $user_1 = $this->drupalCreateUser(); + $this->drupalLogin($user_1); + + $this->drupalGet('node/' . $node_id); + $this->clickLink('Flag this item'); + $this->assertResponse(200); + $this->assertLink('Unflag this item'); + + // Switch user to check flagging link. + $user_2 = $this->drupalCreateUser(); + $this->drupalLogin($user_2); + $this->drupalGet('node/' . $node_id); + $this->assertResponse(200); + $this->assertLink('Flag this item'); + + // Switch back to first user and unflag. + $this->drupalLogin($user_1); + $this->drupalGet('node/' . $node_id); + + $this->clickLink('Unflag this item'); + $this->assertResponse(200); + $this->assertLink('Flag this item'); + + // Check that the anonymous user, who does not have the necessary + // permissions, does not see the flag link. + $this->drupalLogout(); + $this->drupalGet('node/' . $node_id); + $this->assertNoLink('Flag this item'); + } + + /** + * Node creation and flag link. + */ + public function doTestHideFlagLinkFromTeaser() { + $this->drupalLogin($this->adminUser); + + $node = $this->drupalCreateNode([ + 'type' => $this->nodeType, + 'promote' => TRUE, + ]); + $node_id = $node->id(); + $node_title = $node->getTitle(); + + $this->drupalGet('node'); + $this->assertText($node_title); + $this->assertLink('Flag this item'); + + // Set flag format to hidden for teaser display and post form. + $edit = [ + 'fields[flag_' . $this->id . '][type]' => 'hidden', + ]; + + $this->drupalPostForm('admin/structure/types/manage/' . $this->nodeType . '/display/teaser', $edit, t('Save')); + + // Check if form is saved successfully. + $this->assertText('Your settings have been saved.'); + + $this->drupalGet('node'); + $this->assertText($node_title); + $this->assertNoLink('Flag this item'); + + $this->drupalGet('node/' . $node_id); + + } + + /** + * Creates user, sets flags and deletes user. + */ + public function doTestUserDeletion() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $node_id = $node->id(); + + // Create and login a new user. + $user_1 = $this->drupalCreateUser(); + $this->drupalLogin($user_1); + + $this->drupalGet('node/' . $node_id); + $this->clickLink('Flag this item'); + $this->assertResponse(200); + $this->assertLink('Unflag this item'); + + $count_flags_before = \Drupal::entityQuery('flagging') + ->condition('uid', $user_1->id()) + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + + $this->assertTrue(1, $count_flags_before); + + $user_1->delete(); + + $count_flags_after = \Drupal::entityQuery('flagging') + ->condition('uid', $user_1->id()) + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + + $this->assertTrue(0, $count_flags_after); + } + + /** + * Flags a node using different user accounts and checks flag counts. + */ + public function doTestFlagCounts() { + $node = $this->drupalCreateNode(['type' => $this->nodeType]); + $node_id = $node->id(); + + // Create and login user 1. + $user_1 = $this->drupalCreateUser(); + $this->drupalLogin($user_1); + + // Flag node (first count). + $this->drupalGet('node/' . $node_id); + $this->clickLink('Flag this item'); + $this->assertResponse(200); + $this->assertLink('Unflag this item'); + + // Check for 1 flag count. + $count_flags_before = \Drupal::entityQuery('flag_counts') + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + $this->assertTrue(1, $count_flags_before); + + // Logout user 1, create and login user 2. + $user_2 = $this->drupalCreateUser(); + $this->drupalLogin($user_2); + + // Flag node (second count). + $this->drupalGet('node/' . $node_id); + $this->clickLink('Flag this item'); + $this->assertResponse(200); + $this->assertLink('Unflag this item'); + + // Check for 2 flag counts. + $count_flags_after = \Drupal::entityQuery('flag_counts') + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + $this->assertTrue(2, $count_flags_after); + + // Unflag the node again. + $this->drupalGet('node/' . $node_id); + $this->clickLink('Unflag this item'); + $this->assertResponse(200); + $this->assertLink('Flag this item'); + + // Check for 1 flag count. + $count_flags_before = \Drupal::entityQuery('flag_counts') + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + $this->assertTrue(1, $count_flags_before); + + // Delete user 1. + $user_1->delete(); + + // Check for 0 flag counts, user deletion should lead to count decrement + // or row deletion. + $count_flags_before = \Drupal::entityQuery('flag_counts') + ->condition('fid', $this->id) + ->condition('entity_type', $node->getEntityTypeId()) + ->condition('entity_id', $node_id) + ->count() + ->execute(); + $this->assertTrue(0, $count_flags_before); + } +} diff --git a/tests/flag.test b/tests/flag.test deleted file mode 100644 index 461650e..0000000 --- a/tests/flag.test +++ /dev/null @@ -1,119 +0,0 @@ - t('Flag tests'), - 'description' => t('Add, edit and delete flags.'), - 'group' => t('Flag'), - ); - } - - /** - * Implementation of setUp(). - */ - function setUp() { - parent::setUp('flag'); - - // Create and login user - $admin_user = $this->drupalCreateUser(array('access administration pages', 'administer flags')); - $this->drupalLogin($admin_user); - } - - /** - * Create a flag through the UI and ensure that it is saved properly. - */ - function testFlagAdmin() { - // Add a new flag using the UI. - $edit = array( - 'name' => strtolower($this->randomName()), - 'title' => $this->randomName(), - 'flag_short' => 'flag short [nid]', - 'flag_long' => 'flag long [nid]', - 'flag_message' => 'flag message [nid]', - 'unflag_short' => 'unflag short [nid]', - 'unflag_long' => 'unflag long [nid]', - 'unflag_message' => 'unflag message [nid]', - 'roles[flag][2]' => TRUE, - 'roles[unflag][2]' => TRUE, - 'types[story]' => FALSE, - 'types[page]' => TRUE, - 'show_on_teaser' => FALSE, - 'show_on_page' => FALSE, - 'show_on_form' => FALSE, - 'link_type' => 'toggle', - ); - $saved = $edit; - $saved['roles'] = array('flag' => array(2), 'unflag' => array(2)); - $saved['types'] = array('page'); - unset($saved['roles[flag][2]'], $saved['roles[unflag][2]'], $saved['types[story]'], $saved['types[page]']); - - $this->drupalPost(FLAG_ADMIN_PATH . '/add/node/' . $edit['name'], $edit, t('Submit')); - - $flag = flag_get_flag($edit['name']); - - // Check that the flag object is in the database. - $this->assertTrue($flag != FALSE, t('Flag object found in database')); - - // Check each individual property of the flag and make sure it was set. - foreach ($saved as $property => $value) { - $this->assertEqual($flag->$property, $value, t('Flag property %property properly saved.', array('%property' => $property))); - } - - // Edit the flag through the UI. - $edit = array( - 'name' => strtolower($this->randomName()), - 'title' => $this->randomName(), - 'flag_short' => 'flag 2 short [nid]', - 'flag_long' => 'flag 2 long [nid]', - 'flag_message' => 'flag 2 message [nid]', - 'unflag_short' => 'unflag 2 short [nid]', - 'unflag_long' => 'unflag 2 long [nid]', - 'unflag_message' => 'unflag 2 message [nid]', - 'roles[flag][2]' => TRUE, - 'roles[unflag][2]' => TRUE, - 'types[story]' => TRUE, - 'types[page]' => FALSE, - 'show_on_teaser' => TRUE, - 'show_on_page' => TRUE, - 'show_on_form' => TRUE, - 'link_type' => 'normal', - ); - $saved = $edit; - $saved['roles'] = array('flag' => array(2), 'unflag' => array(2)); - $saved['types'] = array('story'); - unset($saved['roles[flag][2]'], $saved['roles[unflag][2]'], $saved['types[story]'], $saved['types[page]']); - - $this->drupalPost(FLAG_ADMIN_PATH . '/edit/' . $flag->name, $edit, t('Submit')); - - flag_get_flags(NULL, NULL, NULL, TRUE); - $flag = flag_get_flag($edit['name']); - - // Check that the flag object is in the database. - $this->assertTrue($flag != FALSE, t('Flag object found in database')); - - // Check each individual property of the flag and make sure it was set. - foreach ($saved as $property => $value) { - $this->assertEqual($flag->$property, $value, t('Flag property %property properly saved.', array('%property' => $property))); - } - - // Delete the flag through the UI. - $this->drupalPost(FLAG_ADMIN_PATH . '/delete/' . $flag->name, array(), t('Delete')); - flag_get_flags(NULL, NULL, NULL, TRUE); - $this->assertFalse(flag_get_flag($flag->name), t('Flag successfully deleted.')); - } - - /** - * Test that only allowed users have access to flags. - */ - function testFlagAccess() { - - } - -} - diff --git a/theme/README.txt b/theme/README.txt index d369781..ea98c51 100644 --- a/theme/README.txt +++ b/theme/README.txt @@ -17,11 +17,13 @@ In order to customize flag theming: - Edit that copy to your liking. -Template variants[3] +Template variants ----------------- -In addition, the theme layer will first look for the template -'flag--