https://github.com/gabrielfalcao/littlejoy

really tiny framework for php
https://github.com/gabrielfalcao/littlejoy

Last synced: 32 minutes ago
JSON representation

really tiny framework for php

• Host: GitHub
• URL: https://github.com/gabrielfalcao/littlejoy
• Owner: gabrielfalcao
• Created: 2011-02-19T23:51:20.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2016-02-03T07:25:32.000Z (almost 9 years ago)
• Last Synced: 2024-10-03T00:26:41.595Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 94.7 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LittleJoy

Really tiny php framework focused on easy-to-write and easy-to-run tests through [phpunit](http://phpunit.de)

# hands on

Installation-free, just grab the code and copy the folder `Little` to

your project root.

Within your code, let's say `index.php`, all you have to do is require LittleJoy's bootstrap file:

> require_once "Little/Joy.php";

and start hacking!

## Controllers

Simple example, just put the code below in your `index.php` file, in Apache's DocRoot:

```php

 'index',

        '^hello' => 'hello_world'

    );

    public function index($response, $matches, $route) {

        return '
Index
';

    }

    public function hello_world($response, $matches, $route) {

        return '
Hello World
';

    }

}


Joy::and_work();

?>

```

### note on nice urls

You need [mod_rewrite](http://httpd.apache.org/docs/1.3/mod/mod_rewrite.html) working in your apache

and the following rewrite configuration:

```apache

RewriteEngine On

RewriteBase /

RewriteCond %{REQUEST_FILENAME} !-f

RewriteCond %{REQUEST_FILENAME} !-d

RewriteRule . /index.php [L]

```

## Active Record

It's inspired on

[django's model declaration](http://docs.djangoproject.com/en/dev/topics/db/models/),

so if you already worked with Django, it will not be a problem.

### Declare your models sweetly

```php

require_once "Little/Joy.php";

class School extends ModelJoy {

    var $name = array(type => CharField, max_length => 100);

    var $website = array(type => URLField);

}

class Person extends ModelJoy {

    var $name = array(type => CharField, max_length => 100);

    var $email = array(type => EmailField);

    var $bio = array(type => TextField);

    var $website = array(type => URLField);

    var $gender = array(type => ChoiceField, nullable => true, choices => array("male", "female"));

    var $birthday = array(type => DateTimeField, nullable => true);

    var $mother = array(type => ForeignKey, related_with => "Person");

    var $father = array(type => ForeignKey, related_with => "Person");

    var $school = array(type => ForeignKey, related_with => "School");

}

```

### Create all declared Models as tables in the database

    Joy::syncdb();

### Now you can play with it

    $school = School::populated_with(array("name" => "Harvard School of Engineer and Applied Sciences", "website" => "http://seas.harvard.edu/"));

    $school->save(); //performs a INSERT

    $school->website = http://new-website.url";

    $school->save(); //performs a UPDATE

    $found_by_name = School::find_one_by_name("Harvard School of Engineer and Applied Sciences");

    $found_by_website = School::find_one_by_website("http://new-website.url");

    $found_by_website->name === $found_by_name->name === $school->name;

# Contributing

## install dependencies to run tests

The very first thing you must install is PHPUnit, but since it's

documentation is quite a bit out-of-date, here is a small walk-through:

**ATTENTION**: this walkthrough consider that you have [pear](http://pear.php.net) installed on your computer.

### if you are running Mac OSX

You may choose whether to use its builtin php or install a alternative [homebrew](http://github.com/mxcl/homebrew/) version found [here](brew install https://github.com/ampt/homebrew/raw/php/Library/Formula/php.rb)

to do so:

    brew install https://github.com/ampt/homebrew/raw/php/Library/Formula/php.rb --with-apache --with-mysql

### afterwards

1. Add a few channels on your pear

2. Update your official channel

3. Update your pear version

4. Finally install PHPUnit

### OK, here is the big command, just paste it in your terminal

    pear channel-discover pear.phpunit.de

    pear channel-discover pear.symfony-project.com

    pear channel-discover components.ez.no

    pear channel-update pear.php.net

    pear upgrade pear

    pear install --alldeps pear.phpunit.de/PHPUnit

## next steps

### 1. fork and clone the project

### 2. install the dependencies above

### 3. run the tests with make:

    > make unit functional

### 4. hack at will

### 5. commit, push etc

### 6. send a pull request