array( 'arguments' => array( 'code' => NULL, 'iconset' => 'shiny', 'alt' => '', 'title' => '', 'attributes' => NULL ), ), 'countryicons_icon_sprite' => array( 'arguments' => array( 'code' => NULL, 'iconset' => 'shiny' ), ), ); } /** * Implementation of hook_help(). */ function countryicons_help($path, $arg) { switch ($path) { case 'admin/help#countryicons' : $output = '

'. t('This module provides a collection of country icons, and an API for retrieving them.') . '

'; $output .= '

'. t('API') .'

'. t('The following functions are provided:') .'

'; $output .= '
countryicons_get_iconsets()
'. t('Returns an array with requested iconset info keyed on path.') .'
countryicons_get_iconset($iconset)
'. t('Get an array with requested iconset info keyed on path.') .'
countryicons_get_icon_path($code, $iconset = "shiny")
'. t('Get the path to an icon.') .'
theme_countryicons_icon($code, $iconset = "shiny", $alt = "", $title = "", $attributes = NULL)
'. t('Theme a country icon. Returns a string containing the image tag.') .'
theme_countryicons_icon_sprite($code, $iconset = "shiny")
'. t('Theme a country icon using a css spriting technique adapted from this list apart article. The css sprite and some css was generated using the Project Fondue CSS Sprite Generator. Returns a string containing the icon markup', array('!css_url' => 'http://www.alistapart.com/articles/sprites', '!sprite_generator_url' => 'http://spritegen.website-performance.org/')) .'
'; $output .= t('

Icon sets

'. t('Additional icon sets may be provided... [More documentation to follow]') .'

'); return $output; } } /** * Searches for .iconsetsinfo-files within the modules iconsets directory. * * @param $query * * @return * array with requested iconset info keyed on path. */ function countryicons_get_iconsets() { $iconsets = array(); $iconsetpath = drupal_get_path('module', 'countryicons') .'/iconsets/'; $setinfofiles = file_scan_directory($iconsetpath, '.*iconsetinfo'); $all_iconsets = array(); foreach ($setinfofiles as $setinfofile) { $setinfo = drupal_parse_info_file($setinfofile->filename); $setinfo['path'] = $iconsetpath . $setinfo['name'] .'/*.'. $setinfo['format']; $all_iconsets[$setinfo['name']] = $setinfo; } return $all_iconsets; } /** * Get an iconsets details. * * @param $query * * @return * array with requested iconset info keyed on path. */ function countryicons_get_iconset($iconset) { $all_iconsets = countryicons_get_iconsets(); return $all_iconsets[$iconset]; } /** * Searches for .iconsetinfo-files within the modules iconsets directory. * * @param $code * A two letter ISO3166 country code. * @param $iconset * The icon set to use ('sniny' is the default). * @return * A string containing an absolute path to the image file. */ function countryicons_get_icon_path($code, $iconset = 'shiny') { $iconsetinfo = countryicons_get_iconset($iconset); return base_path() . str_replace('*', $code, $iconsetinfo['path']); } /** * Theme a country icon. * * @param $code * A two letter ISO3166 country code. * @param $iconset * The icon set to use ('sniny' is the default). * @param $alt * The alternative text for text-based browsers (the two letter ISO3166 country code is the default). * @param $title * The title text is displayed when the image is hovered in some popular browsers. * @param $attributes * Associative array of attributes to be placed in the img tag. * @return * A string containing the image tag. */ function theme_countryicons_icon($code, $iconset = 'shiny', $alt = '', $title = '', $attributes = NULL) { $iconset = !isset($iconset)? 'shiny' : $iconset; $iconsetinfo = countryicons_get_iconset($iconset); $path = str_replace('*', $code, $iconsetinfo['path']); $path = file_exists($path)? $path : str_replace('*', 'unknown', $iconsetinfo['path']); $path = base_path() . $path; $alt = $alt? $alt : $code; $attributes = $attributes? $attributes : array(); $attributes['class'] = 'countryicon'. $attributes['class']; if ($size = $iconsetinfo['dimensions']) { list($width, $height) = explode('x', $size); $attributes += array('width' => $width, 'height' => $height); } $attributes = drupal_attributes($attributes); return ''. check_plain($alt) .''; } /** * Theme a country icon. * * @param $code * A two letter ISO3166 country code. * @param $iconset * The icon set to use ('sniny' is the default). * @return * A string containing the image tag rendered using a css sprite techniquie. */ function theme_countryicons_icon_sprite($code, $iconset = 'shiny') { drupal_add_css(drupal_get_path('module', 'countryicons') .'/iconsets/'. $iconset .'/' . $iconset .'.css'); return''; }