class MenuTreeDataTestCase

Menu tree data related tests.

Hierarchy

Expanded class hierarchy of MenuTreeDataTestCase

File

modules/simpletest/tests/menu.test, line 931

View source
class MenuTreeDataTestCase extends DrupalUnitTestCase {
    
    /**
     * Dummy link structure acceptable for menu_tree_data().
     */
    var $links = array(
        1 => array(
            'mlid' => 1,
            'depth' => 1,
        ),
        2 => array(
            'mlid' => 2,
            'depth' => 1,
        ),
        3 => array(
            'mlid' => 3,
            'depth' => 2,
        ),
        4 => array(
            'mlid' => 4,
            'depth' => 3,
        ),
        5 => array(
            'mlid' => 5,
            'depth' => 1,
        ),
    );
    public static function getInfo() {
        return array(
            'name' => 'Menu tree generation',
            'description' => 'Tests recursive menu tree generation functions.',
            'group' => 'Menu',
        );
    }
    
    /**
     * Validate the generation of a proper menu tree hierarchy.
     */
    function testMenuTreeData() {
        $tree = menu_tree_data($this->links);
        // Validate that parent items #1, #2, and #5 exist on the root level.
        $this->assertSameLink($this->links[1], $tree[1]['link'], 'Parent item #1 exists.');
        $this->assertSameLink($this->links[2], $tree[2]['link'], 'Parent item #2 exists.');
        $this->assertSameLink($this->links[5], $tree[5]['link'], 'Parent item #5 exists.');
        // Validate that child item #4 exists at the correct location in the hierarchy.
        $this->assertSameLink($this->links[4], $tree[2]['below'][3]['below'][4]['link'], 'Child item #4 exists in the hierarchy.');
    }
    
    /**
     * Check that two menu links are the same by comparing the mlid.
     *
     * @param $link1
     *   A menu link item.
     * @param $link2
     *   A menu link item.
     * @param $message
     *   The message to display along with the assertion.
     * @return
     *   TRUE if the assertion succeeded, FALSE otherwise.
     */
    protected function assertSameLink($link1, $link2, $message = '') {
        return $this->assert($link1['mlid'] == $link2['mlid'], $message ? $message : 'First link is identical to second link');
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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
MenuTreeDataTestCase::$links property Dummy link structure acceptable for menu_tree_data().
MenuTreeDataTestCase::assertSameLink protected function Check that two menu links are the same by comparing the mlid.
MenuTreeDataTestCase::getInfo public static function
MenuTreeDataTestCase::testMenuTreeData function Validate the generation of a proper menu tree hierarchy.

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