Flag Ctools integration

I am working on a site using Bio & Advanced Profile. I patched the Flag module, created & uploaded the links.inc file to includes/panels.

Created a bookmark only for Uprofile type, added "Node ID" as an argument & "User uprofile" as a relationship in the advanced profile panels page (see: screenshot).

(Note: by default, the advanced profile panel only had "User ID" as an argument and "Node from user" as relationship.)

No Flag blocks showing in the content section pop-ups.

Any suggestions on what needs to be done to configure this would be appreciated.

I have added:

function flag_link_panels_content_types() {
  drupal_set_message('Hello! I was called!');
  $items['flag_link'] = array(

to the link.inc file, and do not see "hello" when configuring the panel.

What I really need to do is be able to print the flag link in a specific part of a Panels block - which has a self-existing (APK) template.

Note: it is 5.x we are working with.

I added

 */
drupal_set_message('This link.inc file was loaded!');

function flag_link_panels_content_types() {
  drupal_set_message('Hello! I was called!');
  $items['flag_link'] = array(

to the link.inc file - checked the permissions, it was set to 644
Changed the permissions to 755 (folder is also 755)
"This link.inc file was loaded!" message did not appear in the message section

Hi, D6 please! :)

I added

function flag_panels_include_directory($plugin_type) {
  drupal_set_message("flag_panels_include_directory($plugin_type) was called!");
  if ($plugin_type == 'content_types') {

And I see the message as listed when first navigating to the panels page (list) - by the time I get to the settings page it is displayed 5 times in the message box.

To be more specific, on the content page:

    * flag_panels_include_directory(arguments) was called!
    * flag_panels_include_directory(contexts) was called!
    * flag_panels_include_directory(arguments) was called!
    * flag_panels_include_directory(contexts) was called!
    * flag_panels_include_directory(content_types) was called!
    * flag_panels_include_directory(layouts) was called!
    * flag_panels_include_directory(cache) was called!

I received:

File sites/all/modules/flag/includes/panels/link.inc doesn't exist

which made it clear the mistake was I uploaded the file to /includes/panels (drupal core) and not to the flag module directory

changed that and received:

File exists...and is readable

Flag bookmarks now showing in the add content section of panels (thanks)

only thing - getting a "missing content type - Deleted/missing content type flag_link"

I have this bookmark only set to uprofile type, same result though when biography & user node are enabled
+ "Node from User" / "Node ID" / "User uprofile 2" are my three choices for the block configuration

the settings in context are the same as the screenshot above (panels.png)

Result I end up with is: Flag "" is not defined.

Bumping this again as I need to solve the issue - 1) is what is the reason for the Flag is not defined result, and 2) is there still not anyway to simply print the flag link in the template of the advanced profile page?

Nice - it is working perfectly now. I really appreciate your attention to these issues and assistance in working out the bugs. The functionality is important to our sites - many thanks.

How do I do this for D6?

Created flag.panels.inc
Added patch to flag.module

Uploaded

Flags appeared on Add Content To... in Panels2. When I inserted received the error: Error: Flag "f" is not defined.

This patch wasn't tested on D6.

How to do it in Drupal 6?

oh no :\ what can drupal 6 users do now? i need this feature.

hope that somebody can do this. i appreciate this very much!

Same here

subscribe.... D6 & Panels 3???

subscribing. Trying to get this to work.

also subscribing for Drupal6 & Panels3

Needs work for the D6 version of panels (3.x), at this point I don't think it's worth maintaining a Drupal 5 version of this feature.

has anybody else had any luck with this yet

+1

Moving to 2.x where all new features are being added. I don't use Panels module so I'm very unlikely to develop such a feature. Unless a community developer puts this together, this is unlikely to happen.

also subscribing for D6 & Panels 3

--------------
I circumvented the problem by amending node.tpl.php of my theme:

- inserting print flag_create_link('bookmarks', $node->nid); in the link section ;
- create a pane with node > node links

There is actually a quite easy solution for this, however, not as easy as directly from panel. Here is what you do:
- create a view that displays a flag link for the corresponding node

In my case, I have a node type for a video page on my site and have three flags: like, bookmark, report

Below is the views export for a) only one flag (in my case the like flag) and b) for all three of my flags

$view = new view;
$view->name = 'test_flags_link';
$view->description = '';
$view->tag = '';
$view->view_php = '';
$view->base_table = 'node';
$view->is_cacheable = FALSE;
$view->api_version = 2;
$view->disabled = FALSE; /* Edit this to true to make a default view disabled initially */
$handler = $view->new_display('default', 'Defaults', 'default');
$handler->override_option('relationships', array(
  'flag_content_rel' => array(
    'label' => 'flag',
    'required' => 0,
    'flag' => 'like',
    'user_scope' => 'current',
    'id' => 'flag_content_rel',
    'table' => 'node',
    'field' => 'flag_content_rel',
    'relationship' => 'none',
  ),
));
$handler->override_option('fields', array(
  'ops' => array(
    'label' => '',
    'alter' => array(
      'alter_text' => 0,
      'text' => '',
      'make_link' => 0,
      'path' => '',
      'link_class' => '',
      'alt' => '',
      'prefix' => '',
      'suffix' => '',
      'target' => '',
      'help' => '',
      'trim' => 0,
      'max_length' => '',
      'word_boundary' => 1,
      'ellipsis' => 1,
      'strip_tags' => 0,
      'html' => 0,
    ),
    'empty' => '',
    'hide_empty' => 0,
    'empty_zero' => 0,
    'link_type' => 'toggle',
    'exclude' => 0,
    'id' => 'ops',
    'table' => 'flag_content',
    'field' => 'ops',
    'relationship' => 'flag_content_rel',
  ),
));
$handler->override_option('arguments', array(
  'nid' => array(
    'default_action' => 'default',
    'style_plugin' => 'default_summary',
    'style_options' => array(),
    'wildcard' => 'all',
    'wildcard_substitution' => 'All',
    'title' => '',
    'breadcrumb' => '',
    'default_argument_type' => 'node',
    'default_argument' => '',
    'validate_type' => 'none',
    'validate_fail' => 'not found',
    'break_phrase' => 0,
    'not' => 0,
    'id' => 'nid',
    'table' => 'node',
    'field' => 'nid',
    'validate_user_argument_type' => 'uid',
    'validate_user_roles' => array(
      '2' => 0,
    ),
    'relationship' => 'none',
    'default_options_div_prefix' => '',
    'default_argument_user' => 0,
    'default_argument_fixed' => '',
    'default_argument_php' => '',
    'validate_argument_node_type' => array(
      'panel' => 0,
      'profile' => 0,
      'story' => 0,
      'uprofile' => 0,
      'video' => 0,
    ),
    'validate_argument_node_access' => 0,
    'validate_argument_nid_type' => 'nid',
    'validate_argument_vocabulary' => array(
      '1' => 0,
      '6' => 0,
      '2' => 0,
      '3' => 0,
      '4' => 0,
      '5' => 0,
    ),
    'validate_argument_type' => 'tid',
    'validate_argument_transform' => 0,
    'validate_user_restrict_roles' => 0,
    'validate_argument_node_flag_name' => '*relationship*',
    'validate_argument_node_flag_test' => 'flaggable',
    'validate_argument_node_flag_id_type' => 'id',
    'validate_argument_user_flag_name' => '*relationship*',
    'validate_argument_user_flag_test' => 'flaggable',
    'validate_argument_user_flag_id_type' => 'id',
    'validate_argument_php' => '',
  ),
));
$handler->override_option('access', array(
  'type' => 'none',
));
$handler->override_option('cache', array(
  'type' => 'none',
));
$handler = $view->new_display('block', 'Block', 'block_1');
$handler->override_option('block_description', '');
$handler->override_option('block_caching', -1);

$view = new view;
$view->name = 'test_flags_link';
$view->description = '';
$view->tag = '';
$view->view_php = '';
$view->base_table = 'node';
$view->is_cacheable = FALSE;
$view->api_version = 2;
$view->disabled = FALSE; /* Edit this to true to make a default view disabled initially */
$handler = $view->new_display('default', 'Defaults', 'default');
$handler->override_option('relationships', array(
  'flag_content_rel' => array(
    'label' => 'like',
    'required' => 0,
    'flag' => 'like',
    'user_scope' => 'current',
    'id' => 'flag_content_rel',
    'table' => 'node',
    'field' => 'flag_content_rel',
    'relationship' => 'none',
  ),
  'flag_content_rel_1' => array(
    'label' => 'bookmark',
    'required' => 0,
    'flag' => 'bookmarks',
    'user_scope' => 'current',
    'id' => 'flag_content_rel_1',
    'table' => 'node',
    'field' => 'flag_content_rel',
    'relationship' => 'none',
  ),
  'flag_content_rel_2' => array(
    'label' => 'report',
    'required' => 0,
    'flag' => 'report',
    'user_scope' => 'current',
    'id' => 'flag_content_rel_2',
    'table' => 'node',
    'field' => 'flag_content_rel',
    'relationship' => 'none',
  ),
));
$handler->override_option('fields', array(
  'ops' => array(
    'label' => '',
    'alter' => array(
      'alter_text' => 0,
      'text' => '',
      'make_link' => 0,
      'path' => '',
      'link_class' => '',
      'alt' => '',
      'prefix' => '',
      'suffix' => '',
      'target' => '',
      'help' => '',
      'trim' => 0,
      'max_length' => '',
      'word_boundary' => 1,
      'ellipsis' => 1,
      'strip_tags' => 0,
      'html' => 0,
    ),
    'empty' => '',
    'hide_empty' => 0,
    'empty_zero' => 0,
    'link_type' => 'toggle',
    'exclude' => 0,
    'id' => 'ops',
    'table' => 'flag_content',
    'field' => 'ops',
    'relationship' => 'flag_content_rel',
  ),
  'ops_1' => array(
    'label' => '',
    'alter' => array(
      'alter_text' => 0,
      'text' => '',
      'make_link' => 0,
      'path' => '',
      'link_class' => '',
      'alt' => '',
      'prefix' => '',
      'suffix' => '',
      'target' => '',
      'help' => '',
      'trim' => 0,
      'max_length' => '',
      'word_boundary' => 1,
      'ellipsis' => 1,
      'strip_tags' => 0,
      'html' => 0,
    ),
    'empty' => '',
    'hide_empty' => 0,
    'empty_zero' => 0,
    'link_type' => '',
    'exclude' => 0,
    'id' => 'ops_1',
    'table' => 'flag_content',
    'field' => 'ops',
    'relationship' => 'flag_content_rel_1',
  ),
  'ops_2' => array(
    'label' => '',
    'alter' => array(
      'alter_text' => 0,
      'text' => '',
      'make_link' => 0,
      'path' => '',
      'link_class' => '',
      'alt' => '',
      'prefix' => '',
      'suffix' => '',
      'target' => '',
      'help' => '',
      'trim' => 0,
      'max_length' => '',
      'word_boundary' => 1,
      'ellipsis' => 1,
      'strip_tags' => 0,
      'html' => 0,
    ),
    'empty' => '',
    'hide_empty' => 0,
    'empty_zero' => 0,
    'link_type' => '',
    'exclude' => 0,
    'id' => 'ops_2',
    'table' => 'flag_content',
    'field' => 'ops',
    'relationship' => 'flag_content_rel_2',
  ),
));
$handler->override_option('arguments', array(
  'nid' => array(
    'default_action' => 'default',
    'style_plugin' => 'default_summary',
    'style_options' => array(),
    'wildcard' => 'all',
    'wildcard_substitution' => 'All',
    'title' => '',
    'breadcrumb' => '',
    'default_argument_type' => 'node',
    'default_argument' => '',
    'validate_type' => 'none',
    'validate_fail' => 'not found',
    'break_phrase' => 0,
    'not' => 0,
    'id' => 'nid',
    'table' => 'node',
    'field' => 'nid',
    'validate_user_argument_type' => 'uid',
    'validate_user_roles' => array(
      '2' => 0,
    ),
    'relationship' => 'none',
    'default_options_div_prefix' => '',
    'default_argument_user' => 0,
    'default_argument_fixed' => '',
    'default_argument_php' => '',
    'validate_argument_node_type' => array(
      'panel' => 0,
      'profile' => 0,
      'story' => 0,
      'uprofile' => 0,
      'video' => 0,
    ),
    'validate_argument_node_access' => 0,
    'validate_argument_nid_type' => 'nid',
    'validate_argument_vocabulary' => array(
      '1' => 0,
      '6' => 0,
      '2' => 0,
      '3' => 0,
      '4' => 0,
      '5' => 0,
    ),
    'validate_argument_type' => 'tid',
    'validate_argument_transform' => 0,
    'validate_user_restrict_roles' => 0,
    'validate_argument_node_flag_name' => '*relationship*',
    'validate_argument_node_flag_test' => 'flaggable',
    'validate_argument_node_flag_id_type' => 'id',
    'validate_argument_user_flag_name' => '*relationship*',
    'validate_argument_user_flag_test' => 'flaggable',
    'validate_argument_user_flag_id_type' => 'id',
    'validate_argument_php' => '',
  ),
));
$handler->override_option('access', array(
  'type' => 'none',
));
$handler->override_option('cache', array(
  'type' => 'none',
));
$handler = $view->new_display('block', 'Block', 'block_1');
$handler->override_option('block_description', '');
$handler->override_option('block_caching', -1);

Subscribing...

Subscribing...

subscribing. need to attach a flag to a panel page.

Panels integration must include:

- Ability to add flags to node/user pages
- Ability to check if content is flagged in access rules
- Ability to check flag status in selection rules, so page can use different variants depending on flag status
- Load flag and flagger as context and/or argument
- ... (more?)

got it, thanks

when we will have a panels version of flag ? its a important function since panels is widely used in drupal.

when we will have a panels version of flag ?

When someone writes it. :P

I don't use Panels, and I'm not going to write integration for something I don't use. Considering I won't be able to maintain such code, it may end up in a separate project entirely.

ok, ill write it, im not much of a writer, but I hope it will turn out awesome... right now I am consulting with allmighty merlin over at #889088: flag ctools integration. go there, there is some code you can try out...

content type plug-in is also available at #889088: flag ctools integration It will allow you to display flag links as well as display flag status in panels.

this is latest version, wrapped into a module. Drop this in flag folder or in modules, activate under Flags.

Has access and content types plugins, other soon. Questions, comments?

This would be incredible, thank you so much for your work.

I can seem to get it to work, I was hoping you could help, it may be something I have done wrong. I am not a coder, but would be more than happy to be an active tester if you have need. I have dropped ctools_flag into the modules dir, but I am not seeing any change in panels.

Your module would be a complete solution to what I am looking for, so I can not thank you enough. I have been looking for a way to create panels "layout" variants and be able to select them or change them on the fly instead of creating/cloning variants for each instance. Since my navigation/site structure is taxonomy based and I am overriding the tax term view in panels, I thought it may be possible to use the flag terms module to flag a term in the site structure vocab as "Layout 1", "Layout 2", etc... and then apply the flag as a selection rule. This would negate the need to create cloned variants per tax term just to change the panel page a bit. Also, the layouts can be adjusted on the fly.

I hope this makes sense. If there is another way to accomplish this that you know, please let me know. I would love any input you would have to offer.

thanks again

Currently only node flags are supported, Ill work on it a little more to add user and term support.

thank you so much.

subscribing

good job :)

