PHPackages                             coly010/untitled - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. coly010/untitled

ActiveFramework[Framework](/categories/framework)

coly010/untitled
================

Micro Framework for PHP 5.6

v1.2.0(9y ago)0171BSD-3-ClausePHPPHP >=5.6.0

Since Jan 6Pushed 9y ago1 watchersCompare

[ Source](https://github.com/Coly010/Untitled)[ Packagist](https://packagist.org/packages/coly010/untitled)[ Docs](https://github.com/Coly010/Untitled)[ RSS](/packages/coly010-untitled/feed)WikiDiscussions master Synced today

READMEChangelog (4)DependenciesVersions (8)Used By (0)

Untitled Documentation
======================

[](#untitled-documentation)

### Contents

[](#contents)

- [Installation](#install)
- [Quick Start Guide](#qsg)
    - [Understanding Untitled Workflow](#uuw)
    - [Create your first page](#cyfp)
    - [Lets get some View Data!](#lgsvd)
- [Walkthrough](#walkthrough)
    - [Set Configuration](#setconfig)
    - [Pages](#pages)
    - [Routes](#routes)
    - [DataProcesses](#dataprocesses)
- [Additional Library References](#alr)
    - [Database](#db)
    - [Input](#input)
    - [Sanitiser](#sanitiser)
    - [Validator](#validator)
    - [Session](#session)
    - [ULogger](#ulogger)
- [Credits](#credits)

Installation
----------------------------------------------

[](#installation-)

There a few ways to install **Untitled**. We'll go into detail about them below.

### Download the source

[](#download-the-source)

1. Head over to the releases page:
2. Click the Download link for the zipped source code.
3. Choose a folder to download to.
4. Find the downloaded file and unzip it.
5. Start developing your app!

### Install via composer

[](#install-via-composer)

You can also install via composer, however it is not recommended as there is a few additional steps needed to get it to work.

1. If you do not have composer installed check here:
2. Run the following command `composer require coly010/untitled`
3. Now navigate into `vendor/coly010/untitled`
4. Copy the contents of the folder to your app's root.
5. Start developing your app!

Quick Start Guide
-----------------------------------------------

[](#quick-start-guide-)

Making web apps has become an integral part of the tech industry, and we all want to find an easier way to start from scratch, every time we have a new project.

That's where **Untitled** comes in. It streamlines the process of setting up a web app by doing a lot of the start up work for you. All you need to do is create your pages and you are good to go! **Untitled** comes shipped with [Twig](http://twig.sensiolabs.org/), a powerful template engine designed for PHP. It helps separate view logic from app logic.

Below we'll discuss quickly how to use **Untitled** for your own projects!

### Understanding Untitled Workflow

[](#understanding-untitled-workflow-)

**Untitled** has a slightly different workflow than you may be used to with different PHP frameworks.

**Untitled** focuses on the pages in your web app. For every page your web app has you simply create a new `Page` object to represent it. However, **Untitled** needs to match the requested URI to your pages. This is where one of the most powerful features of **Untitled** comes in: *Routes*.

Each of your `Page` objects contains an array of `Route` objects. When creating a `Route`object you need to set the URI that the `Route` will handle. Once you have your `Route`objects set up you simply add them to your `Page` object. **Untitled** takes care of the rest.

`DataProcess` objects are used if you need to perform any logic associated with a `Route`. Say for example you have a login form and you need to validate the form data, you would create a DataProcess to perform this logic. You then link the DataProcess to the `Route`object.

[Twig](http://twig.sensiolabs.org/) comes shipped and integrated into **Untitled** and is the set method for rendering pages. In your `Route` object you set the file path to the html file associated with the `Route`.

### Create Your First Page

[](#create-your-first-page-)

You should take note of the following directory structure for your application:

- Application
    - Cache
    - Config
    - DataProcesses
    - Pages
        - PageName
        - Routes
    - Views

This directory structure keeps your application code well structured and easy to find.

For every page you wish to create, always create a directory in the Pages directory with the name the name of your Page.

Ok, let's walk through the creation of our first page. Now, most websites have an `About` page so lets start there.

First, create a new folder in the `Pages` folder and call it `About`. Now, in the `About` folder, create another folder called `Routes`. It's time now to create the page. Create a new PHP file and name it `About_Page.php`. Notice the `_Page` suffix. This helps **Untitled** discover the pages in your app. It is a requirement to have this for the framework to work. Open `About_Page.php` and type the following:

```