Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/AOP-PHP/AOP

AOP in PHP
https://github.com/AOP-PHP/AOP

Last synced: about 2 months ago
JSON representation

AOP in PHP

Awesome Lists containing this project

README 

        
# Introduction #



AOP is a PECL extension that enables you to use Aspect Oriented Programming in PHP, without the need

to compile or proceed to any other intermediate step before publishing your code.



The AOP extension is designed to be the easiest way you can think of for integrating AOP to PHP.



AOP aims to allow separation of cross-cutting concerns (cache, log, security, transactions, ...)



[![Build Status](https://secure.travis-ci.org/AOP-PHP/AOP.png?branch=master)](http://travis-ci.org/AOP-PHP/AOP)



## Installation ##



You can use pecl



```sh

    sudo pecl install aop-beta

```



or



Download the AOP from github, compile and add the extension to your php.ini



```sh

    #Clone the repository on your computer

    git clone https://github.com/AOP-PHP/AOP

    cd AOP

    #prepare the package, you will need to have development tools for php

    phpize

    #compile the package

    ./configure

    make

    #before the installation, check that it works properly

    make test

    #install

    make install

```



Now you can add the following line to your php.ini to enables AOP



```ini

    extension=AOP.so

```



## What is AOP ? Basic tutorial ##



Let's assume the following class



``` php

doAdmin*()', 'adviceForDoAdmin');

```



Now, each time you'll invoke a method of an object of the class MyServices, starting by doAdmin, AOP will launch the function

basicAdminChecker *before* the called method.



That's it, simple ain't it ?



Now le's try the examples :



``` php

doAdminStuff1();//will raise an exception as nothing in the current session tells us we are an admin

    } catch (Exception $e) {

       echo "You cannot access the service, you're not an admin";

    }



    $_SESSION['user_type'] = 'admin';//again, this is ugly for the sake of the example



    try {

       $service->doAdminStuff1();

       $service->doAdminStuff2();

    } catch (Exception $e) {

       //nothing will be caught here, we are an admin

    }

```



Here you are, you know the basics of AOP.



## AOP Vocabulary and PHP's AOP capabilities ##



### Advice ###



An advice is a piece of code that can be executed. In our first example, the function adviceForAdmin is an advice, it

*could* be executed.



In PHP's AOP extension, an advice can be a trait, a callback, an anonymous function, a static method of a class,

a method of a given object or a closure.



### Join points ###



Join points are places where we can attach advices.



In PHP's AOP extension, a join point can be:



*    before any method / function call

*    after any method / function call

*    around any method / function call

*    During the arousing of an exception of any method / function

*    after any method / function call, should the method terminate normally or not (triggers an exception or not)



In our first example, we used a "before" join point.



### Pointcut ###



Pointcuts are a way to describe whether or not a given join point will trigger the execution of an advice.



In PHP's AOP extension, pointcuts can be configured with a quite simple and straightforward syntax.



In our first example the pointcut was "MyServices->doAdmin*()" and was configured to launch the advice "before" the

execution of the matching methods join points.



## Why or should I use AOP? ##



AOP is a whole different way of thinking for developing application. It is as different as object oriented programming

 can be opposed to procedural programming.



Event if you don't want to base your future development on this approach, you may find it very useful for debugging

purposes. Imagine a world where you can debug or get informations on your code based on information only collected for

a given user, a given context, a given procedure. A world where you can hunt weird and old code execution without even

 trying to update multiple and sparse PHP files, but just by adding advices on given conditions.



We are sure that this extension will soon be part of your future development workflow!



[Latest version of the documentation](http://www.croes.org/gerald/projects/aop/documentation_aop_extension_php.pdf)