From 21ba6d132dcfb3002559b78bdf7b835fbedafadb Mon Sep 17 00:00:00 2001 From: Kjell Bublitz Date: Thu, 11 Apr 2013 09:04:03 +0200 Subject: [PATCH] v0.7.1 release --- .gitignore | 3 +- .gitmodules | 3 ++ LICENSE | 2 +- README.md | 84 +++++++++++++++++++++++++++++++++++++---------------- 4 files changed, 65 insertions(+), 27 deletions(-) create mode 100644 .gitmodules diff --git a/.gitignore b/.gitignore index 496ee2c..59c09fa 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -.DS_Store \ No newline at end of file +.DS_Store +vendors/twig-latest diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..e1c8de7 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "vendors/twig-latest"] + path = vendors/twig-latest + url = git://github.com/fabpot/Twig diff --git a/LICENSE b/LICENSE index 3d81107..68f7440 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (C) 2010-2012 by Kjell Bublitz +Copyright (C) 2010-2013 by Kjell Bublitz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index aa67584..3c6a5b2 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,88 @@ -# Twig for CakePHP (v0.7) +# Twig for CakePHP (v0.7.1) -This plugin for the CakePHP Framework allows you to use the Twig Templating Language. +This plugin for the CakePHP Framework allows you to use the Twig, the flexible, fast, and secure +template engine for PHP. Apart from enabling you to use most of Twig's features the plugin is tightly integrated with the CakePHP view renderer giving you full access to helpers, objects and elements. ## New in this version - -- Complete rewrite -- Latest Twig (v1.8.3 atm) -- Easy to upgrade -- Easy to install -- Easy to migrate -- Extendable (see wiki) -- More CakePHP Filters - -This version was written on **CakePHP 1.3**. - -Support for 2.x may be limited to non-existant. If you run on 2.x i suggest that you check out the [fork from predominant](https://github.com/predominant/TwigView) +- Added TWIG_DIR so you can define the full Twig root-directory name +- Deprecated TWIG_VERSION because it lost its purpose due to this change +- Added fabpot/Twig as a submodule of this git repository ## Installation #### via Archive -Download the [current version as ZIP](https://github.com/m3nt0r/cakephp-twig-view/zipball/master), unzip it and rename the extracted folder to ```twig```. -Then put the ```twig``` folder inside your ```plugins``` and you are done. +Download the [current version as ZIP](https://github.com/m3nt0r/cakephp-twig-view/zipball/master), unzip it and rename the extracted folder to `twig`. Then put the `twig` folder inside your `plugins` and you are done. #### via GitHub -Just clone the repository directly into your app. +Just clone the repository directly into your `plugins` folder. - $ cd plugins $ git clone git://github.com/m3nt0r/cakephp-twig-view.git twig +If you want the latest twig version too, clone it recursive. + + $ git clone git://github.com/m3nt0r/cakephp-twig-view.git twig --recursive + +## Twig Version Support + +The view class should support virtually all current and future Twig versions. At the time of writing TwigView v0.7 the latest Twig version used to be 1.8.3 and is still part of the download package. If you want to use your own version you need to place the extracted Twig directory into `./vendors/` and define a `TWIG_DIR` constant in your bootstrap with whatever the directory-name is. + +For example: + + // bootstrap.php + define('TWIG_DIR', 'Twig-1.12.3'); + +If you've used the git submodule and pulled the latest version, chances are that your Twig directory is called `twig-latest`. The define should then read: + + // bootstrap.php + define('TWIG_DIR', 'twig-latest'); + ## Enabling the View Inside your ```app_controller.php``` add the following: - class AppController extends Controller { - public $view = 'Twig.Twig'; // use twig - } +```php +class AppController extends Controller { + public $view = 'Twig.Twig'; // use twig +} +``` -Now start creating view files using the ```.tpl``` extension. +Now start by creating twig view-files using the `.tpl` extension. +### Fallback / Upgrading exsiting apps +By default the view will render any existing `.ctp` like always but will prefer the `.tpl` version if present. This means that, for example, the `index.ctp` is used until you create a `index.tpl` at the same location. That way you can upgrade existing views one at a time instead of having to rework all files at once. + ## Documentation -Check the **wiki** for more Informations and Features +Check the **wiki** for more details on features and usage @ [cakephp-twig-view/wiki](https://github.com/m3nt0r/cakephp-twig-view/wiki) + +## Version History + +This version was written on **CakePHP 1.3**. + +### v0.7.1 +- Added TWIG_DIR so you can define the full Twig root-directory name +- Deprecated TWIG_VERSION because it lost its purpose due to this change +- Added fabpot/Twig as a submodule of this git repository + +### v0.7 -[cakephp-twig-view/wiki](https://github.com/m3nt0r/cakephp-twig-view/wiki) +- Complete rewrite +- Latest Twig (v1.8.3 atm) +- Easy to upgrade +- Easy to install +- Easy to migrate +- Extendable (see wiki) +- More CakePHP Filters -"The readme was just too long(tm)" +## CakePHP 2 +Support for 2.x may be limited to non-existant. If you run on 2.x i suggest that you check out the [fork of predominant](https://github.com/predominant/TwigView). +## License +MIT License +Copyright (c) 2010-2013, Kjell Bublitz.