README.md
[](https://travis-ci.org/AthensFramework/Core)
[](https://codeclimate.com/github/AthensFramework/core)
[](https://codeclimate.com/github/AthensFramework/core/coverage)
[](https://packagist.org/packages/athens/core)
Athens/Core
=============
*Athens* is a modern PHP web framework built within the University of Washington's Department of Enrollment Management.
<br>
*Easily create forms and manage submission results in* Athens *created web applications*
Applications built within *Athens* are:
1. Secure
*Athens* automatically provides strong protection against a number of web attacks, including CSRF, XSS, and database injection.
*Athens* also provides easy, seamless encryption for sensitive student information. Encrypting a database column requires a simple declaration in your model schema for each data-field you want to protect. Calls to and from the database on that encrypted data are transparent; *Athens* knows which fields are encrypted and handles the encryption/decryption behind the scenes.
2. Attractive
*Athens* includes beautiful page templates and user-interface elements. These default templates can be easily overridden with custom themes to implement your own organization's brand.
3. Legible
*Athens* separates declaring *what elements shall be on a page* from *what those elements should look like* and the logic of *how those elements should behave*. Under this model, creating a page is not much more complicated than simply listing the presentational elements that should be present.
4. Extensible
This separation of concerns also promotes reusability of components: a web-displayed table can be turned into Excel by changing a single line of code; a web-displayed form can be presented as a PDF by changing a single line of code. Adding a column to a table takes only one line, and in most cases *Athens* will be able to populate that column from the database without any further instruction.
Starting an Application
=======================
For help installing *Athens* and beginning a new application, see the [application creation tutorial](doc/application-creation.md).
Installation
===============
This library is published on packagist. To install using Composer, add the `"athens/core": "0.*"` line to your `"require"` dependencies:
```
{
"require": {
...
"athens/core": "0.*",
...
}
}
```
Because Athens depends on multiple other libraries, it is *highly* recommended that you use [Composer](https://getcomposer.org/) to install this library and manage dependencies.
Example
=======
Athens uses classes generated by [PropelORM](http://propelorm.org/) to store and retrieve database rows. First, we define a student class in schema.xml:
```
<table name="student">
<column name="id" type="integer" required="true" primaryKey="true" autoIncrement="true"/>
<column name="uw_student_number" type="varchar" size="7" required="true" phpName="UWStudentNumber"/>
<column name="first_name" type="varchar" size="127" required="true"/>
<column name="middle_initial" type="varchar" size="15" required="true"/>
<column name="last_name" type="varchar" size="127" required="true"/>
<column name="last_four_ssn" type="varchar" size="4" required="true"/>
</table>
```
Now we can use Propel to generate a `Student` instance and create a form which will store the student in the database:
```
<?php
require_once dirname(__FILE__) ."/../setup.php";
use Athens\Core\Form\FormBuilder;
use Athens\Core\Page\PageBuilder;
use Athens\Core\Page\Page;
use MyProject\Student;
$form = FormBuilder::begin()
->setId("student-form")
->addObject(new Student())
->build();
$page = PageBuilder::begin()
->setId('student-submission-page')
->setType(Page::PAGE_TYPE_FULL_HEADER)
->setTitle("My Project: Enter a Student")
->setHeader("My Project")
->setSubHeader("Enter a Student")
->setBaseHref("..")
->setWritable($form)
->build();
$page->render();
```
Add Ons
=======
Additional functionality is provided by the following libraries:
1. [Encryption](https://github.com/AthensFramework/Encryption/)
Seamlessly encrypt your sensitive data fields. The `Encryption` package is included with your Athens project to keep any table column encrypted while at rest in the database.
*Athens* projects include the `Encryption` package by default; you only have to include a few extra lines in your `schema.xml` to add encryption to your models. See the [`Encryption` project documentation(/AthensFramework/Encryption/) or the [application creation tutorial](doc/application-creation.md) for an example.
2. [SendGrid](https://github.com/AthensFramework/SendGrid/)
Send your emails via your SendGrid account. With just a couple of extra lines in your settings, your *Athens* application will send all of its emails via SendGrid.
The `SendGrid` package is not automatically included in your *Athens* project; you must follow the project instructions to use this package.
3. [CSRF](https://github.com/AthensFramework/CSRF/)
The standard *Athens* template project includes protection from CSRF attacks using the `CSRF` package. You can find out more by visiting the project documentation.
Compatibility
=============
* PHP 5.6, 7.0
Todo
====
See GitHub [issue tracker](https://github.com/AthensFramework/core/issues/).
Getting Involved
================
Feel free to open pull requests or issues. [GitHub](https://github.com/AthensFramework/core/) is the canonical location of this project.
Here's the general sequence of events for code contribution:
1. Open an issue in the [issue tracker](https://github.com/AthensFramework/core/issues/).
2. In any order:
* Submit a pull request with a **failing** test that demonstrates the issue/feature.
* Get acknowledgement/concurrence.
3. Revise your pull request to pass the test in (2). Include documentation, if appropriate.
[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) compliance is enforced by [CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) in Travis.