i can confirm that it is working well, when directly included in a Panel

-------------------------------------------------------------------------------------------------------
Flags also work well as before, with or without this module, when using as a Field in a View included in a Panel.
the View itself also works well, even with a nid argument (which is supplied by Panels when inside a panel).

so there is no conflict, even when using both methods at same time in a panel :P
-------------------------------------------------------------------------------------------------------

please commit to the module, in the main module or as a standalone module (included or not with Flags).
thanks

works pretty well :)

commit it somewhere :P

other working solutions:
Fivestar panels integration - http://drupal.org/node/703614
Ubercart panels integration - http://drupal.org/node/658732

This will be independent module as soon as it is ready.

Subscribing

Is user flags are supported now ? I am using the APK, waitting for the user flags, thanks

Any activity on this? What are our options?

#53 What is the module going to be called? Does it have a project page yet?

So to add flags for panels, the zip file in #44 is downloaded into all/modules OR all/modules/flag and extracted?

Then enabled?

Thank you!

EDIT I installed the zip in all/modules, extracted it, enabled it like a regular module. Went to a panel -> add content -> flag -> flag links.

Seems to work great. Hope it becomes a module, easier for people to find!

Thank you!

works just like a regular module

Yes thank you it is a big relief.

Tested, works great.

It should be made easier to find, if possible.

