Giter Club home page Giter Club logo

easy-response's Introduction

Easy Response

Latest Stable Version Total Downloads License PHP Version Require

Easy Response is a PHP library designed to streamline HTTP responses, making it easier to handle requests and deliver appropriate content. This library provides a simple and intuitive interface for creating and sending HTTP responses, including HTML, JSON, and redirects.

Table of Contents

Installation

To install Easy Response, you can use Composer. Run the following command in your project directory:

composer require adaiasmagdiel/easy-response

Usage

Basic Usage

To use Easy Response, you first need to include the library in your project. Then, you can create a new Response object and use its methods to set the response body, status code, and headers. Finally, you can send the response using the send method.

<?php

require 'vendor/autoload.php';

use AdaiasMagdiel\EasyResponse\Response;

$response = new Response();
$response->setBody("Hello, World!")
         ->setStatusCode(200)
         ->setHeader("Content-Type", "text/plain");

$response->send();

HTML Response

To send an HTML response, you can use the html method. This method automatically sets the Content-Type header to text/html.

$response->html("<h1>Hello, World!</h1>");

JSON Response

For JSON responses, use the json method. This method automatically sets the Content-Type header to application/json.

$response->json(["message" => "Hello, World!"]);

Redirects

To redirect the user to another URL, use the redirect method. You can specify whether the redirect should be permanent (HTTP 301) or temporary (HTTP 302). All redirects are temporary by default.

$response->redirect("https://example.com", true); // Permanent redirect

Class Overview

Constructor

  • $body (string): The response body.
  • $statusCode (int): The response status code.
  • $headers (array): The response headers.

Methods

  • getBody(): Get the response body.
  • getStatusCode(): Get the response status code.
  • getHeaders(): Get the response headers.
  • setStatusCode(int $statusCode): Set the response status code.
  • setHeader(string $header, string $value): Set a single header.
  • setHeaders(array $headers): Set multiple headers.
  • setBody(string $body): Set the response body.
  • send(): Send the response with status code, headers, and body.
  • html(string $content): Render an HTML response.
  • json(array $data): Render a JSON response.
  • redirect(string $location, bool $permanent = false): Redirect to a new location with optional permanent flag.

Tests

Easy Response includes a suite of unit tests to ensure the library works as expected. To run the tests, you can use Pest PHP.

./vendor/bin/pest

Contributing

Contributions are welcome.

License

Easy Response is licensed under the MIT License. See the LICENSE file for more details.

easy-response's People

Contributors

adaiasmagdiel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.