Skip to content
This repository was archived by the owner on Aug 19, 2022. It is now read-only.

Commit a106c1a

Browse files
committed
Last update before archiving
1 parent d50e92c commit a106c1a

File tree

10 files changed

+143
-158
lines changed

10 files changed

+143
-158
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [Josantonius]

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ tests/sample-app/templates/.templates-states.jsond
1111
docs/_build
1212
docs/*.pyc
1313
package-lock.json
14-
.git*/
1514
node_modules/
1615
_docpress/
1716
vendor/
1817
.idea
19-
.DS_STORE
18+
.DS_STORE
19+
.repository.md
20+
complement.code-workspace
21+
.vscode

CHANGELOG.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
# CHANGELOG
22

3+
## 1.1.3 - 2022-08-19
4+
5+
* **The repository was archived.**
6+
7+
* The option was enabled to add files in the `config` directory without having to return any value.
8+
9+
* The `Eliasis\Complement\Traits\ComplementHandler::getOption()` method now returns null instead of an empty string if the option does not exist.
10+
11+
* Deleted `after-loading-{complement_name}-{complement_type}` action hook.
12+
13+
* Added `after_load_{complement_name}_{complement_type}` action hook.
14+
15+
* Deleted `{complement_type}-load` action hook.
16+
17+
* Added `after_load_{complement_type}s` action hook.
18+
19+
* Now the configuration files will only be loaded when the option is requested.
20+
21+
* `Eliasis\Complement\Traits\ComplementHandler::getSettings()` method was renamed to `Eliasis\Complement\Traits\ComplementHandler::setSettings()`.
22+
23+
* `Eliasis\Complement\Complement::getInstance()` method was renamed to `Eliasis\Complement\Complement::getComplementInstance()`.
24+
25+
* Deprecated `Eliasis\Complement\Traits\ComplementHandler::getControllerInstance()` method. It will be removed in future versions.
26+
27+
* Added `Eliasis\Complement\Traits\ComplementHandler::getInstance()` method. Will be used instead of `Eliasis\Complement\Traits\ComplementHandler::getControllerInstance()` and any kind of instance can be obtained.
28+
329
## 1.1.2 - 2018-04-18
430

531
* Added `after-loading-{complement_name}-{complement_type}` action hook.
@@ -294,9 +320,9 @@ The `addOption()` method will be deleted in the next version. It will be replace
294320

295321
* The following parameters were added for the module configuration file:
296322

297-
id → Required → Unique identifier. Previously 'name' was used.
298-
state → Required → State: active, inactive, uninstalled, installed.
299-
category → Required → Category: Extension, component, widget, plugin...
323+
id → Required → Unique identifier. Previously 'name' was used.
324+
state → Required → State: active, inactive, uninstalled, installed.
325+
category → Required → Category: Extension, component, widget, plugin...
300326

301327
## 1.0.0 - 2017-05-07
302328

@@ -323,4 +349,4 @@ The `addOption()` method will be deleted in the next version. It will be replace
323349

324350
* Bug fixed when creating status file.
325351

326-
* The module path was added to the getModulesInfo method.
352+
* The module path was added to the getModulesInfo method.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
The MIT License (MIT)
22
=====================
33

4-
Copyright (c) `2017` `Josantonius, https://josantonius.com <hello@josantonius.com>`
4+
Copyright (c) `2017` `Josantonius, https://josantonius.dev <hello@josantonius.dev>`
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy of
77
this software and associated documentation files (the "Software"), to deal in

README-ES.md

Lines changed: 20 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Eliasis PHP Framework
22

