Differences

This shows you the differences between two versions of the page.

--- documentation:rack:start [2018/05/26 14:32] – Martijn Luinstra
+++ documentation:rack:start [2022/04/03 14:00] (current) – external edit 127.0.0.1
@@ Line 11: / Line 11: @@
   * User authentication through the Cover API
+Future improvements:
+  * [[https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)|CSRF]] protection (this is a desired feature).
+  * Escaping values by default in templates.
+  * Broader coverage of HTML [[https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_<input>_types|form input types]]
+  * …and more! Please share your suggestions [[https://bitbucket.org/cover-webcie/rack/issues|here]].
+Rather than providing a fully-featured API, Rack aims to provide just enough functionality to cover the basic needs. Projects with more complicated requirements should extend, subclass and/or override Rack code where needed to add functionality.
 ===== Getting Started =====
@@ Line 53: / Line 60: @@
 ==== Creating views ====
+Now, you're ready to create views. A view is a ''php'' file in the project's root folder. Every view should include (or require) the ''include/init.php'' file, to load the Rack functionality. An example of a view that renders the template ''templates/index.php'' is provided below:
+<file php index.php>
+<?php
+require_once 'include/init.php';
+// Create and run home view
+$view = new TemplateView('index');
+$view->run();
+</file>
+==== Glossary ====
+  * **Committee login**: The internal mnemonic ID of a committee. It can be found as the value of the ''committee parameter'' in the url of the committee page on the Cover website. For example, login for the AC/DCee is ''webcie'' as can be seen in their url https://www.svcover.nl/commissies.php?commissie=webcie. Their is no guaranteed relationship between a committee login and its account name on the server, but there is always a working email address ''committee_login@svcover.nl''.
+  * **Committee name**: The real name of a committee. Like AC/DCee, IntroCee or StudCee.
+  * **Cover API**: The API of the Cover website, accessible through https://www.svcover.nl/api.php
+  * **Cover session**: The session of a logged in user of the Cover website.
+  * **Cover website**: Cover's home on the web, https://www.svcover.nl
 ===== API Reference =====
 {{page>documentation:rack:reference:start&noheader&nofooter}}
+====== Versions ======
+  * 1.1 (2019-05-10, Current)
+      * Added CSV view to ''ModelView''.
+      * Added optional Sentry support.
+      * ''Model->create()'' now returns the inserted ID.
+      * Various minor improvements/fixes
+  * 1.0 (2018-05-26)
+      * Initial version, based on various projects.