What is left for this to be released?

Still under construction.

Is it going to be a sub-module or standalone? Either way, can it go into CVS?
Is it being developed on github or something?

If it was on d.o, then users could open up issues against it, or at least see what the timeline was.

any progress for this module ? Thanks

+1

Needs caching support in Panels. and with AJAX.

at this point, for it to work, you should disable global caching for the panel in question, and instead enable local caching for each item you place as content in your panel, except for flag.

+1

Node: Profile Node
User: User being viewed

Flag: Bookmarks

When I add to my "Content Profile/APK" panel, I see this when I click on a user:

* warning: array_keys() [function.array-keys]: The first argument should be an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

* warning: array_intersect() [function.array-intersect]: Argument #2 is not an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

* warning: array_keys() [function.array-keys]: The first argument should be an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

* warning: array_intersect() [function.array-intersect]: Argument #2 is not an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

* warning: array_keys() [function.array-keys]: The first argument should be an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

* warning: array_intersect() [function.array-intersect]: Argument #2 is not an array in /home/marc/domains/mywebsite.com/public_html/sites/all/modules/flag/flag.inc on line 347.

When I switch to

User: No Context

the errors are gone.

However, in both cases, I still do not see a link.

thanks!

WOW!!! thank you soo much for this patch. Works great!!

