class DrupalHTMLIdentifierTestCase

Test for cleaning HTML identifiers.

Hierarchy

Expanded class hierarchy of DrupalHTMLIdentifierTestCase

File

modules/simpletest/tests/common.test, line 1009

View source
class DrupalHTMLIdentifierTestCase extends DrupalUnitTestCase {
    public static function getInfo() {
        return array(
            'name' => 'HTML identifiers',
            'description' => 'Test the functions drupal_html_class(), drupal_html_id() and drupal_clean_css_identifier() for expected behavior',
            'group' => 'System',
        );
    }
    
    /**
     * Tests that drupal_clean_css_identifier() cleans the identifier properly.
     */
    function testDrupalCleanCSSIdentifier() {
        // Verify that no valid ASCII characters are stripped from the identifier.
        $identifier = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ-0123456789';
        $this->assertIdentical(drupal_clean_css_identifier($identifier, array()), $identifier, 'Verify valid ASCII characters pass through.');
        // Verify that valid UTF-8 characters are not stripped from the identifier.
        $identifier = '¡¢£¤¥';
        $this->assertIdentical(drupal_clean_css_identifier($identifier, array()), $identifier, 'Verify valid UTF-8 characters pass through.');
        // Verify that invalid characters (including non-breaking space) are stripped from the identifier.
        $this->assertIdentical(drupal_clean_css_identifier('invalid !"#$%&\'()*+,./:;<=>?@[\\]^`{|}~ identifier', array()), 'invalididentifier', 'Strip invalid characters.');
        // Verify that double underscores are replaced in the identifier by default.
        $identifier = 'css__identifier__with__double__underscores';
        $expected = 'css--identifier--with--double--underscores';
        $this->assertIdentical(drupal_clean_css_identifier($identifier), $expected, 'Verify double underscores are replaced with double hyphens by default.');
        // Verify that double underscores are preserved in the identifier if the
        // variable allow_css_double_underscores is set to TRUE.
        $this->setAllowCSSDoubleUnderscores(TRUE);
        $this->assertIdentical(drupal_clean_css_identifier($identifier), $identifier, 'Verify double underscores are preserved if the allow_css_double_underscores set to TRUE.');
        // To avoid affecting other test cases, set the variable
        // allow_css_double_underscores to FALSE which is the default value.
        $this->setAllowCSSDoubleUnderscores(FALSE);
    }
    
    /**
     * Set the variable allow_css_double_underscores and reset the cache.
     *
     * @param $value bool
     *   A new value to be set to allow_css_double_underscores.
     */
    function setAllowCSSDoubleUnderscores($value) {
        $GLOBALS['conf']['allow_css_double_underscores'] = $value;
        drupal_static_reset('drupal_clean_css_identifier:allow_css_double_underscores');
    }
    
    /**
     * Tests that drupal_html_class() cleans the class name properly.
     */
    function testDrupalHTMLClass() {
        // Verify Drupal coding standards are enforced.
        $this->assertIdentical(drupal_html_class('CLASS NAME_[Ü]'), 'class-name--ü', 'Enforce Drupal coding standards.');
    }
    
