axelitus/security

A framework agnostic PHP package that contains security related classes and helpers.

dev-master 2013-11-21 00:01 UTC

This package is auto-updated.

Last update: 2020-08-23 20:22:55 UTC


README

A framework agnostic PHP package that contains security related classes and helpers.

Package Information

Requirements

The requirements for this package to work are the following:

  • PHP >= 5.4.9 (it may work for previous 5.4.X versions but it is not tested).

Standards

This package is intended to follow some standards for easy contributions and usage. Recently there has been an initiative to standardize the interoperation of frameworks, though I think this easily extends to most pieces of code everyone is building. The group behind all this is the PHP-FIG (Framework Interoperability Group), you should pay them a visit at their site.

There are already some standards marked as accepted (final): PSR-0, PSR-1, PSR-2 and PSR-3.

This package is intentend to be PSR-2 compliant.

Being PSR-2 compliant means this package can be easily installed by using Composer from the Packagist package archive. Just follow the instructions in section How to install. It also means that there's a guide for coding styles and the developers and contributors should enforce this for everyone's benefit.

Contents

All classes are referenced from the package namespace if not otherwise stated.

  • CLASS - CLASS description.

How to install

To install this package and use it in your app just follow these instructions (if you haven't read the documentation from Composer please do so before you continue):

  1. Download composer if you haven't already done so (use your preferred method). Example:
    $ curl -s https://getcomposer.org/installer | php
  1. Place a require statement inside your composer.json file replacing <version> with the desired version. Example:
    "require": {
        "axelitus/secuity": "<version>"
    }
  1. Run the composer installer to resolve dependencies and download the packages. Example:
    $ php composer.phar install
  1. In order to use the packages you have to load the autoloader that was generated by composer (if you are using a framework, maybe this is already done automatically). Example:
    require 'vendor/autoload.php';
  1. Finally just use the package classes as needed:
    axelitus\Security\[<sub-namespace>\...]<class>::<function>(<params>);