function user_relationshipsactivity_activity_info in Activity 5.3

Same name and namespace in other branches

1. 5.4 contrib/user_relationshipsactivity/user_relationshipsactivity.module \user_relationshipsactivity_activity_info()
2. 6 contrib/user_relationshipsactivity/user_relationshipsactivity.module \user_relationshipsactivity_activity_info()

Activity definition file

The User Relationships API:

The module also invokes a "user_relationships" hook passing in the following arguments: $type will be a string of the following $type | $category | Description ---------------------------------------------------------------------- insert | type | before a new relationship type is created update | type | before a relationship type is updated delete | type | after a relationship type is deleted load | type | after a relationship type is loaded (so you can add data to it if you'd like)

load | NULL | after a relationship is loaded pre-save | request|update|approve | before a new relationship is created, updated or approved post-save | request|update|approve | after a new relationship is created, updated or approved delete | remove | when a relationship is removed delete | cancel | when a relationship request is cancelled delete | disapprove | when a relationship request is disapprove

$relationship either the relationship_type or relationship object

This defines what hooks activity module should use

File

contrib/user_relationshipsactivity/user_relationshipsactivity.module, line 29

Code

function user_relationshipsactivity_activity_info() {
  $types = user_relationships_types_load();
  foreach ($types as $type) {
    $token_types[$type->name] = $type->name;
  }
  if (count($token_types) == 0) {
    drupal_set_message(t('There are no relationships defined. Please define some !user_relationships before configuring the activity messages.', array(
      '!user_relationships' => l(t('user relationships'), 'admin/user/relationships'),
    )));
  }
  return array(
    'ops' => array(
      'requested' => t('Requested'),
      'approved' => t('Approved'),
      'denied' => t('Denied'),
      'canceled' => t('Canceled'),
      'deleted' => t('Deleted'),
    ),
    'types' => $token_types,
    'roles' => array(
      // This is what corresponds to ACTIVITY_ALL
      'all' => array(
        '#name' => t('All (approved relationships only)'),
        '#description' => t('The general public.'),
        '#default' => '[x-is-blah-of-y]',
      ),
      // TODO: there should be a #defaults array instead and the keys could be
      // the ops. So for every role there is #defaults with 'requested' => 'default message' etc.
      'requester' => array(
        '#name' => t('Requester'),
        '#description' => t('The person who initiated the relationship.'),
        '#default' => t('You have requested to be [relationship-plural] with [requestee]'),
      ),
      'requestee' => array(
        '#name' => t('Requestee'),
        '#description' => t('The person with whom a relationship has been requested or created.'),
        '#default' => t('[requester] has requested to be [relationship-plural] with you'),
      ),
    ),
  );
}