    /**
     * Tests that drupal_html_id() cleans the ID properly.
     */
    function testDrupalHTMLId() {
        // Verify that letters, digits, and hyphens are not stripped from the ID.
        $id = 'abcdefghijklmnopqrstuvwxyz-0123456789';
        $this->assertIdentical(drupal_html_id($id), $id, 'Verify valid characters pass through.');
        // Verify that invalid characters are stripped from the ID.
        $this->assertIdentical(drupal_html_id('invalid,./:@\\^`{Üidentifier'), 'invalididentifier', 'Strip invalid characters.');
        // Verify Drupal coding standards are enforced.
        $this->assertIdentical(drupal_html_id('ID NAME_[1]'), 'id-name-1', 'Enforce Drupal coding standards.');
        // Reset the static cache so we can ensure the unique id count is at zero.
        drupal_static_reset('drupal_html_id');
        // Clean up IDs with invalid starting characters.
        $this->assertIdentical(drupal_html_id('test-unique-id'), 'test-unique-id', 'Test the uniqueness of IDs #1.');
        $this->assertIdentical(drupal_html_id('test-unique-id'), 'test-unique-id--2', 'Test the uniqueness of IDs #2.');
        $this->assertIdentical(drupal_html_id('test-unique-id'), 'test-unique-id--3', 'Test the uniqueness of IDs #3.');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DrupalHTMLIdentifierTestCase::getInfo public static function
DrupalHTMLIdentifierTestCase::setAllowCSSDoubleUnderscores function Set the variable allow_css_double_underscores and reset the cache.
DrupalHTMLIdentifierTestCase::testDrupalCleanCSSIdentifier function Tests that drupal_clean_css_identifier() cleans the identifier properly.
DrupalHTMLIdentifierTestCase::testDrupalHTMLClass function Tests that drupal_html_class() cleans the class name properly.
DrupalHTMLIdentifierTestCase::testDrupalHTMLId function Tests that drupal_html_id() cleans the ID properly.
DrupalTestCase::$assertions protected property Assertions thrown in that test case.
DrupalTestCase::$databasePrefix protected property The database prefix of this test run.
DrupalTestCase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
DrupalTestCase::$originalLanguage protected property The original language.
DrupalTestCase::$originalLanguageDefault protected property The original default language.
DrupalTestCase::$originalTheme protected property The original theme.
DrupalTestCase::$originalThemeKey protected property The original theme key.
DrupalTestCase::$originalThemePath protected property The original theme path.
DrupalTestCase::$results public property Current results of this test case.
DrupalTestCase::$setup protected property Flag to indicate whether the test has been set up.
DrupalTestCase::$setupDatabasePrefix protected property
DrupalTestCase::$setupEnvironment protected property
DrupalTestCase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
DrupalTestCase::$testId protected property The test run ID.
DrupalTestCase::$timeLimit protected property Time limit for the test.
DrupalTestCase::$useSetupInstallationCache public property Whether to cache the installation part of the setUp() method.
DrupalTestCase::$useSetupModulesCache public property Whether to cache the modules installation part of the setUp() method.
DrupalTestCase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
DrupalTestCase::assert protected function Internal helper: stores the assert.
DrupalTestCase::assertEqual protected function Check to see if two values are equal.
DrupalTestCase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
DrupalTestCase::assertIdentical protected function Check to see if two values are identical.
DrupalTestCase::assertNotEqual protected function Check to see if two values are not equal.
DrupalTestCase::assertNotIdentical protected function Check to see if two values are not identical.
DrupalTestCase::assertNotNull protected function Check to see if a value is not NULL.
DrupalTestCase::assertNull protected function Check to see if a value is NULL.
DrupalTestCase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
DrupalTestCase::deleteAssert public static function Delete an assertion record by message ID.
DrupalTestCase::error protected function Fire an error assertion. 1
DrupalTestCase::errorHandler public function Handle errors during test runs. 1
DrupalTestCase::exceptionHandler protected function Handle exceptions.
DrupalTestCase::fail protected function Fire an assertion that is always negative.
DrupalTestCase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
DrupalTestCase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
DrupalTestCase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
DrupalTestCase::insertAssert public static function Store an assertion from outside the testing context.
DrupalTestCase::pass protected function Fire an assertion that is always positive.
DrupalTestCase::randomName public static function Generates a random string containing letters and numbers.
DrupalTestCase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
DrupalTestCase::run public function Run all tests in this class.
DrupalTestCase::verbose protected function Logs a verbose message in a text file.
DrupalUnitTestCase::setUp protected function Sets up unit test environment. 10
DrupalUnitTestCase::tearDown protected function 1
DrupalUnitTestCase::__construct function Constructor for DrupalUnitTestCase. Overrides DrupalTestCase::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.