DisplayInfoInterface.php

Same filename in other branches
  1. 4.0.x modules/phpunit_example/src/DisplayInfoInterface.php

Namespace

Drupal\phpunit_example

File

modules/phpunit_example/src/DisplayInfoInterface.php

View source
<?php

namespace Drupal\phpunit_example;


/**
 * An interface to objects that provide displayable information.
 *
 * Part of the PHPUnit Example module. This interface exists so that we can
 * demonstrate using an interface in testing.
 *
 * This interface as representing objects that can return some sort of display
 * information, such as .info.yml file.
 *
 * @ingroup phpunit_example
 */
interface DisplayInfoInterface {
    
    /**
     * Get displayable name.
     *
     * @returns string
     *    The display name for the item this object represents.
     */
    public function getDisplayName();
    
    /**
     * Get displayable description.
     *
     * @returns string
     *    The displayable description for the item this object represents.
     */
    public function getDisplayDescription();

}

Interfaces

Title Deprecated Summary
DisplayInfoInterface An interface to objects that provide displayable information.