co-developers/twigniter

Librería de CodeIgniter 3 para utilizar Twig como motor de plantillas

v1.0.2 2017-09-21 16:17 UTC

README

Librería de CodeIgniter 3 para utilizar Twig como motor de plantillas.

Requisitos

Twigniter necesita Twig 2.x, PHP 7.x y CodeIgniter 3.x para poder ser ejecutado.

Instalación manual

Descargue la librería desde el repositorio y copie el archivo Twigniter.php a la carpeta application/libraries de CodeIgniter.

Instalación con Composer

Instale Composer en su equipo y luego ejecute el comando composer require co-developers/twigniter dentro de la raíz de su proyecto en Codeigniter.

Carga automática de la libreria

Para cargar la librería automaticamente, abra el archivo application/config/autoload.php y agregue la libreria al array $autoload['libraries'].

Utilizar el Form Helper de CodeIgniter en Twig

Para poder utilizar las funciones form_open(), form_close(), form_error(), set_value(), set_select(), set_checkbox(), set_radio() y validation_errors() del Form Helper, abra el archivo application/config/autoload.php y agregue al array $autoload['helpers'] el string 'form'.

Utilizar el URL Helper de CodeIgniter en Twig

Para poder utilizar las funciones site_url(), base_url(), current_url() y uri_string() del URL Helper, abra el archivo application/config/autoload.php y agregue al array $autoload['helpers'] el string 'url'.

Comenzando a desarrollar con Twigniter

  • Para comenzar a utilizar Twigniter en cualquier método de un controlador debe agregar la librería al array $autoload['libraries'] o cargarla de forma manual en el constructor del controlador o en una acción del mismo justo antes de utilizarla. Para cargar la librería de forma manual se debe ejecutar $this->load->library('twigniter') (se recomienda utilizar la carga automática).
  • Para enviar una vista al navegador se debe ejecutar $this->twigniter->display('archivo', $params) donde el parametro 'archivo' es un archivo con extension twig ubicado en la carpeta application/views y el parametro $params es un array con pares 'clave' => valor donde clave es el nombre de la variable disponible a utilizar en el archivo twig y valor es el valor de dicha variable.
  • Para obtener el resultado de una vista en twig y guardarlo en una variable y hacer con ello lo que deseen se debe ejecutar el método $this->twigniter->render('archivo', $params). Los parámetros son los mismos que los del método display().

Extendiendo Twig

  • Para agregar funciones a Twig y que estén disponibles para utilizar en todos los templates se debe ejecutar $this->twigniter->addFunction($name, $function) donde el parámetro $name es el nombre de la función en Twig, y $function puede ser el nombre de una función nativa de PHP, el de un helper de CodeIgniter cargado previamente, o una función anónima.
  • Para agregar una variable global en Twig se debe ejecutar $this->twigniter->addGlobal($name, $value) donde $name es el nombre de la variable en Twig y $value es el valor de dicha variable.
  • Se recomienda extender Twig a través del hook post_controller_constructor para que las funciones y/o variables agregadas estén disponibles en todos los métodos de los controladores de su aplicación. Si desea extender Twig en un controlador específico, se recomienda hacerlo en el constructor de dicho controlador. Recuerde que para extender Twig a través del hook debe configurar la carga automática de la libreria.

Modo desarrollo y producción

Twigniter utiliza la variable ENVIRONMENT de CodeIgniter para configurar Twig de la forma más óptima dependiendo del entorno en que se esté ejecutando.