function modernizr_requirements in Modernizr 8

Same name and namespace in other branches

1. 6.2 modernizr.install \modernizr_requirements()
2. 6 modernizr.install \modernizr_requirements()
3. 7.3 modernizr.install \modernizr_requirements()
4. 7 modernizr.install \modernizr_requirements()
5. 7.2 modernizr.install \modernizr_requirements()

Implements hook_requirements.

Changes its status based on ability to locate JS library. Changes its instructions based on Libraries API being enabled.

File

./modernizr.install, line 14

Install file for Modernizr module.

Code

function modernizr_requirements($phase) {
  $requirements = array();
  switch ($phase) {
    case 'runtime':

      /**
       * Test for conditions
       */

      // Fetch the version and force it to skip cache.
      $version = modernizr_get_version(TRUE);

      // Fetch the path to the JS lib.
      $path = modernizr_get_path();

      // Test if Libraries module is being used by comparing output of path functions
      if (module_exists('libraries')) {

        // If this is truthy, the Modernizr is using Libraries API as best we can tell.
        $using_libraries = strpos($path, libraries_get_path('modernizr')) !== FALSE;
      }
      else {
        $using_libraries = FALSE;
      }

      /**
       * Generate status message and severity
       */

      // Modernizr / Libraries API installed and working correctly. Do the Drupal happy dance!
      if ($path && $using_libraries) {
        $description = FALSE;
        $severity = REQUIREMENT_OK;
      }
      elseif ($path && !$using_libraries && module_exists('libraries')) {
        $description = t('Modernizr JS library and Libraries API are installed, but something is wrong with the Modernizr library inside !path.<br> Fell back to the copy within !path-module.', array(
          // !path has a hardcoded default because the libraries_get_path() function might not return
          // the correct path when conditions lead to this block of code being executed
          '!path' => libraries_get_path('modernizr') ? libraries_get_path('modernizr') : 'sites/all/libraries/modernizr',
          '!path-module' => drupal_get_path('module', 'modernizr') . '/js',
        ));
        $severity = REQUIREMENT_WARNING;
      }
      elseif ($path && !$using_libraries) {
        $description = t('Modernizr JS library is installed using the module directory. Have you considered using !libraries-api?', array(
          '!libraries-api' => l('Libraries API', 'http://drupal.org/project/libraries'),
        ));
        $severity = REQUIREMENT_WARNING;
      }
      elseif (!$path && module_exists('libraries')) {
        $description = t('Modernizr JS library cannot be found. Download it from !modernizr-site, copy it into !path and rename it to modernizr.min.js.', array(
          '!modernizr-site' => l(t('modernizr.com'), 'http://modernizr.com/download/'),
          // !path has a hardcoded default because the libraries_get_path() function might not return
          // the correct path when conditions lead to this block of code being executed
          '!path' => libraries_get_path('modernizr') ? libraries_get_path('modernizr') : 'sites/all/libraries/modernizr',
        ));
        $severity = REQUIREMENT_ERROR;
      }
      else {
        $description = t('Modernizr JS library cannot be found. Download it from !modernizr-site, copy it to !path and rename it to modernizr.min.js.', array(
          '!modernizr-site' => l(t('modernizr.com'), 'http://modernizr.com/download/'),
          '!path' => drupal_get_path('module', 'modernizr') . '/js',
        ));
        $severity = REQUIREMENT_ERROR;
      }

      /**
       * Declare requirement to Drupal
       */
      $requirements[] = array(
        'title' => t('Modernizr'),
        'value' => $version ? $version : t('Not installed'),
        'description' => $description,
        'severity' => $severity,
      );
      break;
  }
  return $requirements;
}