Basic Definitions for Planet Module
[All Implemented Hooks]

Main user interface. More...

Collaboration diagram for Basic Definitions for Planet Module:

Functions
	planet_perm ()
	Implementation of hook_perm - Defines user permissions.
	planet_help ($path, $arg)
	Implementation of hook_help - Provides online user help.
	planet_menu ()
	Implementation of hook_menu() - Defines menu items and page callbacks.

---

Detailed Description

Main user interface.

---

Function Documentation

planet_help	(	$	path,
		$	arg
	)

Implementation of hook_help - Provides online user help.

Parameters:

	$path	A Drupal menu router path the help is being requested for
	$arg

Returns:

A localized string containing the help text.

                                  {
  switch ($path) {
    case 'admin/help#planet':
      // The module's help text, displayed on the admin/help page and through the module's individual help link. 
      $output = '<p>Planet is an aggregator that allows you to aggregate your users blogs and to display them in a "planet" fashion. Associating content with the users rather than as a detached feed.</p>';
      $output .= '<p>To use planet, go to admin/settings/planet and note the following sections:</p>';
      $output .= '<ul>';
      $output .= '<li><strong>General Settings</strong>. The filter format drop down will allow you to select the filter format that will be used to show planet entry nodes.</li>';
      $output .= '<li><strong>Feeds</strong>. This section lets you add a new feed. Give it a title, select an author, provide the feed url, and you\'re off. You\'ll have to manually refresh it or wait for a cron run for items to be imported.</li>';
      $output .= '<li><strong>Feeds</strong>. This section lists current feeds, when they were last updated, how many items they have, and it allows you to edit, refresh, or freeze them. Freezing is a quick way to temporarily suspend updates from the given feed.</li>';
      // @DIFFGROUP output syntax
      $output .= '</ul>';
      return $output;
      // @DIFFINFO in D6, admin/modules#description is moved to .info file
  }
}

planet_menu

(

)

Implementation of hook_menu() - Defines menu items and page callbacks.

Returns:

An array of menu items. Each menu item has a key corresponding to the Drupal path being registered.

@Invokes: _planet_settings() ( through page callback() )

@Invokes: planet_user_feeds() ( through page callback() )

@Invokes: planet_page_user() ( through page callback() )

@Invokes: planet_call_refresh() ( through page callback() )

@Invokes: planet_toggle_frozen() ( through page callback() )

@Invokes: planet_page_last() ( through page callback() )

@Invokes: planet_feed() ( through page callback() )

This diagram shows how requests are handled. Each arrow is labeled with the permission required to access link. The menu item colors reflect the item type.

Menus and Pages

                       {
  $items['admin/settings/planet'] = array(
    'title' => 'Planet Settings',
    'description' => 'Configure settings for the planet module.',
    'page callback' => '_planet_settings',
    'access arguments' => array('administer nodes'),
    'type' => MENU_NORMAL_ITEM);
  
  $items['user/%user/planet'] = array(
    'title' => 'Planet Feeds',
    'page callback' => 'planet_user_feeds',
    'page arguments' => array(1),
    'access arguments' => array('administer own planet feeds'),
    'type' => MENU_LOCAL_TASK,
  );
  
  //  if (arg(0) == 'planet' && is_numeric(arg(1))) {
  // FIXME access denied http://localhost/drupal/?q=planet/1
  $items['planet/'. '%'] = array(
    'title' => 'planet',
    'page callback' => 'planet_page_user',
    'page arguments' => array(arg(1))
  );

  //   if (arg(3) == 'refresh' && is_numeric(arg(4))) {
  $items['admin/settings/planet/refresh/%'] = array(
    'title' => 'planet refresh',
    'page callback' => 'planet_call_refresh',
    'access arguments' => array('administer nodes'),
    'type' => MENU_CALLBACK
  );

  //  if (is_numeric(arg(4)) && (arg(3) == 'freeze' || arg(3) == 'unfreeze')) {
  $items['admin/settings/planet/'. arg(3) .'/%'] = array(
    'title' => 'planet freeze',
    'page callback' => 'planet_toggle_frozen',
    'access arguments' => array('administer nodes'),
    'type' => MENU_CALLBACK
  );

  $items['planet'] = array(
    'title' => 'Planet',
    'description' => 'Planet Page',
    'page callback' => 'planet_page_last',
    'access arguments' => array('access content'),
    'type' => MENU_NORMAL_ITEM
  );
    
  $items['planet/feed'] = array(
    'title' => 'Planet',
    'page callback' => 'planet_feed',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK
  );  
      
  return $items;
}

Here is the call graph for this function:

planet_perm

(

)

Implementation of hook_perm - Defines user permissions.

The suggested naming convention for permissions is "action_verb modulename".

Returns:

An array of permissions strings.

                       {
  return array('administer planet', 'administer own planet feeds', 'view all planet nodes');
}