2017 © Pedro Peláez
 

library php-useful

Contains various classes and functions to many common tasks in PHP.

image

pushkar/php-useful

Contains various classes and functions to many common tasks in PHP.

  • Friday, June 8, 2018
  • by pushkar
  • Repository
  • 1 Watchers
  • 0 Stars
  • 10 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

# php-useful, (*1)

A library of all commonly used PHP things., (*2)

Functions.php: has some most used functions, (*3)

EasyHeaders.php: has methods to easily set headers, (*4)

Curl.php: a wrapper for PHP ext-curl., (*5)

Installation

Use composer, (*6)

composer require pushkar/php-useful, (*7)

Or download the source and include mannualy, (*8)

Usage

When using composer require the autoload file at the start of the php script, (*9)

 require_once __DIR__ . '/path/to/vendor/autoload.php';

Add the namespace, (*10)

 use PhpUseful\Functions;   // for using the Functions class
 use PhpUseful\EasyHeaders; // for using the EasyHeader class
 use PhpUseful\Curl;        // for using the Curl class;

All the methods are static except in the Curl class so you can directly use them without creating the class object., (*11)

Functions class

Example usage, (*12)

 $random_ str = Functions::randomString(int $length);

All the class methods are listed below., (*13)

    static function randomString(int $length): string      // returns a random string of given length
    static function escapeInput(string $input): string     // returns escaped string for the given input string

EasyHeaders

For using methods from Easy class, (*14)

 EasyHeaders::not_found();

All the class methods are listed below., (*15)

/**
* Sends a 301 MOVED PERMANENTLY header.
*/
static function moved_permanently()

/**
* Sends a 302 FOUND header.
*/
static function found()

/**
* Sends a 400 BAD REQUEST header.
*/
static function bad_request()

/**
* Sends a 401 UNAUTHORIZED header.
*/
static function unauthorized()

/**
* Sends a 403 FORBIDDEN header.
*/
static function forbidden()

/**
* Sends a 404 NOT FOUND header.
*/
static function not_found()

/**
* Sends a 408 REQUEST TIMEOUT header.
*/
static function request_timeout()

/**
* Sends a 500 INTERNAL SERVER ERROR header.
*/
static function server_error()

/**
* Sends a 501 NOT IMPLEMENTED header.
*/
static function not_implemented()

/**
* Sends a 502 BAD GATEWAY header.
*/
static function bad_gateway()

/**
* Sends a 503 SERVICE UNAVAULABLE header.
*/
static function service_unavailable()

/**
* Sends a 504 GATEWAY TIMEOUT header.
*/
static function gateway_timeout()

/**
* Sends a 422 Unprocessable Entity header.
*/
static function unprocessable_entity()

/**
* Sends a Content-Type: application/json header.
*/
static function json_header()

/**
* Sends a Content-Type: application/pdf header.
*/
static function pdf_header()

/**
* Sends a Content-Type: application/xml header.
*/
static function xml_header()

/**
* Sends a Content-Type: application/force-download header.
*/
static function download_header()

/**
* Sends a Content-Type: text-html header.
*/
static function html_header()

/**
* Sends a Content-Type: text/css header.
*/
static function css_header()

/**
* Sends a Content-Type: text/javascript header.
*/
static function js_header()

/**
* Sends a Content-Type: text/plain header.
*/
static function text_header()

Curl class

Example usage, (*16)

    require_once __DIR__ . '/path/to/vendor/autoload.php';
    use PhpUseful\Curl;

    $curl = new Curl();
    $curl->setUrl('http://example.com');
    $curl->execute();

All methods, (*17)

    //Required. sets the url for the curl request. Throws Exception on invalid url.
    function setUrl(string $url)  

    // Set headers for the curl request
    function setHeaders(array $headers)     

    // when set to true it return the result of the curl_exec() as a string instead of outputting it directly.
    function setReturn(bool $bool)

    // when set to true POST method is used for the curl request
    function usePost(bool $bool)

    // set data to be sent via POST. For this to work usePost() should be set to true
    function setArrayPostData(array $data)

    // set data to be sent via POST. For this to work usePost() should be set to true
    function setStringPostData(string $data)

    // set the port number which will be used for the request
    function setPort(int $port)

    // set the max number of redirects that this request will follow
    function setMaxRedirects(int $max)

    // set the timeout for this request (in seconds)
    function setTimeout(int $timeout)

    // set the username and password to be used for HTTP authentication
    function setCredentials(string $username, string $password)

    // set any valid CURL option in case a helper method isn't present
    function setOption(int $option, mixed $value)

    // Call this after setting all url, headers, method & data
    function execute()

    // return the headers sent for the curl request.
    function getSentHeader()

    // return the reponse. Will work only when setReturn() is set to true.
    function getResult()

The Versions

08/06 2018

dev-master

9999999-dev https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

The Development Requires

by Pushkar Anand

08/06 2018

v0.3.1

0.3.1.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

The Development Requires

by Pushkar Anand

08/06 2018

v0.3

0.3.0.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

The Development Requires

by Pushkar Anand

08/06 2018

v0.2.2

0.2.2.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

by Pushkar Anand

08/06 2018

v0.2.1

0.2.1.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

by Pushkar Anand

08/06 2018

v0.2

0.2.0.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

by Pushkar Anand

08/06 2018

v0.1

0.1.0.0 https://github.com/pushkar-anand/php-useful

Contains various classes and functions to many common tasks in PHP.

  Sources   Download

MIT

The Requires

  • php >=7.0

 

by Pushkar Anand