class AggregatorTestRssController

Same name in other branches
  1. 8.9.x core/modules/aggregator/tests/modules/aggregator_test/src/Controller/AggregatorTestRssController.php \Drupal\aggregator_test\Controller\AggregatorTestRssController

Controller for the aggregator_test module.

Hierarchy

Expanded class hierarchy of AggregatorTestRssController

File

core/modules/aggregator/tests/modules/aggregator_test/src/Controller/AggregatorTestRssController.php, line 14

Namespace

Drupal\aggregator_test\Controller
View source
class AggregatorTestRssController extends ControllerBase {
    
    /**
     * Generates a test feed and simulates last-modified and etags.
     *
     * @param bool $use_last_modified
     *   Set TRUE to send a last modified header.
     * @param bool $use_etag
     *   Set TRUE to send an etag.
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   Information about the current HTTP request.
     *
     * @return \Symfony\Component\HttpFoundation\Response
     *   A feed that forces cache validation.
     */
    public function testFeed($use_last_modified, $use_etag, Request $request) {
        $response = new Response();
        $last_modified = strtotime('Sun, 19 Nov 1978 05:00:00 GMT');
        $etag = Crypt::hashBase64($last_modified);
        $if_modified_since = strtotime($request->server
            ->get('HTTP_IF_MODIFIED_SINCE', ''));
        $if_none_match = stripslashes($request->server
            ->get('HTTP_IF_NONE_MATCH', ''));
        // Send appropriate response. We respond with a 304 not modified on either
        // etag or on last modified.
        if ($use_last_modified) {
            $response->headers
                ->set('Last-Modified', gmdate(DateTimePlus::RFC7231, $last_modified));
        }
        if ($use_etag) {
            $response->headers
                ->set('ETag', $etag);
        }
        // Return 304 not modified if either last modified or etag match.
        if ($last_modified == $if_modified_since || $etag == $if_none_match) {
            $response->setStatusCode(304);
            return $response;
        }
        // The following headers force validation of cache.
        $response->headers
            ->set('Expires', 'Sun, 19 Nov 1978 05:00:00 GMT');
        $response->headers
            ->set('Cache-Control', 'must-revalidate');
        $response->headers
            ->set('Content-Type', 'application/rss+xml; charset=utf-8');
        // Read actual feed from file.
        $file_name = __DIR__ . '/../../aggregator_test_rss091.xml';
        $handle = fopen($file_name, 'r');
        $feed = fread($handle, filesize($file_name));
        fclose($handle);
        $response->setContent($feed);
        return $response;
    }
    
    /**
     * Generates a rest redirect to the test feed.
     *
     * @return \Symfony\Component\HttpFoundation\RedirectResponse
     *   A response that redirects users to the test feed.
     */
    public function testRedirect() {
        return $this->redirect('aggregator_test.feed', [], [], 301);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AggregatorTestRssController::testFeed public function Generates a test feed and simulates last-modified and etags.
AggregatorTestRssController::testRedirect public function Generates a rest redirect to the test feed.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 3
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 1
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 1
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 49
ControllerBase::currentUser protected function Returns the current user. 3
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 1
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 1
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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