Pull Author Pane integration into User Relationships

Forgot something. This issue needs sorting, and that will be in the UR specific code as well: #738226: Ensure all possible user relationships are covered

Michelle

Here is the last version of the integration. I've pulled it from Author Pane. It works somewhat but has some issues as seen in #738226: Ensure all possible user relationships are covered. If you look at the code, you can see that 99% of it deals with UR code and there is very little to do for the AP integration. Given that, and given that I am moving away from UR, I just can't support it anymore and don't want a broken integration in the 2.0 release.

If you need any help with the AP side of things to add the integration to UR, I'd be happy to help.

Michelle

Hmm... I don't see what this patch is doing?

Anyway, as far as I know, the code works aside from that issue I linked to.

Michelle

Oh, I was just looking at the actual text and didn't notice the indentation. Weird... I'm still using UR on my site at this point and it's working fine for me.

Michelle

In an attempt to move this along, here is the function with all the AP stuff in it. What's needed is for someone to fill in the "meat" of the function with the UR code that covers all the crazy possibilities of who can have relations with whom.

/**
 * Implementation of hook_preprocess_author_pane().
 */
function user_relationships_api_preprocess_author_pane(&$variables) {
  // Check if this preprocess needs to be run given who's calling it.
  if (!author_pane_run_preprocess('user_relationships_api', $variables['caller'])) {
    return;
  }

  global $user;
  $account = $variables['account'];
  $account_id = $account->uid;

  /*
  In this section, the $variables['user_relationships_api'] needs to be set to a link to either add the person or remove the person. The link needs to have a class of either author-relationship-add-icon or author-relationship-remove-icon so the appropriate icon can be added in CSS. That's all that is needed from the Author Pane end. The complex part is with the UR code and determining which link to show based on the logged in user and the user being viewed.
  */

}

/**
 * Implementation of hook_author_pane_allow_preprocess_disable().
 */
function user_relationships_api_author_pane_allow_preprocess_disable() {
  return array('user_relationships_api' => 'User Relationships');
}

Sorry to keep posting on here but I want to have this resolved before I release AP 2.0 so keep thinking about this.

I think part of the problem is that UR is very complex and isn't easily reduced to a simple "add friend" in all cases. So how about if it gets a new API function that does this:

• Caller passes in the UID of the user who is viewing and the UID of the user that is being viewed.
• Function returns an item list of links. Each possible relationship has one link.
• Each link has a class of either "relationship-add" or "relationship-remove"
• Each link also has a class that corresponds to the relationship type, such as "relationship-contact" or "relationship-friend"

Doing this would encapsulate all the logic into a UR API function and keep the integration clean. I would still prefer to have the integration in UR but would be willing to pull it back into AP if needed if all the UR logic was a simple function call. It would also cover all the possible relationship types and put them in a single variable that's easy to add to the template. By having both the add/remove class and the relationship class, the theme could target each type and give it a different icon if wanted. AP would continue to provide the generic icon based on add/remove.

What do you think?

Michelle

He emailed and said he'd look at it but it sounds like he's very busy so I don't know when he'll get to it.

Michelle

Thanks for committing this. :)

You can put whatever you want into $variables. I suggest using 1 variable to keep it simple for end users. Whatever you put in there comes out as a variable in the template. It's a lot easier for someone who may not know PHP to just have one variable per module. If you want to change things, though, just let me know and I'll update the template with the changes.

Michelle

Thanks, Alex. I'm totally focused on Advanced Forum at the moment but will be turning my attention back to Author Pane soon as I get AF alpha 4 out. If I find anything that's not working I'll let you know.

Michelle

Sorry to have to revisit this but it turns out this isn't fixed. When I tested, I missed deleting the .inc from my copy of AP and it turns out it was using that instead of this version. I just discovered that today while trying to fix another issue.

1) The file is named wrong. It should be user_relationships_api.author-pane.inc. This is why I never noticed I was testing the wrong code... It never found your code.

2) The changes to the code itself aren't working. Comparing what's in there now to what used to be in there, it looks like there's a bunch of changes. I don't know enough about UR to be able to tell what's wrong but I narrowed down the problem area to this:

  foreach ($rtids as $rtid) {
    $rtypes[] = $all_rtypes[$rtid];
  }

$rtids is array(0 => 0)
$all_rtypes is array(1 => $object) where $object is the relationship.

So $all_rtypes[$rtid]; isn't finding anything because there is no 0 key in that array.

Thanks,

Michelle

Oh! I just had a lightbulb moment with #2. I looked at the variable and realized it said "author pane" in it which meant there must be some AP related setting. Doh! Reading back, I see you said that and I totally missed it. Ok, so forget #2. That's just a matter of going into the setting page and setting it. #1 is still needing fixing, though.

Michelle

Looks like it should work fine; all I did was change the filename on my copy to fix it in testing. I'll grab a new tarball tonight when it's generated and do a fresh install to be sure. Thanks!

Michelle

Huh... Weird. If there's a manual include in there, I wonder why I didn't get an error about the redefined function? At any rate, yeah, you don't need it. AP handles loading the file for you. Trying to make it real simple for module maintainers. :)

Michelle

Try this version: http://drupal.org/node/500960 . I can't remember if the changes to the template file made it in before 2.0. I'll be making a 2.1 release once Advanced Forum Alpha 4 is released.

Michelle

This integration is working fine. You may need to use the development version of AP until there's a new release. Make sure you've set up the integration in the UR settings.

Michelle

I don't even know why this is active. This has been implemented for some time.

Michelle