Subscribing

+1

Here's a new take, for D7 (porting back to 6 should be fairly easy).

Patch adds a ctools plugin that allows you to select the flag, and pass user/ node/ comment context, and on render uses flag_create_link() if context really exists.

Here's the D6 version

Minor fix -- have the flag's name as the block delta instead of the flag ID. Attached D6 and D7.

Here's a screenshot.

Expanding on the idea of ctools integration, I've written an access plugin for checking if a node is flagged. (This would require the flag_ctools_plugin_directory function from above, and this include file would go in plugins/access.)

@jastraat ,
1) Please open a different issue.
2) Please patch is correctly.
3) Flag is not node centric, the patch, similar to mine should allow user/ node/ comments (at least).

My hesitation for opening a separate issue is that this depends on the flag_ctools_plugin_directory function as well. Should I assume that function does not exist in flag when I create a patch file?

Patch in #77 applied against 7.x-dev and tests so far shows it is working well

+1
hope to see this fixed soon

Would really appreciate some help here. I applied the ctools-plugin-flag-77-d7.patch but still cannot get the flag to work in Panels - I presume there should be an option in the panels content options?

per #84 and I guess this patch need a reroll anyways.

  'required context' => new ctools_context_required(t('Node'), 'node'),

probably D7 could use Entity context and limit flags with entity type

  foreach (flag_get_flags('node') as $flag) {
    $options[$flag->name] = check_plain($flag->title);

Should they filtered by node-type

@andypost, the patch in #77 is the correct one.

I thonk #77 & #79 should be in one patch -access and content type plugins

Any progress on this?

#77 worked perfectly for me (though the patch isn't formatted correctly - needs the a/bluh b/bluh style)

Both #77 and #79 needs re-roll & re-factoring to able to be used with any entity that Flag module supports.

Probably#79 should be filed as another issue because it introduces

#77 Content-type plugin

+++ plugins/content_types/flag_link/flag_link.incundefined
@@ -0,0 +1,97 @@
+  'required context' => array(
+    new ctools_context_optional(t('User'), 'user'),
+    new ctools_context_optional(t('Node'), 'node'),
+    new ctools_context_optional(t('Comment'), 'comment'),

This should be converted to Entity:

+++ plugins/content_types/flag_link/flag_link.incundefined
@@ -0,0 +1,97 @@
+  // Check if we have the context for this flag type.
+  list($user_context, $node_context, $comment_context) = $context;
+  $current_context = ${$flag->content_type . '_context'};
+
+  if (empty($current_context->data)) {
+    return;
+  }

same

#79 Access plugin

  'required context' => new ctools_context_required(t('Node'), 'node'),

Any supported entity type!

  if (empty($context) || empty($context->data) || empty($context->data->nid)) {
    return FALSE;
  }
  if(!empty($conf['flag_name'])) {
    $flag = flag_get_flag($conf['flag_name']);
    if($flag) {
      return $flag->is_flagged($context->data->nid);

This logic require some work

Ok, here is #77 rerolled and adapted to entity as #91.

I'm currently working on the access plugin.

And here is #77+#79 rerolled to 7.x-3.x and compatible with any entity.

@jherencia Awesome! I think this needs more reviews and manual testing. Overall looks great!

Minor things... I can't test them right now

+++ b/plugins/access/flag_is_flagged/flag_is_flagged.incundefined
@@ -0,0 +1,96 @@
+  // Get the ID of the entity.
+  list($id) = entity_extract_ids($flag->entity_type, $context->data);

now sure it works, suppose list($id,,) better

+++ b/plugins/content_types/flag_link/flag_link.incundefined
@@ -0,0 +1,116 @@
+  'content type' => 'flag_flag_link_content_type_info',

Interesting solution, should be tested

+++ b/plugins/content_types/flag_link/flag_link.incundefined
@@ -0,0 +1,116 @@
+  if (empty($context->data)) {
+    return;
+  }
+
+  // Get the ID of the entity.
+  list($id) = entity_extract_ids($flag->entity_type, $context->data);
+  $link = flag_create_link($flag->name, $id);

Suppose here need a check that entity type is flaggable

I needed this functionality so I took a quick look at the patch in 94 and updated the few items mentioned by @andypost.

The flag_flag_link_content_type_info is working as expected for me - in panels with node and user contexts (and a combination of the two).

From what I can tell flag_create_link already provides all the necessary access checks through flag::access.

One other note, it would make more sense to me to use the $info['label'] for the category within Panels. When looking for the user link, I immediately when to the "User" category first - before checking "Entity".

I didn't check anything with the access plugin.

Looks good.

Spotted this which looks like a 2.x API flag property:

+++ b/plugins/content_types/flag_link/flag_link.inc
@@ -0,0 +1,116 @@
+  list($id,,) = entity_extract_ids($flag->content_type, $context->data);

I don't have panels installed myself, so I'd appreciate it if users of panels could try this out and give feedback.

Yep - completely missed the version number here. I had 2.x installed (at least you know it can be backported!).

I'll test again with 3.x-dev and update that property.

Okay - tested with the 3.x-dev version and updated property.

I went ahead and created separate patches: 1 for the access plugin, 1 for the content type plugin, and one that combines both.

Updating status

Im pretty new to drupal, how do you apply the patch ?
Could you patch the file and Post it along with where to replace it in the directory?

Google it ;)

http://drupal.org/patch/apply

Could you patch the file and Post it along with where to replace it in the directory?
I am not a great DRUPAL NINJA such as yourself. Thank you

@avr works perfectly for me, worth upgrading to 3.x for :) thanks!

@Wayne Leyden: with all due respect, using development branches of modules, let alone applying experimental patches, is an advanced drupal skill. if you don't know how to do it yourself and your technical level is not high enough to follow those instructions, you probably should wait until the change has been officially reviewed and applied.

Could I have a single patch please, rather than 3?

The first patch in the group above is a single patch.

#100 flag-ctools_integration-332956-100.patch is right one

Happy to see this RTBC, thank you @avr to continue my work :).

Committed, with a few tweaks:

- 'node' changed to 'entity'
- a few documentation changes

Thanks to everyone who's worked on this.

Issue #332956 by Amitaibu, mooffie, jherencia, avr, jastraat: Added Ctools plugins for content type and access.

Hi everyone sorry to bother but was this added to 7.x-2.1? or 7.x-3.2 I am using 7.x-2.1 due to flag friends and wanted to know what patch I should use?

Hi everyone sorry to bother but was this added to 7.x-2.1? or 7.x-3.2 I am using 7.x-2.1 due to flag friends and wanted to know what patch I should use?

The ctools integration is in 7.x-3.2 (and 7.x-3.x-dev).
The 7.x-2.1 (and current 7.x-2.x-dev) release does not have ctools integration.