Skip to content

Commit

Permalink
Updated to 1.0.3 version
Browse files Browse the repository at this point in the history
  • Loading branch information
josantonius committed May 31, 2017
1 parent 02ec6aa commit ef0247e
Show file tree
Hide file tree
Showing 7 changed files with 415 additions and 112 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# CHANGELOG

## 1.0.3 - 2017-05-31

These deprecated methods will be removed as of version 1.0.4:

* Deprecated `$_hooks` property.

* Deprecated `Josantonius\Hook\Hook::setHook()` method.
* Deprecated `Josantonius\Hook\Hook::addHook()` method.
* Deprecated `Josantonius\Hook\Hook::resetHook()` method.
* Deprecated `Josantonius\Hook\Hook::run()` method.
* Deprecated `Josantonius\Hook\Hook::collectHook()` method.

* Added `Josantonius\Hook\Hook::addAction()` method.
* Added `Josantonius\Hook\Hook::addActions()` method.
* Added `Josantonius\Hook\Hook::doAction()` method.
* Added `Josantonius\Hook\Hook::_runAction()` method.
* Added `Josantonius\Hook\Hook::_getActions()` method.
* Added `Josantonius\Hook\Hook::_getArguments()` method.
* Added `Josantonius\Hook\Hook::current()` method.

* Deleted `Josantonius\Hook\Tests\HookTest::testAddHooks()` method.
* Deleted `Josantonius\Hook\Tests\HookTest::testExecuteHooks()` method.
* Deleted `Josantonius\Hook\Tests\HookTest::testSetOneHook()` method.
* Deleted `Josantonius\Hook\Tests\HookTest::testSetMultipleHooks()` method

* Added `Josantonius\Hook\Tests\HookTest::testAddHooksMethod()` method.
* Added `Josantonius\Hook\Tests\HookTest::testAddHooksArray()` method.
* Added `Josantonius\Hook\Tests\HookTest::testAddHooksInstance()` method.
* Added `Josantonius\Hook\Tests\HookTest::testCurrentHook()` method.

* Added `$callbacks` property.
* Added `$actions` property.
* Added `$current` property.

## 1.0.2 - 2017-05-19
* Added option to remove custom function to hook.

Expand Down
51 changes: 28 additions & 23 deletions README-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ También puedes clonar el repositorio completo con Git:

Esta ĺibrería es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Para utilizar esta librería en HHVM (HipHop Virtual Machine) tendrás que activar los tipos escalares. Añade la siguiente ĺínea "hhvm.php7.scalar_types = true" en tu "/etc/hhvm/php.ini".
Para utilizar esta biblioteca en HHVM (HipHop Virtual Machine) tendrás que activar los tipos escalares. Añade la siguiente ĺínea "hhvm.php7.scalar_types = true" en tu "/etc/hhvm/php.ini".

### Cómo empezar y ejemplos

Para utilizar esta librería, simplemente:
Para utilizar esta biblioteca, simplemente:

```php
require __DIR__ . '/vendor/autoload.php';
Expand All @@ -55,42 +55,46 @@ use Josantonius\Hook\Hook;
```
### Métodos disponibles

Métodos disponibles en esta librería:
Métodos disponibles en esta biblioteca:

```php
Hook::getInstance();
Hook::setSingletonName();
Hook::setHook();
Hook::addHook();
Hook::run();
Hook->collectHook();
Hook::addAction();
Hook::addActions();
Hook::current();
```

### Uso

Ejemplo de uso para esta librería:
Ejemplo de uso para esta biblioteca:

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\Hook\Hook;

$Hook = Hook::getInstance();
/* Agregar acciones */

Hook::addAction('css', ['Namespace\Class\Example', 'css'], 2, 0);

$hooks = [
'css' => 'Namespace\Class\Example@css',
'js' => 'Namespace\Class\Example@js',
'after-body' => 'Namespace\Class\Example@afterBody',
'footer' => 'Namespace\Class\Example@footer',
['meta', ['Namespace\Class\Example', 'meta'], 1, 0],
['js', ['Namespace\Class\Example', 'js'], 3, 0],
['after-body', ['Namespace\Class\Example', 'afterBody'], 4, 0],
['footer', ['Namespace\Class\Example', 'footer'], 5, 0],
];

$Hook->addHook($hooks);
Hook::addActions($hooks);

/* Ejecutar acciones */

$Hook->run('meta');
$Hook->run('css');
$Hook->run('js');
$Hook->run('after-body');
$Hook->run('footer');
Hook::doAction('meta');
Hook::doAction('css');
Hook::doAction('js');
Hook::doAction('after-body');
Hook::doAction('footer');
```

### Tests
Expand All @@ -109,16 +113,17 @@ use Josantonius\Hook\Tests\HookTest;
Métodos de prueba disponibles:

```php
HookTest::testAddHooks();
HookTest::testAddHooksMethod();
HookTest::testAddHooksArray();
HookTest::testAddHooksInstance();
HookTest::testSetSingletonName();
HookTest::testCurrentHook();
HookTest::testExecuteHooks();
HookTest::testSetOneHook();
HookTest::testSetMultipleHooks();
```

### Manejador de excepciones

Esta librería utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto.
Esta biblioteca utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto.
### Contribuir
1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
Expand Down
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ Available methods in this library:
```php
Hook::getInstance();
Hook::setSingletonName();
Hook::setHook();
Hook::addHook();
Hook::run();
Hook->collectHook();
Hook::addAction();
Hook::addActions();
Hook::current();
```

### Usage

Example of use for this library:
Expand All @@ -75,22 +75,26 @@ require __DIR__ . '/vendor/autoload.php';

use Josantonius\Hook\Hook;

$Hook = Hook::getInstance();
/* Add actions */

Hook::addAction('css', ['Namespace\Class\Example', 'css'], 2, 0);

$hooks = [
'css' => 'Namespace\Class\Example@css',
'js' => 'Namespace\Class\Example@js',
'after-body' => 'Namespace\Class\Example@afterBody',
'footer' => 'Namespace\Class\Example@footer',
['meta', ['Namespace\Class\Example', 'meta'], 1, 0],
['js', ['Namespace\Class\Example', 'js'], 3, 0],
['after-body', ['Namespace\Class\Example', 'afterBody'], 4, 0],
['footer', ['Namespace\Class\Example', 'footer'], 5, 0],
];

$Hook->addHook($hooks);
Hook::addActions($hooks);

/* Run actions */

$Hook->run('meta');
$Hook->run('css');
$Hook->run('js');
$Hook->run('after-body');
$Hook->run('footer');
Hook::doAction('meta');
Hook::doAction('css');
Hook::doAction('js');
Hook::doAction('after-body');
Hook::doAction('footer');
```

### Tests
Expand All @@ -110,11 +114,12 @@ use Josantonius\Hook\Tests\HookTest;
Available test methods in this library:

```php
HookTest::testAddHooks();
HookTest::testAddHooksMethod();
HookTest::testAddHooksArray();
HookTest::testAddHooksInstance();
HookTest::testSetSingletonName();
HookTest::testCurrentHook();
HookTest::testExecuteHooks();
HookTest::testSetOneHook();
HookTest::testSetMultipleHooks();
```

### Exception Handler
Expand Down
5 changes: 4 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"name": "josantonius/hook",
"version": "1.0.2",
"version": "1.0.3",
"type": "library",
"description": "Library for handling hooks.",
"keywords": [
"Hook",
"Actions",
"Action Hooks",
"HHVM",
"PHP"
],
"license": "MIT",
Expand Down
Loading

0 comments on commit ef0247e

Please sign in to comment.