3-
[![Packagist](https://img.shields.io/packagist/v/eliasis-framework/complement.svg)](https://packagist.org/packages/eliasis-framework/complement) [![Downloads](https://img.shields.io/packagist/dt/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement) [![License](https://img.shields.io/packagist/l/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement/blob/master/LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3ccc95bd114a451bb4fc2ef1884b0a66)](https://www.codacy.com/app/Josantonius/complement?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=eliasis-framework/complement&amp;utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/eliasis-framework/complement.svg?branch=master)](https://travis-ci.org/eliasis-framework/complement) [![PSR2](https://img.shields.io/badge/PSR-2-1abc9c.svg)](http://www.php-fig.org/psr/psr-2/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](http://www.php-fig.org/psr/psr-4/) [![codecov](https://codecov.io/gh/eliasis-framework/complement/branch/master/graph/badge.svg)](https://codecov.io/gh/eliasis-framework/complement)
3+
[![Packagist](https://img.shields.io/packagist/v/eliasis-framework/complement.svg)](https://packagist.org/packages/eliasis-framework/complement)
4+
[![License](https://img.shields.io/packagist/l/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement/blob/master/LICENSE)
45

56
[English version](README.md)
67

@@ -12,10 +13,8 @@
1213
- [Instalación](#instalación)
1314
- [Documentación](#documentation)
1415
- [Tests](#tests)
15-
- [Tareas pendientes](#-tareas-pendientes)
16-
- [Contribuir](#contribuir)
16+
- [Patrocinar](#patrocinar)
1717
- [Licencia](#licencia)
18-
- [Copyright](#copyright)
1918

2019
---
2120

@@ -27,81 +26,52 @@ Este framework es soportado por versiones de **PHP 5.6** o superiores y es compa
2726

2827
Puedes instalar **Eliasis PHP Framework** en tu proyecto utilizando [Composer](http://getcomposer.org/download/). Si vas a empezar un nuevo proyecto, recomendamos utilizar nuestra [app básica](https://github.com/eliasis-framework/app) como punto de partida. Para aplicaciones existentes puedes ejecutar lo siguiente:
2928

30-
$ composer require eliasis-framework/complement
29+
composer require eliasis-framework/complement
3130

3231
El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
3332

34-
$ composer require eliasis-framework/complement --prefer-source
33+
composer require eliasis-framework/complement --prefer-source
3534

3635
## Documentación
3736

3837
[Documentación y ejemplos de uso](https://eliasis-framework.github.io/complement/v1.1.1/lang/es/).
3938

40-
## Tests
39+
## Tests
4140

4241
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:
4342

44-
$ git clone https://github.com/eliasis-framework/complement.git
43+
git clone https://github.com/eliasis-framework/complement.git
4544

46-
$ cd complement
45+
cd complement
4746

48-
$ bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
47+
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
4948

50-
$ composer install
49+
composer install
5150

5251
Ejecutar pruebas unitarias con [PHPUnit](https://phpunit.de/):
5352

54-
$ composer phpunit
53+
composer phpunit
5554

5655
Ejecutar pruebas de estándares de código [PSR2](http://www.php-fig.org/psr/psr-2/) con [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
5756

58-
$ composer phpcs
57+
composer phpcs
5958

6059
Ejecutar pruebas con [PHP Mess Detector](https://phpmd.org/) para detectar inconsistencias en el estilo de codificación:
6160

62-
$ composer phpmd
61+
composer phpmd
6362

6463
Ejecutar todas las pruebas anteriores:
6564

66-
$ composer tests
65+
composer tests
6766

68-
## ☑ Tareas pendientes
67+
## Patrocinar
6968

70-
- [ ] Añadir nueva funcionalidad.
71-
- [ ] Agregar pruebas para Vue.
72-
- [ ] Mejorar pruebas PHP.
73-
- [ ] Mejorar documentación.
74-
- [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver [phpmd.xml](phpmd.xml) y [.php_cs.dist](.php_cs.dist).
75-
- [ ] Agregar documentación para el gancho de acción: `component-load`.
76-
- [ ] Agregar documentación para el gancho de acción: `module-load`.
77-
- [ ] Agregar documentación para el gancho de acción: `plugin-load`.
78-
- [ ] Agregar documentación para el gancho de acción: `template-load`.
79-
- [ ] Agregar documentación para el gancho de acción: `after-loading-{complement_name}-{complement_type}`.
80-
- [ ] Agregar documentación para los diferentes tipos soportados por Eliasis Complement y compatibles con Composer Installers.
81-
82-
## Contribuir
83-
84-
Si deseas colaborar, puedes echar un vistazo a la lista de
85-
[issues](https://github.com/eliasis-framework/complement/issues) o [tareas pendientes](#-tareas-pendientes).
86-
87-
**Pull requests**
88-
89-
* [Fork and clone](https://help.github.com/articles/fork-a-repo).
90-
* Ejecuta el comando `composer install` para instalar dependencias.
91-
Esto también instalará las [dependencias de desarrollo](https://getcomposer.org/doc/03-cli.md#install).
92-
* Ejecuta el comando `composer fix` para estandarizar el código.
93-
* Ejecuta las [pruebas](#tests).
94-
* Crea una nueva rama (**branch**), **commit**, **push** y envíame un
95-
[pull request](https://help.github.com/articles/using-pull-requests).
69+
Si este proyecto te ayuda a reducir el tiempo de desarrollo,
70+
[puedes patrocinarme](https://github.com/josantonius/lang/es-ES/README.md#patrocinar)
71+
para apoyar mi trabajo :blush:
9672

9773
## Licencia
9874

99-
Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información.
100-
101-
## Copyright
102-
103-
2017 - 2018 Josantonius, [josantonius.com](https://josantonius.com/)
104-
105-
Si te ha resultado útil, házmelo saber :wink:
75+
Este repositorio tiene una licencia [MIT License](LICENSE).
10676

107-
Puedes contactarme en [Twitter](https://twitter.com/Josantonius) o a través de mi [correo electrónico](mailto:hello@josantonius.com).
77+
Copyright © 2017-2022, [Josantonius](https://github.com/josantonius/lang/es-ES/README.md#contacto)

README.md

Lines changed: 19 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Eliasis PHP Framework
22

3-
[![Packagist](https://img.shields.io/packagist/v/eliasis-framework/complement.svg)](https://packagist.org/packages/eliasis-framework/complement) [![Downloads](https://img.shields.io/packagist/dt/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement) [![License](https://img.shields.io/packagist/l/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement/blob/master/LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3ccc95bd114a451bb4fc2ef1884b0a66)](https://www.codacy.com/app/Josantonius/complement?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=eliasis-framework/complement&amp;utm_campaign=Badge_Grade) [![Build Status](https://travis-ci.org/eliasis-framework/complement.svg?branch=master)](https://travis-ci.org/eliasis-framework/complement) [![PSR2](https://img.shields.io/badge/PSR-2-1abc9c.svg)](http://www.php-fig.org/psr/psr-2/) [![PSR4](https://img.shields.io/badge/PSR-4-9b59b6.svg)](http://www.php-fig.org/psr/psr-4/) [![codecov](https://codecov.io/gh/eliasis-framework/complement/branch/master/graph/badge.svg)](https://codecov.io/gh/eliasis-framework/complement)
3+
[![Packagist](https://img.shields.io/packagist/v/eliasis-framework/complement.svg)](https://packagist.org/packages/eliasis-framework/complement)
4+
[![License](https://img.shields.io/packagist/l/eliasis-framework/complement.svg)](https://github.com/eliasis-framework/complement/blob/master/LICENSE)
45

56
[Versión en español](README-ES.md)
67

@@ -12,10 +13,8 @@
1213
- [Installation](#installation)
1314
- [Documentation](#documentation)
1415
- [Tests](#tests)
15-
- [TODO](#-todo)
16-
- [Contribute](#contribute)
16+
- [Sponsor](#Sponsor)
1717
- [License](#license)
18-
- [Copyright](#copyright)
1918

2019
---
2120

@@ -29,81 +28,51 @@ You can install **Eliasis PHP Framework** into your project using [Composer](htt
2928
recommend using the [basic app](https://github.com/eliasis-framework/app) as
3029
a starting point. For existing applications you can run the following:
3130

32-
$ composer require eliasis-framework/complement
31+
composer require eliasis-framework/complement
3332

3433
The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:
3534

36-
$ composer require eliasis-framework/complement --prefer-source
35+
composer require eliasis-framework/complement --prefer-source
3736

3837
## Documentation
3938

4039
[Documentation and examples of use](https://eliasis-framework.github.io/complement/v1.1.1/lang/en/).
4140

42-
## Tests
41+
## Tests
4342

4443
To run [tests](tests) you just need [composer](http://getcomposer.org/download/) and to execute the following:
4544

46-
$ git clone https://github.com/eliasis-framework/complement.git
45+
git clone https://github.com/eliasis-framework/complement.git
4746

48-
$ cd complement
47+
cd complement
4948

50-
$ bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
49+
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
5150

52-
$ composer install
51+
composer install
5352

5453
Run unit tests with [PHPUnit](https://phpunit.de/):
5554

56-
$ composer phpunit
55+
composer phpunit
5756

5857
Run [PSR2](http://www.php-fig.org/psr/psr-2/) code standard tests with [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer):
5958

60-
$ composer phpcs
59+
composer phpcs
6160

6261
Run [PHP Mess Detector](https://phpmd.org/) tests to detect inconsistencies in code style:
6362

64-
$ composer phpmd
63+
composer phpmd
6564

6665
Run all previous tests:
6766

68-
$ composer tests
67+
composer tests
6968

70-
## ☑ TODO
69+
## Sponsor
7170

72-
- [ ] Add new feature.
73-
- [ ] Add tests for Vue.
74-
- [ ] Improve PHP tests.
75-
- [ ] Improve documentation.
76-
- [ ] Refactor code for disabled code style rules. See [phpmd.xml](phpmd.xml) and [.php_cs.dist](.php_cs.dist).
77-
- [ ] Add documentation for `component-load` action hook.
78-
- [ ] Add documentation for `module-load` action hook.
79-
- [ ] Add documentation for `plugin-load` action hook.
80-
- [ ] Add documentation for `template-load` action hook.
81-
- [ ] Add documentation for `after-loading-{complement_name}-{complement_type}` action hook.
82-
- [ ] Add documentation for the different types supported by Eliasis Complement and compatible with Composer Installers.
83-
84-
## Contribute
85-
86-
If you would like to help, please take a look at the list of
87-
[issues](https://github.com/eliasis-framework/complement/issues) or the [To Do](#-todo) checklist.
88-
89-
**Pull requests**
90-
91-
* [Fork and clone](https://help.github.com/articles/fork-a-repo).
92-
* Run the command `composer install` to install the dependencies.
93-
This will also install the [dev dependencies](https://getcomposer.org/doc/03-cli.md#install).
94-
* Run the command `composer fix` to excute code standard fixers.
95-
* Run the [tests](#tests).
96-
* Create a **branch**, **commit**, **push** and send me a
97-
[pull request](https://help.github.com/articles/using-pull-requests).
71+
If this project helps you to reduce your development time,
72+
[you can sponsor me](https://github.com/josantonius#sponsor) to support my open source work :blush:
9873

9974
## License
10075

101-
This project is licensed under **MIT license**. See the [LICENSE](LICENSE) file for more info.
102-
103-
## Copyright
104-
105-
2017 - 2018 Josantonius, [josantonius.com](https://josantonius.com/)
106-
107-
If you find it useful, let me know :wink:
76+
This repository is licensed under the [MIT License](LICENSE).
10877

109-
You can contact me on [Twitter](https://twitter.com/Josantonius) or through my [email](mailto:hello@josantonius.com).
78+
Copyright © 2017-2022, [Josantonius](https://github.com/josantonius#contact)

0 commit comments

Comments
 (0)