class AnnounceTestController

Same name and namespace in other branches
  1. 11.x core/modules/announcements_feed/tests/modules/announce_feed_test/src/Controller/AnnounceTestController.php \Drupal\announce_feed_test\Controller\AnnounceTestController

Defines a controller to return JSON for security advisory tests.

Hierarchy

Expanded class hierarchy of AnnounceTestController

File

core/modules/announcements_feed/tests/modules/announce_feed_test/src/Controller/AnnounceTestController.php, line 11

Namespace

Drupal\announce_feed_test\Controller
View source 
class AnnounceTestController {
    
    /**
     * Reads a JSON file and returns the contents as a Response.
     *
     * This method will replace the string '[CORE_VERSION]' with the current core
     * version to allow testing core version matches.
     *
     * @param string $json_name
     *   The name of the JSON file without the file extension.
     *
     * @return \Symfony\Component\HttpFoundation\JsonResponse|\Symfony\Component\HttpFoundation\Response
     *   If a fixture file with the name $json_name + '.json' is found a
     *   JsonResponse will be returned using the contents of the file, otherwise a
     *   Response will be returned with a 404 status code.
     */
    public function setFeedConfig(string $json_name) : JsonResponse|Response {
        $file = __DIR__ . "/../../../../announce_feed/{$json_name}.json";
        $headers = [
            'Content-Type' => 'application/json; charset=utf-8',
        ];
        if (!is_file($file)) {
            // Return an empty response.
            return new Response('', 404, $headers);
        }
        return new JsonResponse(file_get_contents($file), 200, $headers, TRUE);
    }

}

Members

Title Modifiers Object type Summary
AnnounceTestController::setFeedConfig public function Reads a JSON file and returns the contents as a Response.

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