diff --git a/CONTRIBUTORS b/CONTRIBUTORS
new file mode 100644
index 0000000..159baba
--- /dev/null
+++ b/CONTRIBUTORS
@@ -0,0 +1 @@
+Nicolas Lassale
\ No newline at end of file
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..fcdce90
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,461 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+
+
diff --git a/apps/todos/README b/apps/todos/README
new file mode 100644
index 0000000..d30b446
--- /dev/null
+++ b/apps/todos/README
@@ -0,0 +1,36 @@
+
+ Plume Framework Test Application
+----------------------------------
+
+This test application is a simple TODO list manager.
+
+This test application is here to expose in a simple way the
+functionalities of the Plume Framework aka "Pluf" and to propose a
+"best practice" example on the way to structure your application using
+Pluf.
+
+ Installation
+--------------
+
+1) In src/Todo/conf/ copy todo.php-dist as todo.php.
+
+2) Edit src/Todo/conf/toto.php and set your database information
+ together with the 'tmp_folder'.
+
+3) Edit www/index.php and ensure that the variable $path_to_Pluf
+ is pointing to the folder where your Pluf.php file is.
+
+4) Point your web browser to /testapp/index.php?_px_action=/install/ it will
+ create the necessary tables to test the Todo application.
+
+5) Go to /testapp/index.php and enjoy this little todo application.
+
+ Uninstallation
+----------------
+
+1) Point your web browser to /testapp/index.php?_px_action=/uninstall/
+
+2) Delete the files in the 'tmp_folder'.
+
+3) Delete the /testapp/conf/testapp.php file.
+
diff --git a/apps/todos/src/Todo/Form/List.php b/apps/todos/src/Todo/Form/List.php
new file mode 100644
index 0000000..5da9724
--- /dev/null
+++ b/apps/todos/src/Todo/Form/List.php
@@ -0,0 +1,39 @@
+fields['name'] = new Pluf_Form_Field_Varchar(
+ array('required' => true,
+ 'label' => __('List name'),
+ 'help_text' => __('For example: "Happy stuff".'),
+ ));
+ }
+}
+
+
diff --git a/apps/todos/src/Todo/Item.php b/apps/todos/src/Todo/Item.php
new file mode 100644
index 0000000..9d073a0
--- /dev/null
+++ b/apps/todos/src/Todo/Item.php
@@ -0,0 +1,111 @@
+_a['table'] = 'todo_items';
+
+ /**
+ * The name of the model in the class definition.
+ */
+ $this->_a['model'] = 'Todo_Item';
+
+ /**
+ * The definition of the model. Each key of the associative array
+ * corresponds to a "column" and the definition of the column is
+ * given in the corresponding array.
+ */
+ $this->_a['cols'] = array(
+ // It is mandatory to have an "id" column.
+ 'id' =>
+ array(
+ 'type' => 'Pluf_DB_Field_Sequence',
+ //It is automatically added.
+ 'blank' => true,
+ ),
+ 'item' =>
+ array(
+ 'type' => 'Pluf_DB_Field_Varchar',
+ 'blank' => false,
+ 'size' => 250,
+ // The verbose name is all lower case
+ 'verbose' => __('todo item'),
+ ),
+ 'completed' =>
+ array(
+ 'type' => 'Pluf_DB_Field_Boolean',
+ 'default' => false,
+ 'verbose' => __('completed'),
+ ),
+ 'list' =>
+ array(
+ // Here we relate the model to a Todolist
+ // model. This is like saying that a Todoitem
+ // belongs to a given Todolist
+ 'type' => 'Pluf_DB_Field_Foreignkey',
+ 'blank' => false,
+ 'model' => 'Todo_List',
+ 'verbose' => __('in list'),
+ 'help_text' => __('To easily manage your todo items, you are invited to organize your todo items in lists.'),
+ ),
+ );
+ /**
+ * You can define the indexes.
+ * Indexes are you to sort and find elements. Here we define
+ * an index on the completed column to easily select the list
+ * of completed or not completed elements.
+ */
+ $this->_a['idx'] = array(
+ 'completed_idx' =>
+ array('col' => 'completed',
+ 'type' => 'normal'),
+ );
+ $this->_a['views'] = array(
+ 'todo' =>
+ array(
+ 'where' => 'completed=false',
+ ),
+ );
+ }
+
+ public function __toString()
+ {
+ return $this->item.(($this->completed) ? ' - Done' : '');
+ }
+}
+
diff --git a/apps/todos/src/Todo/List.php b/apps/todos/src/Todo/List.php
new file mode 100644
index 0000000..7b569ac
--- /dev/null
+++ b/apps/todos/src/Todo/List.php
@@ -0,0 +1,91 @@
+_a['table'] = 'todo_lists';
+
+ /**
+ * The name of the model in the class definition.
+ */
+ $this->_a['model'] = 'Todo_List';
+
+ /**
+ * The definition of the model. Each key of the associative array
+ * corresponds to a "column" and the definition of the column is
+ * given in the corresponding array.
+ */
+ $this->_a['cols'] = array(
+ // It is mandatory to have an "id" column.
+ 'id' =>
+ array(
+ 'type' => 'Pluf_DB_Field_Sequence',
+ //It is automatically added.
+ 'blank' => true,
+ ),
+ 'name' =>
+ array(
+ 'type' => 'Pluf_DB_Field_Varchar',
+ 'blank' => false,
+ 'size' => 100,
+ // The verbose name is all lower case
+ 'verbose' => __('name'),
+ ),
+ );
+ /**
+ * You can define the indexes.
+ * Indexes are you to sort and find elements. Here we define
+ * an index on the completed column to easily select the list
+ * of completed or not completed elements.
+ */
+ $this->_a['idx'] = array();
+ $this->_a['views'] = array();
+ }
+
+
+ /**
+ * To nicely render the list in the option boxes.
+ */
+ function __toString()
+ {
+ return $this->name;
+ }
+}
diff --git a/apps/todos/src/Todo/Migrations/Install.php b/apps/todos/src/Todo/Migrations/Install.php
new file mode 100644
index 0000000..d9c6330
--- /dev/null
+++ b/apps/todos/src/Todo/Migrations/Install.php
@@ -0,0 +1,61 @@
+model = $list;
+ $schema->createTables();
+ $schema->model = $item;
+ $schema->createTables();
+}
+
+function Todo_Migrations_Install_teardown($params='')
+{
+ // The uninstallation is the reverse of the installation.
+ // We create the data models the same way, but instead of calling
+ // createTables() we call dropTables()
+ // You can see that without all the comments, you do not have a
+ // lot of lines of code.
+ $list = new Todo_List();
+ $item = new Todo_Item();
+ $db = Pluf::db();
+ $schema = Pluf::factory('Pluf_DB_Schema', $db);
+ $schema->model = $list;
+ $schema->dropTables();
+ $schema->model = $item;
+ $schema->dropTables();
+}
diff --git a/apps/todos/src/Todo/Tests/TestTodo.php b/apps/todos/src/Todo/Tests/TestTodo.php
new file mode 100644
index 0000000..93ba6b5
--- /dev/null
+++ b/apps/todos/src/Todo/Tests/TestTodo.php
@@ -0,0 +1,114 @@
+client = new Pluf_Test_Client(Pluf::f('todo_urls'));
+ }
+
+ /**
+ * Delete the client and lists.
+ *
+ * Delete all the list which may be left. When the lists are
+ * deleted, the items in those list are automatically deleted too.
+ */
+ public function tearDown()
+ {
+ $this->client = null;
+ foreach ($this->lists as $list) {
+ $list->delete();
+ }
+ }
+
+ public function testCreateList()
+ {
+ $list = new Todo_List();
+ $list->name = 'Test list';
+ $this->assertEqual(true, $list->create());
+ $this->lists[] = $list; // to have it deleted in tearDown
+ $id = $list->id;
+ $nlist = new Todo_List($id);
+ $this->assertEqual($nlist->id, $id);
+ }
+
+ public function testCreateItem()
+ {
+ $list = new Todo_List();
+ $list->name = 'Test list';
+ $this->assertEqual(true, $list->create());
+ $this->lists[] = $list; // to have it deleted in tearDown
+ $item = new Todo_Item();
+ $item->list = $list;
+ $item->item = 'Create unit tests';
+ $this->assertEqual(true, $item->create());
+ $nlist = $item->get_list();
+ $this->assertEqual($nlist->id, $list->id);
+ $items = $list->get_todo_item_list();
+ $this->assertEqual(1, $items->count());
+ $item2 = new Todo_Item();
+ $item2->list = $list;
+ $item2->item = 'Create more unit tests';
+ $item2->create();
+ // first list has 2 items.
+ $this->assertEqual(2, $list->get_todo_item_list()->count());
+ $list2 = new Todo_List();
+ $list2->name = 'Test list 2';
+ $this->assertEqual(true, $list2->create());
+ $this->lists[] = $list2; // to have it deleted in tearDown
+ $this->assertEqual(0, $list2->get_todo_item_list()->count());
+ // Move the item in the second list.
+ $item2->list = $list2;
+ $item2->update();
+ // One item in each list.
+ $this->assertEqual(1, $list2->get_todo_item_list()->count());
+ $this->assertEqual(1, $list->get_todo_item_list()->count());
+ }
+
+}
\ No newline at end of file
diff --git a/apps/todos/src/Todo/Views.php b/apps/todos/src/Todo/Views.php
new file mode 100644
index 0000000..296af72
--- /dev/null
+++ b/apps/todos/src/Todo/Views.php
@@ -0,0 +1,379 @@
+getList();
+ // Create a context for the template
+ $context = new Pluf_Template_Context(array('page_title' => 'Home',
+ 'lists' => $lists)
+ );
+ // Load a template
+ $tmpl = new Pluf_Template('todo/index.html');
+ // Render the template and send the response to the user
+ return new Pluf_HTTP_Response($tmpl->render($context));
+ }
+
+
+ /**
+ * Display the viewItem page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function viewItem($request, $match)
+ {
+ // Basically the same as the viewList view but with a Todo_Item
+ $item_id = $match[1];
+ // We now are loading the corresponding item
+ $item = new Todo_Item($item_id);
+ // And check that the item has been found
+ if ($item->id != $item_id) {
+ return new Pluf_HTTP_Response_NotFound('The item has not been found.');
+ }
+ // Now we get the list in wich the item is
+ $list = $item->get_list();
+ // We have the item and the list, just display them. Instead of
+ // creating a context, then a template and then rendering it
+ // within a response object, we are going to use a shortcut
+ // function. Using shortcuts is better as you end up having a
+ // cleaner code.
+ return Pluf_Shortcuts_RenderToResponse('todo/item/view.html',
+ array('page_title' => 'View Item',
+ 'list' => $list,
+ 'item' => $item));
+ }
+
+ /**
+ * Display the addItem page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function addItem($request, $match)
+ {
+ // The workflow of the addition of an item is simple
+ // If the request of GET method a form is displayed
+ // If it is a POST method, the form is submitted and the
+ // content is proceeded to create the new item.
+ // We create a Todo_Item item as we are creating one here
+ $item = new Todo_Item();
+ $list = Pluf_Shortcuts_GetObjectOr404('Todo_List', $match[1]);
+ if ($request->method == 'POST') {
+ // We get the data submitted by the user and initialize
+ // the form with.
+ $form = Pluf_Shortcuts_GetFormForModel($item, $request->POST);
+ if ($form->isValid()) {
+ // If no errors, we can save the Todo_Item from the data
+ $item = $form->save();
+ // We redirect the user to the page of the Todo_List in which
+ // we have created the item.
+ // We redirect the user to the page of the Todo_List
+ // in which we have updated the item. We are using a
+ // shortcut to get the URL directly from the view name
+ // of interest. This allows us to not hard code the
+ // path to the view in the view itself.
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::viewList',
+ array($item->list));
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ } else {
+ // As we already now the list in which we are going to add
+ // the item, we pass it as initial value. The user can
+ // change it in the select box.
+ $initial = array('list'=>$list->id);
+ $form = Pluf_Shortcuts_GetFormForModel($item, $initial);
+ }
+ // Here we are with a GET request or a POST request with errors
+ // So we create the rendering view of the form
+ // We create a new rendering view
+ return Pluf_Shortcuts_RenderToResponse('todo/item/add.html',
+ array('page_title' => 'Create a Todo Item',
+ 'list' => $list,
+ 'form' => $form));
+ }
+
+ /**
+ * Display the updateItem page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function updateItem($request, $match)
+ {
+ // Updating an item is somehow like creating an object but you
+ // need first to load it to populate the form The workflow of
+ // the update of an item is simple If the request of GET
+ // method a form is displayed If it is a POST method, the form
+ // is submitted and the content is proceeded to update item.
+ // We create a Todo_Item item as we are updating one here
+
+ // Here we are going to use another shortcut to get the item
+ // or return a 404 error page if failing.
+ $item = Pluf_Shortcuts_GetObjectOr404('Todo_Item', $match[1]);
+ $new_data = $item->getData();
+ if ($request->method == 'POST') {
+ // We get the data submitted by the user
+ $form = Pluf_Shortcuts_GetFormForModel($item, $request->POST);
+ if ($form->isValid()) {
+ // The form is valid, we save it.
+ $item = $form->save();
+ // We redirect the user to the page of the Todo_List
+ // in which we have updated the item. We are using a
+ // shortcut to get the URL directly from the view name
+ // of interest. This allows us to not hard code the
+ // path to the view in the view itself.
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::viewList',
+ array($item->list));
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ } else {
+ $form = Pluf_Shortcuts_GetFormForModel($item, $item->getData());
+ }
+ // We proceed the same way by creating a context for a template
+ // and providing the results to the user.
+ return Pluf_Shortcuts_RenderToResponse('todo/item/update.html',
+ array('page_title' => 'Update a Todo Item',
+ 'item' => $item,
+ 'form' => $form));
+ }
+
+ /**
+ * Display the deleteItem page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function deleteItem($request, $match)
+ {
+ // A delete of an item is like an update. First you check that
+ // the item is available, then you delete it if the request is
+ // a POST request, else you provide a form to ask confirmation
+ // before deletion.
+ $item = Pluf_Shortcuts_GetObjectOr404('Todo_Item', $match[1]);
+ if ($request->method == 'POST') {
+ // Store the list id.
+ $list_id = $item->list;
+ // We can here directly delete the Todo_Item. Note that if
+ // your object is linking to other objects you need to be
+ // sure that you are taking into consideration the
+ // foreignkey and manytomany relationships.
+ $item->delete();
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::viewList',
+ array($list_id));
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ // Here we are with a GET request we show a form with a
+ // confirmation button to delete the item.
+ return Pluf_Shortcuts_RenderToResponse('todo/item/delete.html',
+ array('page_title' => 'Delete a Todo Item',
+ 'item' => $item));
+ }
+
+ /**
+ * Display the listLists page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function listLists($request, $match)
+ {
+ // The list of lists is like the home, so we just return
+ // the same content.
+ return $this->main($request, $match);
+ }
+
+ /**
+ * Display the viewList page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function viewList($request, $match)
+ {
+ // We are showing the content of the list.
+ // That is, all the items in the list.
+ $list = Pluf_Shortcuts_GetObjectOr404('Todo_List', $match[1]);
+ // Now we get the items in the list
+ $items = $list->get_todo_item_list();
+ // We have the items and the list, just display them
+ // Create a context for the template
+ return Pluf_Shortcuts_RenderToResponse('todo/list/view.html',
+ array('page_title' => 'View List',
+ 'list' => $list,
+ 'items' => $items));
+ }
+
+ /**
+ * Display the updateList page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function updateList($request, $match)
+ {
+ // Take a look at updateItem() to have explanations. Here you
+ // can see that the code is quite compact without comments.
+ $list = Pluf_Shortcuts_GetObjectOr404('Todo_List', $match[1]);
+ if ($request->method == 'POST') {
+ $form = new Todo_Form_List($request->POST);
+ if ($form->isValid()) {
+ $list->setFromFormData($form->cleaned_data);
+ $list->update();
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::viewList',
+ array($list->id));
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ } else {
+ $form = new Todo_Form_List($list->getData());
+ }
+ return Pluf_Shortcuts_RenderToResponse('todo/list/update.html',
+ array('page_title' => 'Edit a Todo List',
+ 'list' => $list,
+ 'form' => $form));
+ }
+
+ /**
+ * Display the deleteList page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function deleteList($request, $match)
+ {
+ // Here we show how a list can be delete with the associated
+ // Todo_Item.
+ $list = Pluf_Shortcuts_GetObjectOr404('Todo_List', $match[1]);
+ if ($request->method == 'POST') {
+ // We need first to delete all the Todo_Item in the list.
+ $items = $list->get_todo_item_list();
+ foreach ($items as $item) {
+ $item->delete();
+ }
+ // Then we can delete the list
+ $list->delete();
+ // You can also drop directly the list and the todo items
+ // will be automatically dropped at the same time.
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::main',
+ array());
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ // Here we are with a GET request we show a form with a
+ // confirmation button to delete the list.
+ // To show the items to be deleted, we get them
+ $items = $list->get_todo_item_list();
+ return Pluf_Shortcuts_RenderToResponse('todo/list/delete.html',
+ array('page_title' => 'Delete a Todo List',
+ 'list' => $list,
+ 'items' => $items));
+ }
+
+ /**
+ * Display the addList page of the application.
+ *
+ * @param Pluf_HTTP_Request Request object
+ * @param array Matches against the regex of the dispatcher
+ * @return Pluf_HTTP_Response or can throw Exception
+ */
+ public function addList($request, $match)
+ {
+ // The workflow of the addition of an item is simple
+ // If the request of GET method a form is displayed
+ // If it is a POST method, the form is submitted and the
+ // content is proceeded to create the new list.
+ // We create a Todo_List item as we are creating one here
+ $list = new Todo_List();
+ if ($request->method == 'POST') {
+ // We create the form bounded to the data submitted.
+ $form = new Todo_Form_List($request->POST);
+ if ($form->isValid()) {
+ // If no errors, we can save the Todo_List from the data
+
+ $list->setFromFormData($form->cleaned_data);
+ $list->create();
+ // We redirect the user to the page of the Todo_List
+ $url = Pluf_HTTP_URL_urlForView('Todo_Views::viewList',
+ array($list->id));
+ return new Pluf_HTTP_Response_Redirect($url);
+ }
+ } else {
+ $form = new Todo_Form_List();
+ }
+ return Pluf_Shortcuts_RenderToResponse('todo/list/add.html',
+ array('page_title' => 'Add a Todo List',
+ 'form' => $form));
+ }
+
+}
diff --git a/apps/todos/src/Todo/conf/todo.php b/apps/todos/src/Todo/conf/todo.php
new file mode 100644
index 0000000..0e5f430
--- /dev/null
+++ b/apps/todos/src/Todo/conf/todo.php
@@ -0,0 +1,79 @@
+ 'Pluf_Template_Tag_Url',
+ );
+
+// Default database configuration. The database defined here will be
+// directly accessible from Pluf::db() of course it is still possible
+// to open any other number of database connections through Pluf_DB
+$cfg['db_login'] = '';
+$cfg['db_password'] = '';
+$cfg['db_server'] = '';
+$cfg['db_database'] = $cfg['tmp_folder'].'/todo.db';
+
+// Must be shared by all the installed_apps and the core framework.
+// That way you can have several installations of the core framework.
+$cfg['db_table_prefix'] = 'pluf_testapp_';
+
+// Starting version 4.1 of MySQL the utf-8 support is "correct".
+// The reason of the db_version for MySQL is only for that.
+$cfg['db_version'] = '';
+$cfg['db_engine'] = 'SQLite';
+return $cfg;
diff --git a/apps/todos/src/Todo/conf/todo.php-dist b/apps/todos/src/Todo/conf/todo.php-dist
new file mode 100644
index 0000000..2cd7b84
--- /dev/null
+++ b/apps/todos/src/Todo/conf/todo.php-dist
@@ -0,0 +1,84 @@
+ 'Pluf_Template_Tag_Url',
+ );
+
+// Default database configuration. The database defined here will be
+// directly accessible from Pluf::db() of course it is still possible
+// to open any other number of database connections through Pluf_DB
+$cfg['db_login'] = '';
+$cfg['db_password'] = '';
+$cfg['db_server'] = '';
+$cfg['db_database'] = $cfg['tmp_folder'].'/todo.db';
+
+// Must be shared by all the installed_apps and the core framework.
+// That way you can have several installations of the core framework.
+$cfg['db_table_prefix'] = 'pluf_testapp_';
+
+// Starting version 4.1 of MySQL the utf-8 support is "correct".
+// The reason of the db_version for MySQL is only for that.
+$cfg['db_version'] = '';
+$cfg['db_engine'] = 'SQLite';
+return $cfg;
diff --git a/apps/todos/src/Todo/conf/todo.test.php b/apps/todos/src/Todo/conf/todo.test.php
new file mode 100644
index 0000000..267525c
--- /dev/null
+++ b/apps/todos/src/Todo/conf/todo.test.php
@@ -0,0 +1,93 @@
+ 'Pluf_Template_Tag_Url',
+ );
+
+// Default database configuration. The database defined here will be
+// directly accessible from Pluf::db() of course it is still possible
+// to open any other number of database connections through Pluf_DB
+$cfg['db_login'] = '';
+$cfg['db_password'] = '';
+$cfg['db_server'] = '';
+// For testing purpose, the SQLite memory database is the best thing
+// to use.
+$cfg['db_database'] = ':memory:';
+
+// Must be shared by all the installed_apps and the core framework.
+// That way you can have several installations of the core framework.
+$cfg['db_table_prefix'] = 'test_';
+$cfg['db_engine'] = 'SQLite';
+return $cfg;
diff --git a/apps/todos/src/Todo/conf/urls.php b/apps/todos/src/Todo/conf/urls.php
new file mode 100644
index 0000000..c1904ee
--- /dev/null
+++ b/apps/todos/src/Todo/conf/urls.php
@@ -0,0 +1,98 @@
+ '#^/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'main');
+
+$ctl[] = array('regex' => '#^/install/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'install');
+
+$ctl[] = array('regex' => '#^/uninstall/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'uninstall');
+
+$ctl[] = array('regex' => '#^/item/(\d+)/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'viewItem');
+
+$ctl[] = array('regex' => '#^/list/(\d+)/item/add/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'addItem');
+
+$ctl[] = array('regex' => '#^/item/(\d+)/update/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'updateItem');
+
+$ctl[] = array('regex' => '#^/item/(\d+)/delete/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'deleteItem');
+
+$ctl[] = array('regex' => '#^/list/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'listLists');
+
+$ctl[] = array('regex' => '#^/list/(\d+)/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'viewList');
+
+$ctl[] = array('regex' => '#^/list/(\d+)/update/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'updateList');
+
+$ctl[] = array('regex' => '#^/list/(\d+)/delete/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'deleteList');
+
+$ctl[] = array('regex' => '#^/list/add/$#',
+ 'priority' => 4,
+ 'base' => Pluf::f('todo_base'),
+ 'model' => 'Todo_Views',
+ 'method' => 'addList');
+
+return $ctl;
diff --git a/apps/todos/src/Todo/relations.php b/apps/todos/src/Todo/relations.php
new file mode 100644
index 0000000..f07a454
--- /dev/null
+++ b/apps/todos/src/Todo/relations.php
@@ -0,0 +1,33 @@
+ array('Todo_List'));
+return $m;
+?>
\ No newline at end of file
diff --git a/apps/todos/src/Todo/templates/todo/base.html b/apps/todos/src/Todo/templates/todo/base.html
new file mode 100644
index 0000000..b5383d4
--- /dev/null
+++ b/apps/todos/src/Todo/templates/todo/base.html
@@ -0,0 +1,18 @@
+
+
+
+
+
+ Todo Test Application : {$page_title}
+
+
+
+
'."\n";
+ return Pluf_Template_SafeString::markSafe($out);
+ }
+
+ /**
+ * Event are grouped by day per default, you can group as you
+ * want, just subclass this method. Groups are used to make
+ * columns in the table with the headings.
+ */
+ function getEventGroup($event)
+ {
+ return substr($event['start'], 0, 10);
+ }
+
+ /**
+ * Get all the available groups.
+ */
+ function getGroups()
+ {
+ if (count($this->_groups)) {
+ return $this->_groups;
+ }
+ foreach ($this->_events as $event) {
+ $group = $this->getEventGroup($event);
+ if (!in_array($group, $this->_groups)) {
+ $this->_groups[] = $group;
+ }
+ }
+ return $this->_groups;
+ }
+
+ /**
+ * Get the name of a group to print in the headers.
+ */
+ function getGroupName($group)
+ {
+ $dw = $this->daysOfWeek();
+ $days = date('w', strtotime($group));
+ return htmlspecialchars($dw[$days%7]);
+ }
+
+ /**
+ * Generate the body of the calendar.
+ */
+ function getBody()
+ {
+ $out = ''."\n";
+ $inters = $this->getTimeIntervals();
+ $groups = $this->getGroups();
+ for ($i=0;$i<(count($inters)-1);$i++) {
+ $out .= '
\n";
+ }
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Helper function to set the error from the DB.
+ *
+ * @param string Error message from the DB
+ */
+ function setDbError($db_error_msg)
+ {
+ $this->setError(__('DB error:').' '.$db_error_msg, 500);
+ }
+
+ /**
+ * Bulk set errors.
+ *
+ * Used when you went to recopy the errors of one object into
+ * another. You can call that way:
+ * $object->bulkSetErrors($otherobject->error());
+ *
+ * @param array List of errors
+ * @return bool Success
+ */
+ function bulkSetError($errors)
+ {
+ if (!is_array($errors)) {
+ return false;
+ }
+ foreach ($errors as $e) {
+ $this->setError($e[1], $e[0]);
+ }
+ return true;
+ }
+
+}
diff --git a/src/Pluf/Exception.php b/src/Pluf/Exception.php
new file mode 100644
index 0000000..22d1082
--- /dev/null
+++ b/src/Pluf/Exception.php
@@ -0,0 +1,26 @@
+data = $data;
+ $this->is_bound = true;
+ }
+ if ($label_suffix !== null) $this->label_suffix = $label_suffix;
+
+ $this->initFields($extra);
+ $this->f = new Pluf_Form_FieldProxy($this);
+ }
+
+ function initFields($extra=array())
+ {
+ throw new Exception('Definition of the fields not implemented.');
+ }
+
+ /**
+ * Add the prefix to the form names.
+ *
+ * @param string Field name.
+ * @return string Field name or field name with form prefix.
+ */
+ function addPrefix($field_name)
+ {
+ if ('' !== $this->prefix) {
+ return $this->prefix.'-'.$field_name;
+ }
+ return $field_name;
+ }
+
+ /**
+ * Check if the form is valid.
+ *
+ * It is also encoding the data in the form to be then saved. It
+ * is very simple as it leaves the work to the field. It means
+ * that you can easily extend this form class to have a more
+ * complex validation procedure like checking if a field is equals
+ * to another in the form (like for password confirmation) etc.
+ *
+ * @param array Associative array of the request
+ * @return array Array of errors
+ */
+ function isValid()
+ {
+ if ($this->is_valid !== null) {
+ return $this->is_valid;
+ }
+ $this->cleaned_data = array();
+ $this->errors = array();
+ $form_methods = get_class_methods($this);
+ foreach ($this->fields as $name=>$field) {
+ $value = $field->widget->valueFromFormData($this->addPrefix($name),
+ $this->data);
+ try {
+ $value = $field->clean($value);
+ $this->cleaned_data[$name] = $value;
+ if (in_array('clean_'.$name, $form_methods)) {
+ $m = 'clean_'.$name;
+ $value = $this->$m();
+ $this->cleaned_data[$name] = $value;
+ }
+ } catch (Pluf_Form_Invalid $e) {
+ if (!isset($this->errors[$name])) $this->errors[$name] = array();
+ $this->errors[$name][] = $e->getMessage();
+ if (isset($this->cleaned_data[$name])) {
+ unset($this->cleaned_data[$name]);
+ }
+ }
+ }
+ if (empty($this->errors)) {
+ try {
+ $this->cleaned_data = $this->clean();
+ } catch (Pluf_Form_Invalid $e) {
+ if (!isset($this->errors['__all__'])) $this->errors['__all__'] = array();
+ $this->errors['__all__'][] = $e->getMessage();
+ }
+ }
+ if (empty($this->errors)) {
+ $this->is_valid = true;
+ return true;
+ }
+ // as some errors, we do not have cleaned data available.
+ $this->cleaned_data = array();
+ $this->is_valid = false;
+ return false;
+ }
+
+ /**
+ * Form wide cleaning function. That way you can check that if an
+ * input is given, then another one somewhere is also given,
+ * etc. If the cleaning is not ok, your method must throw a
+ * Pluf_Form_Invalid exception.
+ *
+ * @return array Cleaned data.
+ */
+ public function clean()
+ {
+ return $this->cleaned_data;
+ }
+
+ /**
+ * Get initial data for a given field.
+ *
+ * @param string Field name.
+ * @return string Initial data or '' of not defined.
+ */
+ public function initial($name)
+ {
+ if (isset($this->fields[$name])) {
+ return $this->fields[$name]->initial;
+ }
+ return '';
+ }
+
+ /**
+ * Get the top errors.
+ */
+ public function render_top_errors()
+ {
+ $top_errors = (isset($this->errors['__all__'])) ? $this->errors['__all__'] : array();
+ array_walk($top_errors, 'Pluf_Form_htmlspecialcharsArray');
+ return new Pluf_Template_SafeString(Pluf_Form_renderErrorsAsHTML($top_errors), true);
+ }
+
+ /**
+ * Get the top errors.
+ */
+ public function get_top_errors()
+ {
+ return (isset($this->errors['__all__'])) ? $this->errors['__all__'] : array();
+ }
+
+ /**
+ * Helper function to render the form.
+ *
+ * See render_p() for a usage example.
+ *
+ * @credit Django Project (http://www.djangoproject.com/)
+ * @param string Normal row.
+ * @param string Error row.
+ * @param string Row ender.
+ * @param string Help text HTML.
+ * @param bool Should we display errors on a separate row.
+ * @return string HTML of the form.
+ */
+ protected function htmlOutput($normal_row, $error_row, $row_ender,
+ $help_text_html, $errors_on_separate_row)
+ {
+ $top_errors = (isset($this->errors['__all__'])) ? $this->errors['__all__'] : array();
+ array_walk($top_errors, 'Pluf_Form_htmlspecialcharsArray');
+ $output = array();
+ $hidden_fields = array();
+ foreach ($this->fields as $name=>$field) {
+ $bf = new Pluf_Form_BoundField($this, $field, $name);
+ $bf_errors = $bf->errors;
+ array_walk($bf_errors, 'Pluf_Form_htmlspecialcharsArray');
+ if ($field->widget->is_hidden) {
+ foreach ($bf_errors as $_e) {
+ $top_errors[] = sprintf(__('(Hidden field %1$s) %2$s'),
+ $name, $_e);
+ }
+ $hidden_fields[] = $bf; // Not rendered
+ } else {
+ if ($errors_on_separate_row and count($bf_errors)) {
+ $output[] = sprintf($error_row, Pluf_Form_renderErrorsAsHTML($bf_errors));
+ }
+ if (strlen($bf->label) > 0) {
+ $label = htmlspecialchars($bf->label, ENT_COMPAT, 'UTF-8');
+ if ($this->label_suffix) {
+ if (!in_array(mb_substr($label, -1, 1),
+ array(':','?','.','!'))) {
+ $label .= $this->label_suffix;
+ }
+ }
+ $label = $bf->labelTag($label);
+ } else {
+ $label = '';
+ }
+ if ($bf->help_text) {
+ // $bf->help_text can contains HTML and is not
+ // escaped.
+ $help_text = sprintf($help_text_html, $bf->help_text);
+ } else {
+ $help_text = '';
+ }
+ $errors = '';
+ if (!$errors_on_separate_row and count($bf_errors)) {
+ $errors = Pluf_Form_renderErrorsAsHTML($bf_errors);
+ }
+ $output[] = sprintf($normal_row, $errors, $label,
+ $bf->render_w(), $help_text);
+ }
+ }
+ if (count($top_errors)) {
+ $errors = sprintf($error_row,
+ Pluf_Form_renderErrorsAsHTML($top_errors));
+ array_unshift($output, $errors);
+ }
+ if (count($hidden_fields)) {
+ $_tmp = '';
+ foreach ($hidden_fields as $hd) {
+ $_tmp .= $hd->render_w();
+ }
+ if (count($output)) {
+ $last_row = array_pop($output);
+ $last_row = substr($last_row, 0, -strlen($row_ender)).$_tmp
+ .$row_ender;
+ $output[] = $last_row;
+ } else {
+ $output[] = $_tmp;
+ }
+
+ }
+ return new Pluf_Template_SafeString(implode("\n", $output), true);
+ }
+
+ /**
+ * Render the form as a list of paragraphs.
+ */
+ public function render_p()
+ {
+ return $this->htmlOutput('
%1$s%2$s %3$s%4$s
', '%s', '',
+ ' %s', true);
+ }
+
+ /**
+ * Render the form as a list without the
.
+ */
+ public function render_ul()
+ {
+ return $this->htmlOutput('
%1$s%2$s %3$s%4$s
', '
%s
',
+ '', ' %s', false);
+ }
+
+ /**
+ * Render the form as a list without the
.
+ */
+ public function render_table()
+ {
+ return $this->htmlOutput('
%2$s
%1$s%3$s%4$s
',
+ '
%s
',
+ '', ' %s', false);
+ }
+
+ /**
+ * Overloading of the get method.
+ *
+ * The overloading is to be able to use property call in the
+ * templates.
+ */
+ function __get($prop)
+ {
+ if (!in_array($prop, array('render_p', 'render_ul', 'render_table', 'render_top_errors', 'get_top_errors'))) {
+ return $this->$prop;
+ }
+ return $this->$prop();
+ }
+
+ /**
+ * Get a given field by key.
+ */
+ public function field($key)
+ {
+ return new Pluf_Form_BoundField($this, $this->fields[$key], $key);
+
+ }
+
+ /**
+ * Iterator method to iterate over the fields.
+ *
+ * Get the current item.
+ */
+ public function current()
+ {
+ $field = current($this->fields);
+ $name = key($this->fields);
+ return new Pluf_Form_BoundField($this, $field, $name);
+ }
+
+ public function key()
+ {
+ return key($this->fields);
+ }
+
+ public function next()
+ {
+ next($this->fields);
+ }
+
+ public function rewind()
+ {
+ reset($this->fields);
+ }
+
+ public function valid()
+ {
+ // We know that the boolean false will not be stored as a
+ // field, so we can test against false to check if valid or
+ // not.
+ return (false !== current($this->fields));
+ }
+
+}
+
+
+function Pluf_Form_htmlspecialcharsArray(&$item, $key)
+{
+ $item = htmlspecialchars($item, ENT_COMPAT, 'UTF-8');
+}
+
+function Pluf_Form_renderErrorsAsHTML($errors)
+{
+ $tmp = array();
+ foreach ($errors as $err) {
+ $tmp[] = '
'.$err.'
';
+ }
+ return '
'.implode("\n", $tmp).'
';
+}
diff --git a/src/Pluf/Form/BoundField.php b/src/Pluf/Form/BoundField.php
new file mode 100644
index 0000000..29fcb97
--- /dev/null
+++ b/src/Pluf/Form/BoundField.php
@@ -0,0 +1,156 @@
+form = $form;
+ $this->field = $field;
+ $this->name = $name;
+ $this->html_name = $this->form->addPrefix($name);
+ if ($this->field->label == '') {
+ $this->label = mb_ereg_replace('/\_/', '/ /', mb_ucfirst($name));
+ } else {
+ $this->label = $this->field->label;
+ }
+ $this->help_text = ($this->field->help_text) ? $this->field->help_text : '';
+ if (isset($this->form->errors[$name])) {
+ $this->errors = $this->form->errors[$name];
+ }
+ }
+
+ public function render_w($widget=null, $attrs=array())
+ {
+ if ($widget === null) {
+ $widget = $this->field->widget;
+ }
+ $id = $this->autoId();
+ if ($id and !array_key_exists('id', $attrs)
+ and !array_key_exists('id', $widget->attrs)) {
+ $attrs['id'] = $id;
+ }
+ if (!$this->form->is_bound) {
+ $data = $this->form->initial($this->name);
+ } else {
+ $data = $this->field->widget->valueFromFormData($this->html_name, $this->form->data);
+ }
+ return $widget->render($this->html_name, $data, $attrs);
+ }
+
+ /**
+ * Returns the HTML of the label tag. Wraps the given contents in
+ * a