diff --git a/application/config/aliases.php b/application/config/aliases.php index d7d3f4b6..7bf753df 100644 --- a/application/config/aliases.php +++ b/application/config/aliases.php @@ -30,14 +30,12 @@ return array( 'Inflector' => 'System\\Inflector', 'Input' => 'System\\Input', 'Lang' => 'System\\Lang', - 'Log' => 'System\\Log', 'URL' => 'System\\URL', 'Redirect' => 'System\\Redirect', 'Request' => 'System\\Request', 'Response' => 'System\\Response', 'Session' => 'System\\Session', 'Str' => 'System\\Str', - 'Text' => 'System\\Text', 'Validator' => 'System\\Validator', 'View' => 'System\\View', diff --git a/application/config/auth.php b/application/config/auth.php index 1f994252..979231dd 100644 --- a/application/config/auth.php +++ b/application/config/auth.php @@ -4,29 +4,39 @@ return array( /* |-------------------------------------------------------------------------- - | Authentication Model + | Retrieve Users By ID |-------------------------------------------------------------------------- | - | This model will be used by the Auth class when retrieving the users of - | your application. Feel free to change it to the name of your user model. + | This method is called by the Auth::user() method when attempting to + | retrieve a user by their user ID. | - | Note: The authentication model must be an Eloquent model. + | You are free to change this method for your application however you wish. | */ - 'model' => 'User', + 'by_id' => function($id) + { + return User::find($id); + }, /* |-------------------------------------------------------------------------- - | Authentication Username + | Retrieve Users By Username |-------------------------------------------------------------------------- | - | The authentication username is the column on your users table that - | is considered the username of the user. Typically, this is either "email" - | or "username". However, you are free to make it whatever you wish. + | This method is called by the Auth::check() method when attempting to + | retrieve a user by their username. + | + | You are free to change this method for your application however you wish. + | + | Note: This method must return an object that has an "id" and a "password" + | property. The type of object returned doesn't matter. | */ - 'username' => 'email', + 'by_username' => function($username) + { + return User::where('email', '=', $username)->first(); + }, ); \ No newline at end of file diff --git a/application/config/error.php b/application/config/error.php index dd021e46..d0029390 100644 --- a/application/config/error.php +++ b/application/config/error.php @@ -24,11 +24,32 @@ return array( | Would you like errors to be logged? Error logging can be extremely | helpful when debugging a production application. | - | Note: When error logging is enabled, errors will be logged even when - | error detail is disabled. - | */ 'log' => false, + /* + |-------------------------------------------------------------------------- + | Error Logger + |-------------------------------------------------------------------------- + | + | Because of the sundry ways of managing error logging, you get complete + | flexibility to manage error logging as you see fit. + | + | This function will be called when an error occurs in your application. + | You can log the error however you like. + | + | The error "severity" passed to the method is a human-readable severity + | level such as "Parsing Error", "Fatal Error", etc. + | + | A simple logging system has been setup for you. By default, all errors + | will be logged to the application/log.txt file. + | + */ + + 'logger' => function($severity, $message) + { + System\File::append(APP_PATH.'storage/log.txt', date('Y-m-d H:i:s').' '.$severity.' - '.$message.PHP_EOL); + }, + ); \ No newline at end of file diff --git a/application/lang/en/validation.php b/application/lang/en/validation.php index fa09a0be..46a72f4d 100644 --- a/application/lang/en/validation.php +++ b/application/lang/en/validation.php @@ -2,50 +2,25 @@ return array( - /* - |-------------------------------------------------------------------------- - | General Validation Messages - |-------------------------------------------------------------------------- - */ - - "acceptance_of" => "The :attribute must be accepted.", - "confirmation_of" => "The :attribute confirmation does not match.", - "exclusion_of" => "The :attribute value is invalid.", - "format_of" => "The :attribute format is invalid.", - "inclusion_of" => "The :attribute value is invalid.", - "presence_of" => "The :attribute can't be empty.", - "uniqueness_of" => "The :attribute has already been taken.", - "with_callback" => "The :attribute is invalid.", - - /* - |-------------------------------------------------------------------------- - | Numericality_Of Validation Messages - |-------------------------------------------------------------------------- - */ - - "number_not_valid" => "The :attribute must be a number.", - "number_not_integer" => "The :attribute must be an integer.", - "number_wrong_size" => "The :attribute must be :size.", - "number_too_big" => "The :attribute must be no more than :max.", - "number_too_small" => "The :attribute must be at least :min.", - - /* - |-------------------------------------------------------------------------- - | Length_Of Validation Messages - |-------------------------------------------------------------------------- - */ - - "string_wrong_size" => "The :attribute must be :size characters.", - "string_too_big" => "The :attribute must be no more than :max characters.", - "string_too_small" => "The :attribute must be at least :min characters.", - - /* - |-------------------------------------------------------------------------- - | Upload_Of Validation Messages - |-------------------------------------------------------------------------- - */ - - "file_wrong_type" => "The :attribute must be a file of type: :types.", - "file_too_big" => "The :attribute exceeds size limit of :maxkb.", + "accepted" => "The :attribute must be accepted.", + "active_url" => "The :attribute does not exist.", + "alpha" => "The :attribute may only contain letters.", + "alpha_dash" => "The :attribute may only contain letters, numbers, dashes, and underscores.", + "alpha_num" => "The :attribute may only contain letters and numbers.", + "between" => "The :attribute must be between :min - :max.", + "confirmed" => "The :attribute confirmation does not match.", + "email" => "The :attribute format is invalid.", + "image" => "The :attribute must be an image.", + "in" => "The selected :attribute is invalid.", + "integer" => "The :attribute must be an integer.", + "max" => "The :attribute must be less than :max.", + "mimes" => "The :attribute must be a file of type: :values.", + "min" => "The :attribute must be at least :min.", + "not_in" => "The selected :attribute is invalid.", + "numeric" => "The :attribute must be a number.", + "required" => "The :attribute field is required.", + "size" => "The :attribute must be :size.", + "unique" => "The :attribute has already been taken.", + "url" => "The :attribute format is invalid.", ); \ No newline at end of file diff --git a/application/routes.php b/application/routes.php index e9f03c02..2f7242be 100644 --- a/application/routes.php +++ b/application/routes.php @@ -7,13 +7,10 @@ return array( | Application Routes |-------------------------------------------------------------------------- | - | Here is the "definition", or the public API, of your application. + | Here is the public API of your application. To add functionality to your + | application, you just add to the array located in this file. | - | To add functionality to your application, you add to the array located - | in this file. It's a breeze. Just tell Laravel the request method and - | URI a function should respond to. - | - | To learn more, check out: http://laravel.com/docs/basics/routes + | It's a breeze. Simply tell Laravel the request URIs it should respond to. | */ diff --git a/application/storage/logs/.gitignore b/application/storage/log.txt similarity index 100% rename from application/storage/logs/.gitignore rename to application/storage/log.txt diff --git a/application/views/error/404.php b/application/views/error/404.php index beca7493..9fe78810 100644 --- a/application/views/error/404.php +++ b/application/views/error/404.php @@ -4,53 +4,84 @@ 404 - Not Found - + + + -
+ -
- The resource you requested was not found. -

- Would you like go to our home page instead? -
+
+ + +

+ +

We couldn't find the resource you requested. Would you like go to our home page instead?

\ No newline at end of file diff --git a/application/views/error/500.php b/application/views/error/500.php index 213a9ea3..5167e59c 100644 --- a/application/views/error/500.php +++ b/application/views/error/500.php @@ -4,53 +4,84 @@ 500 - Internal Server Error - + + + -
+ -
- An error occured while we were processing your request. -

- Would you like go to our home page instead? -
+
+ + +

+ +

Something failed while we were handling your request. Would you like go to our home page instead?

\ No newline at end of file diff --git a/documentation/auth/config.md b/documentation/auth/config.md new file mode 100644 index 00000000..a9be4d69 --- /dev/null +++ b/documentation/auth/config.md @@ -0,0 +1,30 @@ +## Authentication Configuration + +Most interactive applications have the ability for users to login and logout. Obvious, right? Laravel provides a simple class to help you validate user credentials and retrieve information about the current user of your application. + +The quickest way to get started is to create an [Eloquent User model](/docs/database/eloquent) in your **application/models** directory: + + class User extends Eloquent {} + +Next, you will need to define **email** and **password** columns on your user database table. The password column should hold 60 alpha-numeric characters. The Auth class **requires** that all passwords be hashed and salted. + +> **Note:** The password column on your user table must really be named "password". + +Great job! You're ready to start using the Auth class. However, there are more advanced configuration options available if you wish to use them. + +Let's dig into the **application/config/auth.php** file. In this file you will find two closures: **by\_id** and **by\_username**: + + 'by_id' => function($id) + { + return User::find($id); + } + +The **by_id** function is called when the Auth class needs to retrieve a user by their primary key. As you can see, the default implementation of this function uses an "User" Eloquent model to retrieve the user by ID. However, if you are not using Eloquent, you are free to modify this function to meet the needs of your application. + + 'by_username' => function($username) + { + return User::where('email', '=', $username)->first(); + } + + +The **by_username** function is called when the Auth class needs to retrieve a user by their username, such as when using the **login** method. The default implementation of this function uses an "User" Eloquent model to retrieve the user by e-mail address. However, if you are not using Eloquent or do not wish to use e-mail addresses as usernames, you are free to modify this function as you wish as long as you return an object with **password** and **id** properties. \ No newline at end of file diff --git a/documentation/auth/usage.md b/documentation/auth/usage.md new file mode 100644 index 00000000..988ac27b --- /dev/null +++ b/documentation/auth/usage.md @@ -0,0 +1,77 @@ +## Authentication Usage + +- [Salting & Hashing](#hash) +- [Logging In](#login) +- [Protecting Routes](#filter) +- [Retrieving The Logged In User](#user) +- [Logging Out](#logout) + +> **Note:** Before using the Auth class, you must [specify a session driver](/docs/session/config). + + +### Salting & Hashing + +If you are using the Auth class, Laravel requires all passwords to be hashed and salted. Web development must be done responsibly. Salted, hashed passwords make a rainbow table attack against your user's passwords impractical. + +Don't worry, salting and hashing passwords is easy using the **Hash** class. The Hash class provides a simple way to hash passwords using the **bcrypt** hashing algorithm. Check out this example: + + $password = Hash::make('secret'); + +The **make** method of the Hash class will return a 60 character hashed string. + +You can compare an unhashed value against a hashed one using the **check** method on the **Hash** class: + + if (Hash::check('secret', $hashed_value)) + { + return 'The password is valid!'; + } + +> **Note:** Before using the Auth class, be sure to [create the "password" column](/docs/auth/config) on your user table. + + +### Logging In + +Logging a user into your application is simple using the **login** method on the Auth class. Simply pass the username and password of the user to the method. The login method will return **true** if the credentials are valid. Otherwise, **false** will be returned: + + if (Auth::login('example@gmail.com', 'password')) + { + return Redirect::to('user/profile'); + } + +If the user's credentials are valid, the user ID will be stored in the session and the user will be considered "logged in" on subsequent requests to your application. + +To determine if the user of your application is logged in, call the **check** method: + + if (Auth::check()) + { + return "You're logged in!"; + } + + +### Protecting Routes + +It is common to limit access to certain routes only to logged in users. It's a breeze in Laravel using the built-in [auth filter](/docs/start/routes#filters). If the user is logged in, the request will proceed as normal; however, if the user is not logged in, they will be redirected to the "login" [named route](/docs/start/routes#named). + +To protect a route, simply attach the **auth** filter: + + 'GET /admin' => array('before' => 'auth', 'do' => function() {}) + +> **Note:** You are free to edit the **auth** filter however you like. A default implementation is located in **application/filters.php**. + + +### Retrieving The Logged In User + +Once a user has logged in to your application, you may easily access the user model via the **user** method on the Auth class: + + return Auth::user()->email; + +> **Note:** If the user is not logged in, the **user** method will return NULL. + + +### Logging Out + +Ready to log the user out of your application? It's simple: + + Auth::logout(); + +This method will remove the user ID from the session, and the user will no longer be considered logged in on subsequent requests to your application. \ No newline at end of file diff --git a/documentation/cache/config.md b/documentation/cache/config.md new file mode 100644 index 00000000..00457368 --- /dev/null +++ b/documentation/cache/config.md @@ -0,0 +1,38 @@ +## Cache Configuration + +- [Memcached](#memcached) +- [Cache Keys](#keys) + +Imagine your application displays the ten most popular songs as voted on by your users. Do you really need to look up these ten songs every time someone visits your site? What if you could store them for 10 minutes, or even an hour, allowing you to dramatically speed up your application? Caching makes it simple. + +Laravel provides three wonderful cache drivers out of the box: + +- File System +- Memcached +- APC + +By default, Laravel is configured to use the **file** system cache driver. It's ready to go. The file system driver stores cached items as files in the **application/storage/cache** directory. If you're satisfied with this driver, no other configuration is required. You're ready to start using it. + +> **Note:** Before using the file system cache driver, make sure your **application/storage/cache** directory is writeable. + + +### Memcached + +[Memcached](http://memcached.org) is an ultra-fast, open-source distributed memory object caching system used by sites such as Wikipedia and Facebook. Before using Laravel's Memcached driver, you will need to install and configure Memcached and the PHP Memcache extension on your server. + +Once Memcached is installed on your server, configuring the Laravel driver is a breeze. First, set the **driver** in the **application/config/cache.php** file: + + 'driver' => 'memcached' + +Next, add your Memcached servers to the **servers** array: + + 'servers' => array( + array('host' => '127.0.0.1', 'port' => 11211, 'weight' => 100), + ) + + +### Cache Keys + +To avoid naming collisions with other applications using APC or a Memcached server, Laravel prepends a **key** to each item stored in the cache using these drivers. Feel free to change this value: + + 'key' => 'laravel' \ No newline at end of file diff --git a/documentation/cache/usage.md b/documentation/cache/usage.md new file mode 100644 index 00000000..4464e95a --- /dev/null +++ b/documentation/cache/usage.md @@ -0,0 +1,53 @@ +## Cache Usage + +- [Storing Items](#put) +- [Retrieving Items](#get) +- [Removing Items](#forget) + + +### Storing Items + +Storing items in the cache is simple. Simply call the **put** method on the Cache class: + + Cache::put('name', 'Taylor', 10); + +The first parameter is the **key** to the cache item. You will use this key to retrieve the item from the cache. The second parameter is the **value** of the item. The third parameter is the number of **minutes** you want the item to be cached. + +> **Note:** It is not necessary to serialize objects when storing them in the cache. + + +### Retrieving Items + +Retrieving items from the cache is even more simple than storing them. It is done using the **get** method. Just mention the key of the item you wish to retrieve: + + $name = Cache::get('name'); + +By default, NULL will be returned if the cached item has expired or does not exist. However, you may pass a different default value as a second parameter to the method: + + $name = Cache::get('name', 'Fred'); + +Now, "Fred" will be returned if the "name" cache item has expired or does not exist. + +What if you need a value from your database if a cache item doesn't exist? The solution is simple. You can pass a closure into the **get** method as a default value. The closure will only be executed if the cached item doesn't exist: + + $users = Cache::get('count', function() {return DB::table('users')->count();}); + +Let's take this example a step further. Imagine you want to retrieve the number of registered users for your application; however, if the value is not cached, you want to store the default value in the cache. It's a breeze using the **remember** method: + + $users = Cache::remember('count', function() {return DB::table('users')->count();}, 5); + +Let's talk through that example. If the **count** item exists in the cache, it will be returned. If it doesn't exist, the result of the closure will be stored in the cache for five minutes **and** be returned by the method. Slick, huh? + +Laravel even gives you a simple way to determine if a cached item exists using the **has** method: + + if (Cache::has('name')) + { + $name = Cache::get('name'); + } + + +### Removing Items + +Need to get rid of a cached item? No problem. Just mention the name of the item to the **forget** method: + + Cache::forget('name'); \ No newline at end of file diff --git a/documentation/contents.md b/documentation/contents.md new file mode 100644 index 00000000..e548e29b --- /dev/null +++ b/documentation/contents.md @@ -0,0 +1,53 @@ +## Getting Started + +- [Requirements & Installation](/docs/start/install) +- [Basic Configuration](/docs/start/config) +- [Routes](/docs/start/routes) + - [Defining Routes](/docs/start/routes#define) + - [Wildcard URI Segments](/docs/start/routes#segments) + - [Named Routes](/docs/start/routes#named) + - [Route Filters](/docs/start/routes#filters) + - [Organizing Routes](/docs/start/routes#organize) +- [Views & Responses](/docs/start/views) + - [Creating Views](/docs/start/views#create) + - [Binding Data To Views](/docs/start/views#bind) + - [Nesting Views Within Views](/docs/start/views#nest) + - [Redirects](/docs/start/views#redirect) + - [Downloads](/docs/start/views#downloads) + - [Building URLs](/docs/start/views#urls) + - [Building HTML](/docs/start/views#html) +- [Interaction](/docs/start/interaction) + - [Input](/docs/start/interaction#basics) + - [Old Input](/docs/start/interaction#old) + - [Cookies](/docs/start/interaction#cookies) + - [Building Forms](/docs/start/interaction#forms) +- [Data Validation](/docs/start/validation) + +## Database + +- [Configuration](/docs/database/config) +- [Usage](/docs/database/usage) +- [Fluent Query Builder](/docs/database/query) +- [Eloquent ORM](/docs/database/eloquent) + +## Caching + +- [Configuration](/docs/cache/config) +- [Usage](/docs/cache/usage) + +## Sessions + +- [Configuration](/docs/session/config) +- [Usage](/docs/session/usage) + +## Authentication + +- [Configuration](/docs/auth/config) +- [Usage](/docs/auth/usage) + +## Other Topics + +- [Working With Files](/docs/other/file) +- [Localization](/docs/other/lang) +- [Encryption](/docs/other/crypt) +- [Benchmarking Code](/docs/other/benchmark) \ No newline at end of file diff --git a/documentation/database/config.md b/documentation/database/config.md new file mode 100644 index 00000000..f0a24e54 --- /dev/null +++ b/documentation/database/config.md @@ -0,0 +1,52 @@ +## Database Configuration + +- [Quick Start Using SQLite](#quick) +- [Configuring MySQL or PostgreSQL](#server) +- [Setting The Default Connection Name](#default) + +Database configuration in Laravel is easy. The hardest part is deciding which database to use. Three popular open-source databases are supported out of the box: + +- MySQL +- PostgreSQL +- SQLite + +All of the database configuration options live in the **application/config/db.php** file. Let's get started. + + +### Quick Start Using SQLite + +[SQLite](http://sqlite.org) is an awesome, zero-configuration database system. By default, Laravel is configured to use a SQLite database. Really, you don't have to change anything. Just drop a SQLite database named **application.sqlite** into the **application/storage/db directory**. You're done. + +Of course, if you want to name your database something besides "application", you can modify the database option in the SQLite section of the **application/config/db.php** file: + + 'sqlite' => array( + 'driver' => 'sqlite', + 'database' => 'your_database_name', + ) + +If your application receives less than 100,000 hits per day, SQLite should be suitable for production use in your application. Otherwise, consider using MySQL or PostgreSQL. + +> **Note:** Need a good SQLite manager? Check out this [Firefox extension](https://addons.mozilla.org/en-US/firefox/addon/sqlite-manager/). + + +### Configuring MySQL or PostgreSQL + +If you are using MySQL or PostgreSQL, you will need to edit the configuration options in **application/config/db.php**. Don't worry. In the configuration file, sample configurations exist for both systems. All you need to do is change the options as necessary for your server and set the default connection name. + + 'mysql' => array( + 'driver' => 'mysql', + 'host' => 'localhost', + 'database' => 'database', + 'username' => 'root', + 'password' => 'password', + 'charset' => 'utf8', + ), + + +### Setting The Default Connection Name + +As you have probably noticed, each database connection defined in the **application/config/db.php** file has a name. By default, there are three connections defined: **sqlite**, **mysql**, and **pgsql**. You are free to change these connection names. The default connection can be specified via the **default** option: + + 'default' => 'sqlite'; + +The default connection will always be used by the [fluent query builder](/docs/database/query) and [Eloquent ORM](/docs/database/eloquent). If you need to change the default connection during a request, use the **Config::set** method. \ No newline at end of file diff --git a/documentation/database/eloquent.md b/documentation/database/eloquent.md new file mode 100644 index 00000000..aedca705 --- /dev/null +++ b/documentation/database/eloquent.md @@ -0,0 +1,306 @@ +## Eloquent ORM + +- [Conventions](#conventions) +- [Retrieving Models](#get) +- [Aggregates](#aggregates) +- [Inserting & Updating Models](#save) +- [Relationships](#relationships) +- [Eager Loading](#eager) + +An ORM is an [object-relational mapper](http://en.wikipedia.org/wiki/Object-relational_mapping), and Laravel has one that you will absolutely love to use. It is named "Eloquent" because it allows you to work with your database objects and relationships using an eloquent and expressive syntax. In general, you will define one Eloquent model for each table in your database. To get started, let's define a simple model: + + class User extends Eloquent {} + +Nice! Notice that our model extends the **Eloquent** class. This class will provide all of the functionality you need to start working eloquently with your database. + +> **Note:** Typically, Eloquent models live in the **application/models** directory. + + +### Conventions + +Eloquent makes a few basic assumptions about your database structure: + +- Each table should have a primary key named **id**. +- Each table name should be the plural form of its corresponding model name. + +Sometimes you may wish to use a table name other than the plural form of your model. No problem. Just add a static **table** property your model: + + class User extends Eloquent { + + public static $table = 'my_users'; + + } + + +### Retrieving Models + +Retrieving models using Eloquent is refreshingly simple. The most basic way to retrieve an Eloquent model is the static **find** method. This method will return a single model by primary key with properties corresponding to each column on the table: + + $user = User::find(1); + + echo $user->email; + +The find method will execute a query that looks something like this: + + SELECT * FROM "users" WHERE "id" = 1 + +Need to retrieve an entire table? Just use the static **all** method: + + $users = User::all(); + + foreach ($users as $user) + { + echo $user->email; + } + +Of course, retrieving an entire table isn't very helpful. Thankfully, **every method that is available through the fluent query builder is available in Eloquent**. Just begin querying your model with a static call to one of the [query builder](/docs/database/query) methods, and execute the query using the **get** or **first** method. The get method will return an array of models, while the first method will return a single model: + + $user = User::where('email', '=', $email)->first(); + + $user = User::where_email($email)->first(); + + $users = User::where_in('id', array(1, 2, 3))->or_where('email', '=', $email)->get(); + + $users = User::order_by('votes', 'desc')->take(10)->get(); + +> **Note:** If no results are found, the **first** method will return NULL. The **all** and **get** methods return an empty array. + + +### Aggregates + +Need to get a **MIN**, **MAX**, **AVG**, **SUM**, or **COUNT** value? Just pass the column to the appropriate method: + + $min = User::min('id'); + + $max = User::max('id'); + + $avg = User::avg('id'); + + $sum = User::sum('id'); + + $count = User::count(); + +Of course, you may wish to limit the query using a WHERE clause first: + + $count = User::where('id', '>', 10)->count(); + + +### Inserting & Updating Models + +Inserting Eloquent models into your tables couldn't be easier. First, instantiate a new model. Second, set its properties. Third, call the **save** method: + + $user = new User; + + $user->email = 'example@gmail.com'; + $user->password = 'secret'; + + $user->save(); + +Updating models is just as simple. Instead of instantiating a new model, retrieve one from your database. Then, set its properties and save: + + $user = User::find(1); + + $user->email = 'new_email@gmail.com'; + $user->password = 'new_secret'; + + $user->save(); + +Need to maintain creation and update timestamps on your database records? With Eloquent, you don't have to worry about it. Just add a static **timestamps** property to your model: + + class User extends Eloquent { + + public static $timestamps = true; + + } + +Next, add **created_at** and **updated_at** date columns to your table. Now, whenever you save the model, the creation and update timestamps will be set automatically. You're welcome. + +> **Note:** You can change the default timezone of your application in the **application/config/application.php** file. + + +### Relationships + +Unless you're doing it wrong, your database tables are probably related to one another. For instance, an order may belong to a user. Or, a post may have many comments. Eloquent makes defining relationships and retrieving related models simple and intuitive. Laravel supports three types of relationships: + +- [One-To-One](#one-to-one) +- [One-To-Many](#one-to-many) +- [Many-To-Many](#many-to-many) + +To define a relationship on an Eloquent model, you simply create a method that returns the result of either the **has\_one**, **has\_many**, **belongs\_to**, or **has\_and\_belongs\_to\_many** method. Let's examine each one in detail. + + +#### One-To-One + +A one-to-one relationship is the most basic form of relationship. For example, let's pretend a user has one phone. Simply describe this relationship to Eloquent: + + class User extends Eloquent { + + public function phone() + { + return $this->has_one('Phone'); + } + + } + +Notice that the name of the related model is passed to the **has_one** method. You can now retrieve the phone of a user through the **phone** method: + + $phone = User::find(1)->phone()->first(); + +Let's examine the SQL performed by this statement. Two queries will be performed: one to retrieve the user and one to retrieve the user's phone: + + SELECT * FROM "users" WHERE "id" = 1 + + SELECT * FROM "phones" WHERE "user_id" = 1 + +Note that Eloquent assumes the foreign key of the relationship will be **user\_id**. Most foreign keys will follow this **model\_id** convention; however, if you want to use a different column name as the foreign key, just pass it in the second parameter to the method: + + return $this->has_one('Phone', 'my_foreign_key'); + +Want to just retrieve the user's phone without calling the first method? No problem. Just use the **dynamic phone property**. Eloquent will automatically load the relationship for you, and is even smart enough to know whether to call the get (for one-to-many relationships) or first (for one-to-one relationships) method: + + $phone = User::find(1)->phone; + +What if you need to retrieve a phone's user? Since the foreign key (**user\_id**) is on the phones table, we should describe this relationship using the **belongs\_to** method. It makes sense, right? Phones belong to users. When using the **belongs\_to** method, the name of the relationship method should correspond to the foreign key (sans the **\_id**). Since the foreign key is **user\_id**, your relationship method should be named **user**: + + class Phone extends Eloquent { + + public function user() + { + return $this->belongs_to('User'); + } + + } + +Great! You can now access a User model through a Phone model using either your relationship method or dynamic property: + + echo Phone::find(1)->user()->first()->email; + + echo Phone::find(1)->user->email; + + +#### One-To-Many + +Assume a blog post has many comments. It's easy to define this relationship using the **has_many** method: + + class Post extends Eloquent { + + public function comments() + { + return $this->has_many('Comment'); + } + + } + +Now, simply access the post comments through the relationship method or dynamic property: + + $comments = Post::find(1)->comments()->get(); + + $comments = Post::find(1)->comments; + +Both of these statements will execute the following SQL: + + SELECT * FROM "posts" WHERE "id" = 1 + + SELECT * FROM "comments" WHERE "post_id" = 1 + +Want to join on a different foreign key? No problem. Just pass it in the second parameter to the method: + + return $this->has_many('Comment', 'my_foreign_key'); + +You may be wondering: _If the dynamic properties return the relationship and require less keystokes, why would I ever use the relationship methods?_ Actually, relationship methods are very powerful. They allow you to continue to chain query methods before retrieving the relationship. Check this out: + + echo Post::find(1)->comments()->order_by('votes', 'desc')->take(10)->get(); + + +#### Many-To-Many + +Many-to-many relationships are the most complicated of the three relationships. But don't worry, you can do this. For example, assume a User has many Roles, but a Role can also belong to many Users. Three database tables must be created to accomplish this relationship: a **users** table, a **roles** table, and a **roles_users** table. The structure for each table looks like this: + +**Users:** + + id - INTEGER + email - VARCHAR + +**Roles:** + + id - INTEGER + name - VARCHAR + +**Roles_Users:** + + user_id - INTEGER + role_id - INTEGER + +Now you're ready to define the relationship on your models using the **has\_and\_belongs\_to\_many** method: + + class User extends Eloquent { + + public function roles() + { + return $this->has_and_belongs_to_many('Role'); + } + + } + +Great! Now it's time to retrieve a user's roles: + + $roles = User::find(1)->roles()->get(); + +Or, as usual, you may retrieve the relationship through the dynamic roles property: + + $roles = User::find(1)->roles; + +As you may have noticed, the default name of the intermediate table is the plural names of the two related models arranged alphabetically and concatenated by an underscore. However, you are free to specify your own table name. Simply pass the table name in the second parameter to the **has\_and\_belongs\_to\_many** method: + + class User extends Eloquent { + + public function roles() + { + return $this->has_and_belongs_to_many('Role', 'user_roles'); + } + + } + + +### Eager Loading + +Eager loading exists to alleviate the N + 1 query problem. Exactly what is this problem? Well, pretend each Book belongs to an Author. We would describe this relationship like so: + + class Book extends Eloquent { + + public function author() + { + return $this->belongs_to('Author'); + } + + } + +Now, examine the following code: + + foreach (Book::all() as $book) + { + echo $book->author->name; + } + +How many queries will be executed? Well, one query will be executed to retrieve all of the books from the table. However, another query will be required for each book to retrieve the author. To display the author name for 25 books would require **26 queries**. See how the queries can add up fast? + +Thankfully, you can eager load the author models using the **with** method. Simply mention the **function name** of the relationship you wish to eager load: + + foreach (Book::with('author')->get() as $book) + { + echo $book->author->name; + } + +In this example, **only two queries will be executed**! + + SELECT * FROM "books" + + SELECT * FROM "authors" WHERE "id" IN (1, 2, 3, 4, 5, ...) + +Obviously, wise use of eager loading can dramatically increase the performance of your application. In the example above, eager loading cut the execution time in half. + +Need to eager load more than one relationship? It's easy: + + $books = Book::with('author', 'publisher')->get(); + +> **Note:** When eager loading, the call to the static **with** method must always be at the beginning of the query. \ No newline at end of file diff --git a/documentation/database/query.md b/documentation/database/query.md new file mode 100644 index 00000000..70dda78f --- /dev/null +++ b/documentation/database/query.md @@ -0,0 +1,216 @@ +## Fluent Query Builder + +- [Retrieving Records](#get) +- [Building Where Clauses](#where) +- [Dynamic Where Clauses](#dynamic) +- [Table Joins](#joins) +- [Ordering Results](#ordering) +- [Skip & Take](#limit) +- [Aggregates](#aggregates) +- [Inserting Records](#insert) +- [Updating Records](#update) +- [Deleting Records](#delete) + +Laravel provides an awesome, easy-to-use fluent interface for building SQL queries and working with your database. All queries use prepared statements and are protected against SQL injection. Working with your database doesn't have to be a headache. + +You can begin a fluent query using the **table** method on the DB class. Just mention the table you wish to query: + + $query = DB::table('users'); + +You now have a fluent query builder for the "users" table. Using this query builder, you can retrieve, insert, update, or delete records from the table. + + +### Retrieving Records + +There are two methods available for retrieving records using a fluent query: **get** and **first**. The **get** method will return an array of records from your database. Each record will be an object with properties corresponding to the columns of the table: + + $users = DB::table('users')->get(); + + foreach ($users as $user) + { + echo $user->email; + } + +Instead of returning an array, the **first** method will return a single object: + + $user = DB::table('users')->first(); + + echo $user->email; + +It's easy to limit the columns returned by your query. Simply pass an array of columns you want into the **get** or **first** method: + + $user = DB::table('users')->get(array('id', 'email as user_email')); + +Need to get distinct records from the database? It's easy. Call the **distinct** method before retrieving your records: + + $user = DB::table('users')->distinct()->get(); + +> **Note:** If no results are found, the **first** method will return NULL. The **get** method will return an empty array. + + +### Building Where Clauses + +#### where and or\_where + +Building WHERE clauses in Laravel is painless. There are a variety of methods to assist you. The most basic of these methods are the **where** and **or_where** methods. Here is how to use them: + + return DB::table('users') + ->where('id', '=', 1) + ->or_where('email', '=', 'example@gmail.com') + ->first(); + +Of course, you are not limited to simply checking equality. You may also use **greater-than**, **less-than**, **not-equal**, and **like**: + + return DB::table('users') + ->where('id', '>', 1) + ->or_where('name', 'LIKE', '%Taylor%') + ->first(); + +You may have assumed that the **where** method will add to the query using an AND condition, while the **or_where** method will use an OR condition. You assumed correctly. + +#### where\_in, where\_not\_in, or\_where\_in, and or\_where\_not\_in + +The suite of **where_in** methods allows you to easily construct queries that search an array of values: + + DB::table('users')->where_in('id', array(1, 2, 3))->get(); + + DB::table('users')->where_not_in('id', array(1, 2, 3))->get(); + + DB::table('users') + ->where('email', '=', 'example@gmail.com') + ->or_where_in('id', array(1, 2, 3)) + ->get(); + + DB::table('users') + ->where('email', '=', 'example@gmail.com') + ->or_where_not_in('id', array(1, 2, 3)) + ->get(); + +#### where\_null, where\_not\_null, or\_where\_null, and or\_where\_not\_null + +The suite of **where_null** methods makes checking for NULL values a piece of cake: + + return DB::table('users')->where_null('updated_at')->get(); + + return DB::table('users')->where_not_null('updated_at')->get(); + + return DB::table('users') + ->where('email', '=', 'example@gmail.com') + ->or_where_null('updated_at') + ->get(); + + return DB::table('users') + ->where('email', '=', 'example@gmail.com') + ->or_where_not_null('updated_at') + ->get(); + + +### Dynamic Where Clauses + +Ready for some really beautiful syntax? Check out **dynamic where methods**: + + $user = DB::table('users')->where_email('example@gmail.com')->first(); + + $user = DB::table('users')->where_email_and_password('example@gmail.com', 'secret'); + + $user = DB::table('users')->where_id_or_name(1, 'Fred'); + +Aren't they a breathe of fresh air? + + +### Table Joins + +Need to join to another table? Try the **join** and **left\_join** methods: + + DB::table('users') + ->join('phone', 'users.id', '=', 'phone.user_id') + ->get(array('users.email', 'phone.number')); + +The **table** you wish to join is passed as the first parameter. The remaining three parameters are used to construct the **ON** clause of the join. + +Once you know how to use the join method, you know how to **left_join**. The method signatures are the same: + + DB::table('users') + ->left_join('phone', 'users.id', '=', 'phone.user_id') + ->get(array('users.email', 'phone.number')); + + +### Ordering Results + +You can easily order the results of your query using the **order_by** method. Simply mention the column and direction (desc or asc) of the sort: + + return DB::table('users')->order_by('email', 'desc')->get(); + +Of course, you may sort on as many columns as you wish: + + return DB::table('users') + ->order_by('email', 'desc') + ->order_by('name', 'asc') + ->get(); + + +### Skip & Take + +If you would like to **LIMIT** the number of results returned by your query, you can use the **take** method: + + return DB::table('users')->take(10)->get(); + +To set the **OFFSET** of your query, use the **skip** method: + + return DB::table('users')->skip(10)->get(); + + +### Aggregates + +Need to get a **MIN**, **MAX**, **AVG**, **SUM**, or **COUNT** value? Just pass the column to the query: + + $min = DB::table('users')->min('age'); + + $max = DB::table('users')->max('weight'); + + $avg = DB::table('users')->avg('salary'); + + $sum = DB::table('users')->sum('votes'); + + $count = DB::table('users')->count(); + +Of course, you may wish to limit the query using a WHERE clause first: + + $count = DB::table('users')->where('id', '>', 10)->count(); + + +### Inserting Records + +Inserting records is amazingly easy using the **insert** method. The method only expects an array of values to insert. It couldn't be simpler. The insert method will simply return true or false, indicating whether the query was successful: + + DB::table('users')->insert(array('email' => 'example@gmail.com')); + +Inserting a record that has an auto-incrementing ID? You can use the **insert\_get\_id** method to insert a record and retrieve the ID: + + $id = DB::table('users')->insert_get_id(array('email' => 'example@gmail.com')); + +> **Note:** The **insert\_get\_id** method expects the name of the auto-incrementing column to be "id". + + +### Updating Records + +Updating records is just as simple as inserting them. Simply pass an array of values to the **update** method: + + $affected = DB::table('users')->update(array('email' => 'new_email@gmail.com')); + +Of course, when you only want to update a few records, you should add a WHERE clause before calling the update method: + + $affected = DB::table('users') + ->where('id', '=', 1) + ->update(array('email' => 'new_email@gmail.com')); + + +### Deleting Records + +When you want to delete records from your database, simply call the **delete** method: + + $affected = DB::table('users')->where('id', '=', 1)->delete(); + +Want to quickly delete a record by its ID? No problem. Just pass the ID into the delete method: + + $affected = DB::table('users')->delete(1); \ No newline at end of file diff --git a/documentation/database/usage.md b/documentation/database/usage.md new file mode 100644 index 00000000..1308153e --- /dev/null +++ b/documentation/database/usage.md @@ -0,0 +1,33 @@ +## Database Usage + +### Queries + +Running queries against a database connection is a breeze using the **query** method on the DB class: + + $users = DB::query('select * from users'); + +The **query** method also allows you to specify bindings for your query in the second parameter to the method: + + $users = DB::query('select * from users where name = ?', array('test')); + +The return value of the query method depends on the type of query that is executed: + +- **SELECT** statements will return an array of stdClass objects with properties corresponding to each column on the table. +- **INSERT** statements will return **true** or **false**, depending on the success of the query. +- **UPDATE** and **DELETE** statements will return the number of rows affected by the query. + +### Connections + +Need to get the raw PDO object for a connection? It's easy. Just mention the connection name to the **connection** method on the DB class: + + $pdo = DB::connection('sqlite'); + +> **Note:** If no connection name is specified, the **default** connection will be returned. + +### Driver + +Want to know which PDO driver is being used for a connection? Check out the **driver** method: + + $driver = DB::driver('connection_name'); + +> **Note:** If no connection name is specified, the **default** connection driver will be returned. \ No newline at end of file diff --git a/documentation/other/benchmark.md b/documentation/other/benchmark.md new file mode 100644 index 00000000..72a83433 --- /dev/null +++ b/documentation/other/benchmark.md @@ -0,0 +1,30 @@ +## Benchmarking Code + +- [The Basics](#basics) +- [Using Timers](#timers) +- [Checking Memory Usage](#memory) + + +### The Basics + +When making changes to your code, it's helpful to know the performance impact of your changes. Laravel provides a simple class to help you time code execution and check memory consumption. It's called the **Benchmark** class and it's a breeze to use. + + +### Using Timers + +To start a timer, simply call the **start** method on the Benchmark class and give your timer a name: + + Benchmark::start('foo'); + +Pretty easy, right? + +You can easily check how much time has elapsed (in milliseconds) using the **check** method. Again, just mention the name of the timer to the method: + + echo Benchmark::check('foo'); + + +### Checking Memory Usage + +Need to know how much memory is being used by your application? No problem. Just call the **memory** method to get your current memory usage in megabytes: + + echo Benchmark::memory(); \ No newline at end of file diff --git a/documentation/other/crypt.md b/documentation/other/crypt.md new file mode 100644 index 00000000..9c1e6471 --- /dev/null +++ b/documentation/other/crypt.md @@ -0,0 +1,36 @@ +## Encryption + +- [The Basics](#basics) +- [Encrypting A String](#encrypt) +- [Decrypting A String](#decrypt) + + +### The Basics + +Need to do secure, two-way encryption? Laravel has you covered with the **Crypt** class. The Crypt class provides strong AES-256 encryption and decryption out of the box via the Mcrypt PHP extension. + +To get started, you must set your **application key** in the **application/config/application.php** file. This key should be very random and very secret, as it will be used during the encryption and decryption process. It is best to use a random, 32 character alpha-numeric string: + + 'key' => 'xXSAVghP7myRo5xqJAnMvQwBc7j8qBZI'; + +Wonderful. You're ready to start encrypting. + +> **Note:** Don't forget to install the Mcrypt PHP extension on your server. + + +### Encrypting A String + +Encrypting a string is a breeze. Just pass it to the **encrypt** method on the Crypt class: + + Crypt::encrypt($value); + +Do you feel like James Bond yet? + + +### Decrypting A String + +So you're ready to decrypt a string? It's simple. Just use the **decrypt** method on the Crypt class: + + Crypt::decrypt($encrypted_value); + +> **Note:** The decrypt method will only decrypt strings that were encrypted using **your** application key. \ No newline at end of file diff --git a/documentation/other/file.md b/documentation/other/file.md new file mode 100644 index 00000000..ee0e0ee6 --- /dev/null +++ b/documentation/other/file.md @@ -0,0 +1,69 @@ +## Working With Files + +- [Reading Files](#get) +- [Writing Files](#put) +- [File Uploads](#upload) +- [File Extensions](#ext) +- [Checking File Types](#is) +- [Getting MIME Types](#mime) + + +### Reading Files + +It's a breeze to get the contents of a file using the **get** method on the **File** class: + + $contents = File::get('path/to/file'); + + +### Writing Files + +Need to write to a file? Check out the **put** method: + + File::put('path/to/file', 'file contents'); + +Want to append to the file instead of overwriting the existing contents? No problem. Use the **append** method: + + File::append('path/to/file', 'appended file content'); + + +### File Uploads + +After a file has been uploaded to your application, you will want to move it from its temporary location to a permanent directory. You can do so using the **upload** method. Simply mention the **name** of the uploaded file and the path where you wish to store it: + + File::upload('picture', 'path/to/pictures'); + +> **Note:** You can easily validate file uploads using the [Validator class](/docs/start/validation). + + +### File Extensions + +Need to get the extension of a file? Just pass the filename to the **extension** method: + + File::extension('picture.png'); + + +### Checking File Types + +Often, it is important to know the type of a file. For instance, if a file is uploaded to your application, you may wish to verify that it is an image. It's easy using the **is** method on the **File** class. Simply pass the extension of the file type you are expecting. Here's how to verify that a file is a JPG image: + + if (File::is('jpg', 'path/to/file.jpg')) + { + // + } + +The **is** method does not simply check the file extension. The Fileinfo PHP extension will be used to read the content of the file and determine the actual MIME type. Pretty cool, huh? + +> **Note:** You may pass any of the extensions defined in the **application/config/mimes.php** file to the **is** method. + + +### Getting MIME Types + +Need to know the MIME type associated with a file extension? Check out the **mime** method: + + echo File::mime('gif'); + +The statement above returns the following string: + + image/gif + +> **Note:** This method simply returns the MIME type defined for the extension in the **application/config/mimes.php** file. \ No newline at end of file diff --git a/documentation/other/lang.md b/documentation/other/lang.md new file mode 100644 index 00000000..9fc5c066 --- /dev/null +++ b/documentation/other/lang.md @@ -0,0 +1,62 @@ +## Localization + +- [The Basics](#basics) +- [Retrieving A Language Line](#get) +- [Place Holders & Replacements](#replace) + + +### The Basics + +Localization is the process of translating your application into different languages. The **Lang** class provides a simple mechanism to help you organize and retrieve the text of your multilingual application. + +All of the language files for your application live under the **application/lang** directory. Within the **application/lang** directory, you should create a directory for each language your application speaks. So, for example, if your application speaks English and Spanish, you might create **en** and **sp** directories under the **lang** directory. + +Each language directory may contain many different language files. Each language file is simply an array of string values in that language. In fact, language files are structured identically to configuration files. For example, within the **application/lang/en** directory, you could create a **marketing.php** file that looks like this: + + return array( + + 'welcome' => 'Welcome to our website!', + + ); + +Next, you should create a corresponding **marketing.php** file within the **application/lang/sp** directory. The file would look something like this: + + return array( + + 'welcome' => 'Bienvenido a nuestro sitio web!', + + ); + +Nice! Now you know how to get started setting up your language files and directories. Let's keep localizing! + + +### Retrieving A Language Line + +To retrieve a language line, first create a Lang instance using the **line** method, then call the **get** method on the instance: + + echo Lang::line('marketing.welcome')->get(); + +Notice how a dot was used to separate "marketing" and "welcome"? The text before the dot corresponds to the language file, while the text after the dot corresponds to a specific string within that file. + +But, how did the method know which language directory to retrieve the message from? By default, the **get** method will use the language specified in your **application/config/application.php** configuration file. In this file you may set the default language of your application using the **language** option: + + 'language' => 'en' + +Need to retrieve the line in a language other than your default? Not a problem. Just mention the language to the **get** method: + + echo Lang::line('marketing.welcome')->get('sp'); + + +### Place Holders & Replacements + +Now, let's work on our welcome message. "Welcome to our website!" is a pretty generic message. It would be helpful to be able to specify the name of the person we are welcoming. But, creating a language line for each user of our application would be time-consuming and ridiculous. Thankfully, you don't have to. You can specify "place-holders" within your language lines. Place-holders are preceeded by a colon: + + 'welcome' => 'Welcome to our website, :name!' + +Then, simply pass an array of place-holder replacements to the **replace** method on a Lang instance: + + echo Lang::line('marketing.welcome')->replace(array('name' => 'Taylor'))->get(); + +This statement will return a nice, heart-warming welcome message: + + Welcome to our website, Taylor! \ No newline at end of file diff --git a/documentation/session/config.md b/documentation/session/config.md new file mode 100644 index 00000000..1904d40a --- /dev/null +++ b/documentation/session/config.md @@ -0,0 +1,70 @@ + +## Session Configuration + +- [File System Sessions](#file) +- [Database Sessions](#database) +- [Memcached Sessions](#memcached) + +The web is a stateless environment. This means that each request to your application is considered unrelated to any previous request. However, **sessions** allow you to store arbitrary data for each visitor to your application. The session data for each visitor is stored on your web server, while a cookie containing a **session ID** is stored on the visitor's machine. This cookie allows your application to "remember" the session for that user and retrieve their session data on subsequent requests to your application. + +Sound complicated? If so, don't worry about it. Just tell Laravel where to store the sessions and it will take care of the rest. + +Three great session drivers are available out of the box: + +- File System +- Database +- Memcached + + +### File System Sessions + +Most likely, your application will work great using file system sessions. However, if your application receives heavy traffic or runs on a server farm, use database or Memcached sessions. + +To get started using file system sessions, just set the driver option in the **application/config/session.php** file: + + 'driver' => 'file' + +That's it. You're ready to go! + +> **Note:** File system sessions are stored in the **application/storage/sessions** directory, so make sure it's writeable. + + +### Database Sessions + +To start using database sessions, you will first need to [configure your database connection](/docs/database/config). + +Already setup your database? Nice! Next, you will need to create a session table. Here are some SQL statements to help you get started: + +#### SQLite + + CREATE TABLE "sessions" ( + "id" VARCHAR PRIMARY KEY NOT NULL UNIQUE, + "last_activity" INTEGER NOT NULL, + "data" TEXT NOT NULL + ); + +#### MySQL + + CREATE TABLE `sessions` ( + `id` VARCHAR(40) NOT NULL, + `last_activity` INT(10) NOT NULL, + `data` TEXT NOT NULL, + PRIMARY KEY (`id`) + ); + +If you would like to use a different table name, simply change the **table** option in the **application/config/session.php** file: + + 'table' => 'sessions' + +Great! All you need to do now is set the driver in the **application/config/session.php** file: + + 'driver' => 'db' + + +### Memcached Sessions + +Before using Memcached sessions, you must [configure your Memcached servers](/docs/cache/config#memcached). + +All done? Great! Just set the driver in the **application/config/session.php** file: + + 'driver' => 'memcached' \ No newline at end of file diff --git a/documentation/session/usage.md b/documentation/session/usage.md new file mode 100644 index 00000000..5e76a7dd --- /dev/null +++ b/documentation/session/usage.md @@ -0,0 +1,59 @@ +## Session Usage + +- [Storing Items](#put) +- [Retrieving Items](#get) +- [Removing Items](#forget) +- [Regeneration](#regeneration) + + +### Storing Items + +Storing items in the session is a breeze. Simply call the put method on the Session class: + + Session::put('name', 'Taylor'); + +The first parameter is the **key** to the session item. You will use this key to retrieve the item from the session. The second parameter is the **value** of the item. + +Need to store an item in the session that should expire after the next request? Check out the **flash** method. It provides an easy way to store temporary data like status or error messages: + + Session::flash('status', 'Welcome Back!'); + + +### Retrieving Items + +Retrieving items from the session is no problem. You can use the **get** method on the Session class to retrieve any item in the session, including flash data. Just pass the key of the item you wish to retrieve: + + $name = Session::get('name'); + +By default, NULL will be returned if the session item does not exist. However, you may pass a default value as a second parameter to the get method: + + $name = Session::get('name', 'Fred'); + + $name = Session::get('name', function() {return 'Fred';}); + +Now, "Fred" will be returned if the "name" item does not exist in the session. + +Laravel even provides a simple way to determine if a session item exists using the **has** method: + + if (Session::has('name')) + { + $name = Session::get('name'); + } + + +### Removing Items + +Need to get rid of a session item? No problem. Just mention the name of the item to the **forget** method on the Session class: + + Session::forget('name'); + +You can even remove all of the items from the session using the **flush** method: + + Session::flush(); + + +### Regeneration + +Sometimes you may want to "regenerate" the session ID. This simply means that a new, random session ID will be assigned to the session. Here's how to do it: + + Session::regenerate(); \ No newline at end of file diff --git a/documentation/start/config.md b/documentation/start/config.md new file mode 100644 index 00000000..0051cfa8 --- /dev/null +++ b/documentation/start/config.md @@ -0,0 +1,78 @@ +## Basic Configuration + +- [Quick Start](#quick) +- [Cleaner URLs](#clean) +- [Errors & Logging](#errors) + + +### Quick Start + +When starting a new project, you shouldn't be bombarded with loads of confusing configuration decisions. For that reason, Laravel is intelligently configured out of the box. The **application/config/application.php** file contains the basic configuration options for your application. + +There is only one option that **must** be set when starting a new application. Laravel needs to know the URL you will use to access your application. Simply set the url in the **application/config/application.php** file: + + 'url' => 'http://localhost'; + +> **Note:** If you are using mod_rewrite, you should set the index option to an empty string. + + +### Cleaner URLs + +Most likely, you do not want your application URLs to contain "index.php". You can remove it using HTTP rewrite rules. If you are using Apache to serve your application, make sure to enable mod_rewrite and create a **.htaccess** file like this one in your **public** directory: + + + RewriteEngine on + + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + + RewriteRule ^(.*)$ index.php/$1 [L] + + +Is the .htaccess file above not working for you? Try this one: + + Options +FollowSymLinks + RewriteEngine on + + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + + RewriteRule . index.php [L] + +After setting up HTTP rewriting, you should set the **index** configuration option in **application/config/application.php** to an empty string. + +> **Note:** Each web server has a different method of doing HTTP rewrites, and may require a slightly different .htaccess file. + + +### Errors & Logging + +- [404 Errors](#error-404) +- [Error Detail](#error-detail) +- [Logging](#error-logging) + + +#### 404 Errors + +When a request is made to your application that cannot be matched to a route, the 404 error view will be sent to the browser. This view lives in **application/views/error/404.php** and you are free to modify it however you wish. + + +#### Error Detail + +You can easily control the level of error detail via the **detail** option in the **application/config/errors.php** file. + + 'detail' => true; + +When set to **true**, error messages will be detailed with a stack trace and snippet of the relevant file. When set to **false**, the generic error page (**application/views/error/500.php**) will be displayed. Feel free to modify this view. + +> **Note:** In a production environment, it is strongly suggested that you turn off error details. + + +#### Logging + +You may wish to log any errors that occur in your application. Laravel makes it a breeze. You can turn on logging by setting the log option to **true** in the **application/config/errors.php** file: + + 'log' => true; + +You have total control over how your errors are logged via the **logger** function defined in **application/config/error.php**. This function is called every time there is an unhandled error or exception in your application. + +As you can see, the default logger implementation writes to the **application/storage/log.txt** file; however, you are free to modify this function however you wish. \ No newline at end of file diff --git a/documentation/start/install.md b/documentation/start/install.md new file mode 100644 index 00000000..30fb6fd4 --- /dev/null +++ b/documentation/start/install.md @@ -0,0 +1,27 @@ +## Requirements & Installation + +### Requirements + +- Apache, nginx, or another compatible web server. +- PHP 5.3+. + +### Installation + +1. [Download Laravel](https://github.com/taylorotwell/laravel/zipball/master) +2. Extract the Laravel archive and upload the contents to your web server. +4. Set the URL of your application in the **application/config/application.php** file. +5. Navigate to your application in a web browser. + +If all is well, you should see a pretty Laravel splash page. Get ready, there is lots more to learn! + +### Extras + +Installing the following goodies will help you take full advantage of Laravel, but they are not required: + +- SQLite, MySQL, or PostgreSQL PDO drivers. +- [Memcached](http://memcached.org) or APC. + +### Problems? + +- Make sure the **public** directory is the document root of your web server. +- If you are using mod_rewrite, set the **index** option in **application/config/application.php** to an empty string. \ No newline at end of file diff --git a/documentation/start/interaction.md b/documentation/start/interaction.md new file mode 100644 index 00000000..14312823 --- /dev/null +++ b/documentation/start/interaction.md @@ -0,0 +1,232 @@ +## Interaction + +- [Input](/docs/start/interaction#basics) +- [Old Input](/docs/start/interaction#old) +- [Cookies](/docs/start/interaction#cookies) +- [Building Forms](/docs/start/interaction#forms) + +All web applications receive input via HTTP requests. The input can be sent to your application via any of the four HTTP verbs: **GET**, **POST**, **PUT**, or **DELETE**. Input can also be sent to your application via cookies, which can store small amounts of information and are stored on the user's computer. + +Let's dig into the classes Laravel provides for working with user input! + +> **Note:** Laravel doesn't mess with your query strings. Feel free to use them. + + +## Input + +The **Input** class handles input that comes into your application via GET, POST, PUT, or DELETE requests. Retrieving input using the Input class is effortless. Just use the **get** method: + + $email = Input::get('email'); + +> **Note:** The get method is used for all request types, not just GET requests. You may use it on POST, PUT, and DELETE requests as well. + +By default, NULL will be returned if the input item does not exist. However, you may pass a different default value as a second parameter to the method: + + $name = Input::get('name', 'Fred'); + +Now, "Fred" will be returned if the "name" input item does not exist. You may even pass a closure as a default value: + + $name = Input::get('name', function() {return 'Fred';}); + +Need to determine if an input item exists? Use the **has** method: + + if (Input::has('name')) + { + $name = Input::get('name'); + } + +> **Note:** The **has** method will return **false** if the input item exists but is an empty string. + +Need to access the **$_FILES** array? It's easy using the **file** method: + + $picture = Input::file('picture'); + + $size = Input::file('picture.size'); + +Sometimes you may need to merge the input and $_FILES array. Check out the **all** method: + + $input = Input::all(); + + +## Old Input + +Have you ever tried to re-populate an input form after an invalid form submission? It can get pretty clunky. Not in Laravel. You can easily retrieve the input from the previous request using the **old** method on the Input class: + + $name = Input::old('name'); + +> **Note:** You must specifiy a session driver before using the **old** Input method. + +As you would expect, you may pass a default value in the second parameter to the method: + + $name = Input::old('name', 'Fred'); + +Once again, there is a simple way to determine if an old input item exists using the **had** method: + + if (Input::had('name')) + { + $name = Input::old('name'); + } + + +## Cookies + +The **Cookie** class provides simple functions for retrieving, setting, and deleting cookies. + +To retrieve a cookie value, simply mention its name to the **get** method: + + $name = Cookie::get('name'); + +Of course, just like the Input class, you may pass a default value in the second parameter to the **get** method: + + $name = Cookie::get('name', 'Fred'); + +Also just like the Input class, the Cookie class has a simple method to determine if a cookie exists: + + if (Cookie::has('name')) + { + $name = Cookie::get('name'); + } + +Need to create a cookie? No problem. Check out the **put** method: + + Cookie::put('name', 'Fred', 60); + +The put method accepts almost the exact same parameters as the PHP setcookie method. However, just pass the number of **minutes** you want the cookie to live as the third parameter. You don't have to worry about any clunky expiration date calculations. + +If you need to create a "permanent" cookie, try the **forever** method. It creates a cookie that lives for five years: + + Cookie::forever('name', 'Fred'); + +To delete a cookie, use the **forget** method: + + Cookie::forget('name'); + + +## Building Forms + +- [Opening A Form](#form-open) +- [CSRF Protection](#form-csrf) +- [Labels](#form-labels) +- [Text, Text Area, Password & Hidden Fields](#form-text) +- [Checkboxes & Radio Buttons](#form-check) +- [Drop-Down Lists](#form-lists) +- [Buttons](#form-buttons) + +Almost every web application receives input through HTML forms. As you have probably already learned, Laravel is here to make your life easier. That's why generating forms using the **Form** class is a breeze. + +> **Note:** All input data displayed in elements generated by the **Form** class is filtered through the HTML::entities method. + + +### Opening A Form + +Opening a form is simple. Just call the **open** method on the Form class: + + echo Form::open(); + +When called without any parameters, the open method will create a form that will POST to the current URL. However, you'll probably want to point your forms to other URLs too. No problem. Just mention the URL to the method. You can even specify the request method (GET, POST, PUT, or DELETE) in the second parameter to the method: + + echo Form::open('user/profile', 'PUT'); + +Need to apply a class or other attribute to the form tag generated by the open method? Simply pass an array of attributes as a third parameter: + + echo Form::open('user/profile', 'PUT', array('class' => 'awesome')); + +> **Note:** The open method automatically prepares your form to receive UTF-8 input. + +Need a form that can handle file uploads? Use the **open_for_files** method: + + echo Form::open_for_files('user/profile'); + + +### CSRF Protection + +Laravel provides an easy method of protecting your application from [cross-site request forgeries](http://en.wikipedia.org/wiki/Cross-site_request_forgery). First, a random token is placed in your user's session. Don't sweat it, this is done automatically. Next, use the **token** method to generate a hidden form input field containing the random token on your form: + + echo Form::token(); + +Now, simply [attach the built-in CSRF filter](/docs/start/routes#filters) to the route the form is posting to. If the token submitted by the form does not match the token in the user's session, the **application/views/error/500.php** view will be displayed. + +Want to just get the CSRF token without generating a hidden input field? Use the **raw_token** method: + + echo Form::raw_token(); + +> **Note:** Don't forget to [specify a session driver](/docs/session/config) before using these methods. + + +### Labels + +Need to generate a label for a form element? It's simple using the **label** method. Just pass the label name and display value to the method: + + echo Form::label('email', 'E-Mail Address'); + +Of course, you may pass any attributes you wish in the third parameter to the method: + + echo Form::label('email', 'E-Mail Address', array('class' => 'awesome')); + +> **Note:** After creating a label, any form element you create with a name matching the label name will automatically receive an ID matching the label name as well. + + +### Text, Text Area, Password & Hidden Fields + +Generating text boxes couldn't be easier. Just call the **text** method on the Form class and mention the name of the field: + + echo Form::text('username'); + +Already have a value you want to put in the text box? Throw it in as a second parameter: + + echo Form::text('email', 'example@gmail.com'); + +Again, any other attributes you wish to apply to the text box may be passed in an array as the third parameter: + + echo Form::text('email', 'example@gmail.com', array('class' => 'awesome')); + +> **Note:** The **password**, **hidden**, and **textarea** methods have the same signature as the text method. You just learned four methods for the price of one! + + +### Checkboxes & Radio Buttons + +What website doesn't have a checkbox? Actually, this one doesn't! But, thankfully, generating them is simple using the **checkbox** method on the Form class. Just give the checkbox a name and a value: + + echo Form::checkbox('remember', 'yes'); + +Of course, the example above will generate the following HTML: + + + +Need to generate a "checked" checkbox? No problem. Simply pass **true** as the third parameter to the method: + + echo Form::checkbox('remember', 'yes', true); + +As always, you may specify any extra attributes that should be applied to the checkbox. Pass them as the fourth parameter to the method: + + echo Form::checkbox('remember', 'yes', true, array('class' => 'awesome')); + +> **Note:** The **radio** method has the same signature as the checkbox method. Two for one! + + +### Drop-Down Lists + +Generating drop-down lists can be a headache. Thankfully, Laravel makes it refreshingly simple using the **select** method on the Form class. All you need to do is give your list a name and an array of options: + + echo Form::select('size', array('L' => 'Large', 'S' => 'Small')); + +If you wish to set the selected item, just pass the value as the third parameter to the method: + + echo Form::select('size', array('L' => 'Large', 'S' => 'Small'), 'S'); + +You may specify any other attributes that should be applied to the list in the fourth parameter to the method: + + echo Form::select('size', array('L' => 'Large', 'S' => 'Small'), 'S', array('class' => 'awesome')); + + +### Buttons + +Creating a submit button is a cinch. Use the **submit** method on the Form class: + + echo Form::submit('Click Me!'); + +Again, any other attributes that should be applied to the button may be passed to the method: + + echo Form::submit('Click Me!', array('class' => 'awesome')); + +> **Note:** Need to create a button element? Try the **button** method. It has the same signature as submit. \ No newline at end of file diff --git a/documentation/start/routes.md b/documentation/start/routes.md new file mode 100644 index 00000000..6bcdcea7 --- /dev/null +++ b/documentation/start/routes.md @@ -0,0 +1,124 @@ +## Routes + +- [Defining Routes](/docs/start/routes#define) +- [Wildcard URI Segments](/docs/start/routes#segments) +- [Named Routes](/docs/start/routes#named) +- [Route Filters](/docs/start/routes#filters) +- [Organizing Routes](/docs/start/routes#organize) + +Unlike other PHP frameworks, Laravel places routes and their corresponding functions in one file: **application/routes.php**. This file contains the "definition", or public API, of your application. To add functionality to your application, you add to the array located in this file. It's a breeze. + + +## Defining Routes + +All you need to do is tell Laravel the request methods and URIs it should respond to. You define the behavior of the route using an anonymous method: + + 'GET /home' => function() + { + // Handles GET requests to http://example.com/index.php/home + }, + + +You can easily define a route to handle requests to more than one URI. Just use commas: + + 'POST /, POST /home' => function() + { + // Handles POST requests to http://example.com and http://example.com/home + } + +> **Note:** The routes.php file replaces the "controllers" found in most frameworks. Have a fat model and keep this file light and clean. Thank us later. + + +## Wildcard URI Segments + +Laravel makes matching wildcard URI segments a breeze using the **(:num)** and **(:any)** place-holders. Check out these routes: + + 'PUT /user/(:num)' => function($id) {} + + 'DELETE /user/(:any)' => function($username) {} + +Laravel will automatically pass the value of the wildcard segment into your route function. + +> **Note:** The **(:any)** place-holder matches letters, number, dashes, and underscores. + +Want to make an URI segment optional? No problem. Just put a **?** in the place-holder: + + 'GET /download/(:any?)' => function($branch = 'master') {} + +If you need more power and precision (or just want to be extra nerdy), you can even use regular expressions: + + 'GET /product/([0-9]+)' => function($id) {} + + +## Named Routes + +Once you start using named routes, you won't be able to live without them. They are that great. Here's how to do it: + + 'GET /user/login' => array('name' => 'login', 'do' => function() {}) + +Notice the route now has an array value with two keys: **name** and **do**. As you learned while studying filters, the **do** value is the method that will be executed by the route. As you have probably guessed, the **name** value is the name of the route. + +Now that you have named the route, you can [generate URLs](/docs/start/views#urls) and [perform redirects](/docs/start/views#redirect) using the route name instead of the route URI. This means that you can change the route URI as much as you want and the links to that route on your views will always be correct. It's beautiful, isn't it? + + +## Route Filters + +Filters are methods that run before and after a request to your application. "Before" filters can even halt the request cycle by returning a response, providing an amazingly simple way to implement common tasks like redirecting a user to a login view. Let's dig in. + +All filters are defined in the **application/filters.php** file. Intuitive, right? If you open the file, you will see that four filters have already been defined for you: **before**, **after**, **auth**, and **csrf**. The **before** and **after** filters are the two "global" filters. They are always executed on every request, regardless of the request method or URI. + +All other filters must be attached to individual routes. Don't worry, you'll learn how to do this soon. The built-in **auth** and **csrf** filters handle two scenarios that are common to almost every web application: redirecting users to a login page and protecting against cross-site request forgeries. + +### Defining Filters + +To define your own filter, simply add it to the array in the **application/filters.php** file: + + 'my_filter' => function() + { + return 'Filtered!'; + } + +### Attaching Filters To Routes + +Alright, ready to attach the filter to a route? Do it like this: + + 'GET /user' => array('before' => 'my_filter', 'do' => function() + { + // + }) + +Notice the route now has an array value with two keys: **before** and **do**. The **do** value is the method that will be executed by the route, while the **before** value contains the names of any filters that should be run before the method is executed. + +Why stop with one filter? You can define multiple filters for a single route by separating the filter names with commas: + + 'POST /user' => array('before' => 'auth, csrf', 'do' => function() {}) + +Remember, if a "before" filter returns a value, that value will be considered the output of the request. For example, the built-in **auth** filter checks if the user has logged in to your application. If they haven't, a [Redirect](/docs/start/views#redirect) to the login page is sent to the browser. Isn't the simplicity refreshing? + +Of course, adding filters to run after the request is just as easy: + + 'my_filter' => function($response) {} + + 'GET /user' => array('after' => 'my_filter', 'do' => function() {}) + +> **Note:** "After" filters receive the response returned by the route function that handled the request. + + +## Organizing Routes + +So, you're building the next monolithic web application and your **application/routes.php** file is getting a little cramped? Don't worry, we have you covered. + +Here's what to do. First, create an **application/routes** directory. Great! You're almost there. Now, just add route files to **application/routes** corresponding to the base URIs of your application. So, a **photo.php** file within **application/routes** would handle all requests to URIs beginning with **/photo**. Similarly, a **user.php** file handles all requests to URIs beginning with **/user**. For example, check out this **user.php** file: + + function($id) + { + return View::make('user/profile'); + } + + ); + +The **application/routes.php** file will continue to be loaded on every request, so any "catch-all" routes can still be placed in that file. The **application/routes.php** file should also still contain the route for the root of your application. \ No newline at end of file diff --git a/documentation/start/validation.md b/documentation/start/validation.md new file mode 100644 index 00000000..17efcd10 --- /dev/null +++ b/documentation/start/validation.md @@ -0,0 +1,368 @@ +## Validation + +- [The Basics](#basics) +- [Validation Rules](#rules) +- [Retrieving Error Messages](#errors) +- [Specifying Custom Error Messages](#messages) +- [Creating Custom Validation Rules](#custom) + + +### The Basics + +Almost every interactive web application needs to validate data. For instance, a registration form probably requires the password to be confirmed. Maybe the e-mail address must be unique. Validating data can be a cumbersome process. Thankfully, it isn't in Laravel. The **Validator** class provides as awesome array of validation helpers to make validating your data a breeze. + +To get started, let's imagine we have the following array: + + $array = array('name' => 'Taylor', 'email' => 'example@gmail.com'); + +Next, we're ready to define [validation rules](#rules) for our array: + + $rules = array( + 'name' => array('required', 'max:50'), + 'email' => array('required', 'email', 'unique:users'), + ); + +If you don't like using arrays, you may also delimit rules using a pipe character: + + $rules = array( + 'name' => 'required|max:50', + 'email' => 'required|email|unique:users', + ); + +Great! Now we're ready to make a **Validator** instance and validate our array: + + $validator = Validator::make($array, $rules); + + if ( ! $validator->valid()) + { + return $validator->errors; + } + +Via the **errors** property, you can access a simple error collector class that makes working with your error messages a breeze. Of course, default error messages have been setup for all validation rules. The default messages live in the **application/lang/en/validation.php** file. + +Now you are familiar with the basic usage of the Validator class. You're ready to dig in and learn about the rules you can use to validate your data! + + +### Validation Rules + +- [Required](#rule-required) +- [Alpha, Alpha Numeric, & Alpha Dash](#rule-alphas) +- [Size](#rule-size) +- [Numericality](#rule-numeric) +- [Inclusion & Exclusion](#rule-inclusion) +- [Confirmation](#rule-confirmed) +- [Acceptance](#rule-accepted) +- [Uniqueness](#rule-unique) +- [E-Mail Addresses](#rule-email) +- [URLs](#rule-urls) +- [Uploads](#rule-uploads) + + +#### Required + +The **required** rule validates that an attribute is present in the array and is not an empty string: + + $rules = array( + 'name' => 'required', + ); + + +#### Alpha, Alpha Numeric, & Alpha Dash + +The **alpha** rule validates that an attribute consists solely of letters: + + $rules = array( + 'name' => 'alpha', + ); + +The **alpha_num** rule validates that an attribute consists solely of letters and numbers: + + $rules = array( + 'username' => 'alpha_num', + ); + +The **alpha_dash** rule validates that an attribute consists solely of letters, numbers, dashes, and underscores: + + $rules = array( + 'username' => 'alpha_dash', + ); + + +#### Size + +The **size** rule validates that an attribute is of a given length, or, if the attribute is numeric, is a given value: + + $rules = array( + 'name' => 'size:10', + ); + +The **between** rule validates that an attribute is between a given minimum and maximum: + + $rules = array( + 'payment' => 'between:10,50', + ); + +> **Note:** All minimum and maximum checks are inclusive. + +The **min** rule validates that an attribute is greater than or equal to a given value: + + $rules = array( + 'payment' => 'min:10', + ); + +The **max** rule validates that an attribute is less than or equal to a given value: + + $rules = array( + 'payment' => 'max:50', + ); + + +#### Numericality + +The **numeric** rule validates that an attribute is (surprise!) numeric: + + $rules = array( + 'payment' => 'numeric', + ); + +The **integer** rule validates that an attribute is an integer: + + $rules = array( + 'payment' => 'integer', + ); + + +#### Inclusion & Exclusion + +The **in** rule validates that an attribute is contained in a list of values: + + $rules = array( + 'size' => 'in:small,medium,large', + ); + +The **not_in** rule validates that an attribute is not contained in a list of values: + + $rules = array( + 'language' => 'not_in:cobol,assembler', + ); + + +#### Confirmation + +The **confirmed** rule validates that, for a given attribute, a matching **attribute_confirmation** attribute exists. For example, given the following rule: + + $rules = array( + 'password' => 'confirmed', + ); + +The Validator will make sure that the **password** attribute matches the **password_confirmation** attribute in the array being validated. + + +#### Acceptance + +The **accepted** rule validates that an attribute is equal to **yes** or **1**. This rule is helpful for validating checkbox form fields such as "terms of service". + + $rules = array( + 'terms' => 'accepted', + ); + + +#### Uniqueness + +The **unique** rule validates the uniqueness of an attribute on a given database table: + + $rules = array( + 'email' => 'unique:users', + ); + +In the example above, the **email** attribute will be checked for uniqueness on the **users** table. Need to verify uniqueness on a column name other than the attribute name? No problem: + + $rules = array( + 'email' => 'unique:users,email_address', + ); + + +#### E-Mail Addresses + +The **email** rule validates that an attribute contains a correctly formatted e-mail address: + + $rules = array( + 'email' => 'email', + ); + + +#### URLs + +The **url** rule validates that an attribute contains a correctly formatted URL: + + $rules = array( + 'link' => 'url', + ); + +The **active_url** rule uses the PHP **checkdnsrr** function to verify that a URL is active: + + $rules = array( + 'link' => 'active_url', + ); + + +#### Uploads + +The **mimes** rule validates that an uploaded file has a given MIME type. This rule uses the PHP Fileinfo extension to read the contents of the file and determine the actual MIME type. Any extension defined in the **application/config/mimes.php** file may be passed to this rule as a parameter: + + $rules = array( + 'picture' => 'mimes:jpg,gif', + ); + + $validator = Validator::make(Input::file(), $rules); + +Need to validate form data and upload data at the same time? Use the **all** method on the **Input** class to get form and upload data in one array: + + $validator = Validator::make(Input::all(), $rules); + +The **image** rule validates that an uploaded file has a **jpg**, **gif**, **bmp**, or **png** MIME type: + + $rules = array( + 'picture' => 'image', + ); + +You may also validate the size of an upload using the **max** rule. Simply specify the maximum number of **kilobytes** the upload may be: + + $rules = array( + 'picture' => 'image|max:100', + ); + + +### Retrieving Error Messages + +Laravel makes working with your error messages a cinch using a simple error collector class. After calling the **valid** or **invalid** method on a **Validator** instance, you may access the errors via the **errors** property: + + if ( ! $validator->valid()) + { + return $validator->errors; + } + +The error collector has the following simple functions for retrieving your error messages: **has**, **first**, **get**, and **all**. + +The **has** method will check if an error message exists for a given attribute: + + if ($validator->errors->has('email')) + { + // The e-mail attribute has errors... + } + +The **first** method will return the first error message for a given attribute: + + echo $validator->errors->first('email'); + +Sometimes you may need to format the error message by wrapping it in HTML. No problem. Along with the **:message** place-holder, pass the format as the second parameter to the method: + + echo $validator->errors->first('email', '

:message

'); + +The **get** method returns an array containing all of the error messages for a given attribute: + + return $validator->errors->get('email'); + + return $validator->errors->get('email', '

:message

'); + +The **all** method returns an array containing all error messages for all attributes: + + return $validator->errors->all(); + + return $validator->errors->all('

:message

'); + + +### Specifying Custom Error Messages + +Want to use an error message other than the default? Maybe you even want to use a custom error message for a given attribute and rule. Either way, the **Validator** class makes it easy. + +Simply create an array of custom messages to pass to the Validator instance: + + $messages = array( + 'required' => 'The :attribute field is required.', + ); + + $validator = Validator::make(Input::get(), $rules, $messages); + +Great! Now our custom message will be used anytime a **required** validation check fails. But, what is this **:attribute** stuff in our message? To make your life easier, the Validator class will replace the **:attribute** place-holder with the actual name of the attribute! It will even remove underscores from the attribute name. + +You may also use the **:size**, **:min**, **:max**, and **:values** place-holders when constructing your error messages: + + $messages = array( + 'size' => 'The :attribute must be exactly :size.', + 'between' => 'The :attribute must be between :min - :max.', + 'in' => 'The :attribute must be one of the following types: :values', + ); + +So, what if you need to specify a custom **required** message, but only for the **email** attribute? No problem. Just specify the message using an **attribute_rule** naming convention: + + $messages = array( + 'email_required' => 'We need to know your e-mail address!', + ); + +In the example above, the custom required message will be used for the **email** attribute, while the default message will be used for all other attributes. + + +### Creating Custom Validation Rules + +Need to create your own validation rules? You will love how easy it is! First, create a class that extends **System\Validator** and place it in your **application/libraries** directory: + + 'required|awesome', + ); + +Of course, you will need to define an error message for your new rule. You can do this either in an ad-hoc messages array: + + $messages = array( + 'awesome' => 'The attribute value must be awesome!', + ); + + $validator = Validator::make(Input::get(), $rules, $messages); + +Or by adding an entry for your rule in the **application/lang/en/validation.php** file: + + 'awesome' => 'The attribute value must be awesome!', + +As mentioned above, you may even specify and receive a list of parameters in your custom validator: + + // When building your rules array... + + $rules = array( + 'username' => 'required|awesome:yes', + ); + + // In your custom validator... + + class Validator extends System\Validator { + + public function validate_awesome($attribute, $parameters) + { + return $attribute = $parameters[0]; + } + + } + +In this case, the **parameters** argument of your validation rule would receive an array containing one element: "yes". \ No newline at end of file diff --git a/documentation/start/views.md b/documentation/start/views.md new file mode 100644 index 00000000..398423db --- /dev/null +++ b/documentation/start/views.md @@ -0,0 +1,379 @@ +## Views & Responses + +- [Creating Views](/docs/start/views#create) +- [Binding Data To Views](/docs/start/views#bind) +- [Nesting Views Within Views](/docs/start/views#nest) +- [Redirects](/docs/start/views#redirect) +- [Downloads](/docs/start/views#downloads) +- [Building URLs](/docs/start/views#urls) +- [Building HTML](/docs/start/views#html) + + +## Creating Views + +Typically, a route function returns a **View**. Views consist of plain ole' HTML and are stored in your **application/views** directory. + +A very simple view file could look like this: + + + Welcome to my website! + + +Assuming this view lives in **application/views/simple.php**, we could return it from a route like so: + + 'GET /home' => function() + { + return View::make('simple'); + } + +When building a large application, you may want to organize your views into sub-directories. That's a great idea! Assuming a view lives in **application/views/user/login.php**, we could return it like so: + + 'GET /home' => function() + { + return View::make('user/login'); + } + +It's that simple. Of course, you are not required to return a View. Strings are also welcome: + + 'GET /home' => function() + { + return json_encode('This is my response!'); + } + + +## Binding Data To Views + +You can pass data to a view by "binding" the data to a variable. This is done using the **bind** method on the View: + + 'GET /home' => function() + { + return View::make('simple')->bind('email', 'example@gmail.com'); + } + +In the example above, the first parameter is the **name** of the view variable. The second parameter is the **value** that will be assigned to the variable. + +Now, in our view, we can access the e-mail address like so: + + + + + +Of course, we can bind as many variables as we wish: + + 'GET /home' => function() + { + return View::make('simple') + ->bind('name', 'Taylor') + ->bind('email', 'example@gmail.com'); + } + +You may also bind view data by simply setting properties on a view instance: + + 'GET /home' => function() + { + $view = View::make('user/login'); + + $view->name = 'Taylor'; + $view->email = 'example@gmail.com'; + + return $view; + } + + +## Nesting Views Within Views + +Want to nest views inside of views? There are two ways to do it, and they are both easy. First, you can bind the view to a variable: + + 'GET /home' => function() + { + $view = View::make('user/login'); + + $view->content = View::make('partials/content'); + $view->footer = View::make('partials/footer'); + + return $view; + } + +Or, you can get the string content of a view using the **get** method: + + + get(); ?> + get(); ?> + + + +## Redirects + +### Redirect Using URIs + +You will often need to redirect the browser to another location within your application. The **Redirect** class makes this a piece of cake. Here's how to do it: + + 'GET /redirect' => function() + { + return Redirect::to('user/profile'); + } + +Of course, you can also redirect to the root of your application: + + return Redirect::to('/'); + +Need to redirect to a URI that should be accessed over HTTPS? Check out the **to_secure** method: + + return Redirect::to_secure('user/profile'); + +You can even redirect the browser to a location outside of your application: + + return Redirect::to('http://www.google.com/'); + + +### Redirect Using Named Routes + +So far we've created redirects by specifying a URI to redirect to. But, what if the URI to the user's profile changes? It would be better to create a redirect based on the [route name](/docs/start/routes#named). Let's learn how to do it. Assuming the user profile route is named **profile**, you can redirect to the route using a dynamic, static method call like this: + + return Redirect::to_profile(); + +Need to redirect to a route that should be accessed over HTTPS? No problem: + + return Redirect::to_secure_profile(); + +That's great! But, what if the route URI looks like this: + + 'GET /user/profile/(:any)/(:any)' => array('name' => 'profile', 'do' => function() + { + // + }) + +You need to redirect to the named route, but you also need to replace the **(:any)** place-holders in the URI with actual values. It sounds complicated, but Laravel makes it a breeze. Just pass the parameters to the method in an array: + + return Redirect::to_profile(array('taylor', 'otwell')); + +The statement above will redirect the user to the following URL: + + http://example.com/index.php/user/profile/taylor/otwell + + +### Redirect With Flash Data + +After a user creates an account or signs into your application, it is common to display a welcome or status message. But, how can you set the status message so it is available for the next request? The **Response** and **Redirect** classes make it simple using the **with** method. This method will add a value to the Session flash data, which will be available for the next request: + + return Redirect::to('user/profile')->with('status', 'Welcome Back!'); + +> **Note:** For more information regarding Sessions and flash data, check out the [Session documentation](/docs/session/config). + + +## Downloads + +Perhaps you just want to force the web browser to download a file? Check out the **download** method on the **File** class: + + 'GET /file' => function() + { + return File::download('path/to/your/file.jpg'); + } + +In the example above, the image will be downloaded as "file.jpg", however, you can easily specify a different filename for the download in the second parameter to the method: + + 'GET /file' => function() + { + return File::download('path/to/your/file.jpg', 'photo.jpg'); + } + + +## Building URLs + +- [Generating URLs Using URIs](#uri-urls) +- [Generating URLs Using Named Routes](#named-urls) +- [URL Slugs](#url-slugs) + +While developing your application, you will probably need to generate a large number of URLs. Hard-coding your URLs can cause headaches if you switch domains or application locations. Nobody wants to dig through every view in their application to change URLs. Thankfully, the **URL** class provides some simple methods that allow you to easily generate URLs for your application. + + +### Generating URLs Using URIs + +To generate a URL for your application, use the **to** method on the URL class: + + echo URL::to(); + +The statement above will simply return the URL specified in your **application/config/application.php** file. + +However, this method can also append a specified string to the end of your application URL: + + echo URL::to('user/profile'); + +Now the statement will generate a URL something like this: + + http://example.com/index.php/user/login + +Need to generate a HTTPS URL? No problem. Check out the **to\_secure** method: + + echo URL::to_secure('user/profile'); + +Often, you will need to generate URLs to assets such as images, scripts, or styles. You don't want "index.php" inserted into these URLs. So, use the **to_asset** method: + + echo URL::to_asset('img/picture.jpg'); + + +### Generating URLs To Named Routes + +Alright, you have learned how to generate URLs from URIs, but what about from named routes? You can do it by making a dynamic, static method call to the URL class. The syntax is beautiful: + + echo URL::to_profile(); + +Have a route that needs to be accessed over HTTPS? No problem: + + echo URL::to_secure_profile(); + +Could it get any easier? Now, imagine a route that is defined like this: + + 'GET /user/profile/(:any)/(:any)' => array('name' => 'profile', 'do' => function() + { + // + }) + +To generate a URL for the route, you need to replace the **(:any)** place-holders with actual values. It's easy. Just pass the parameters to the method in an array: + + echo URL::to_profile(array('taylor', 'otwell')); + +The method above will generate the following URL: + + http://example.com/index.php/user/profile/taylor/otwell + +If you don't want to use dynamic methods, you can simply call the **to_route** method: + + echo URL::to_route('profile', array('taylor', 'otwell')); + + +### URL Slugs + +When writing an application like a blog, it is often necessary to generate URL "slugs". Slugs are URL friendly strings of text that represent something like a blog post title. Generating slugs is a piece of cake using the **slug** method: + + echo URL::slug('My blog post title!'); + +The statement above will return the following string: + + my-blog-post-title + +Want to use a different separator character? Just mention it to the method: + + echo URL::slug('My blog post title!', '_'); + + +## Building HTML + +- [Entities](#html-entities) +- [JavaScript & Style Sheets](#html-styles) +- [Links](#html-links) +- [Links To Named Routes](#html-route-links) +- [Mail-To Links](#html-mailto) +- [Images](#html-images) +- [Lists](#html-lists) + +Need some convenient methods that make writing HTML a little less painful? Introducing the **HTML** class. Enjoy. + + +### Entities + +When displaying user input in your Views, it is important to convert all characters which have signifance in HTML to their "entity" representation. + +For example, the < symbol should be converted to its entity representation. Converting HTML characters to their entity representation helps protect your application from cross-site scripting. Thankfully, using the **entities** method on the HTML class, it's easy to add this layer of protection to your Views: + + echo HTML::entities(''); + + +### JavaScript & Style Sheets + +What trendy web application doesn't use JavaScript? Generating a reference to a JavaScript file is as simple using the **script** method. + + echo HTML::script('js/scrollTo.js'); + +Referencing cascading style sheets is just as simple. Check out the **style method**: + + echo HTML::style('css/common.css'); + +Need to specify a media type on your style sheet? No problem. Just pass it in the second parameter to the method: + + echo HTML::style('css/common.css', 'print'); + +> **Note:** All scripts and stylesheets should live in the **public** directory of your application. + + +### Links + +Generating links couldn't be easier. Just mention the URL and title to the **link** method: + + echo HTML::link('user/profile', 'User Profile'); + +Need to generate a link to a URL that should be accessed over HTTPS? Use the **secure_link** method: + + echo HTML::secure_link('user/profile', 'User Profile'); + +Of course, you may generate links to locations outside of your application: + + echo HTML::link('http://www.google.com', 'Search the Intrawebs!'); + +Any other attributes that should be applied to the link may be passed in the third parameter to the method: + + echo HTML::link('http://www.google.com', 'Search the Intrawebs!', array('id' => 'google')); + + +### Links To Named Routes + +If you are using [named routes](#routes-named), you use intuitive, expressive syntax to create links to those routes via dynamic methods: + + echo HTML::link_to_login('Login'); + +Or, if you need an HTTPS link: + + echo HTML::link_to_secure_login('Login'); + +Now let's assume the **login** route is defined like this: + + 'GET /login/(:any)' => array('name' => 'login', 'do' => function() {}) + +To generate a link to the route, you need to replace the **(:any)** place-holder with an actual value. It's easy. Just pass the parameters to the method in an array: + + echo HTML::link_to_login(array('user')); + +This statement will generate a link to the following URL: + + http://example.com/login/user + + +### Mail-To Links + +It's great to allow your users to get in touch with you, but you don't want to be bombarded by spam. Laravel doesn't want you to be either. The **mailto** method allows you to create a safe mail-to link that obfuscates your e-mail address: + + echo HTML::mailto('example@gmail.com'); + +Want the link text to be something besides your e-mail address? No problem. Just mention it to the method: + + echo HTML::mailto('example@gmail.com', 'E-Mail Me!'); + +Need to obfuscate an e-mail address but don't want to generate an entire mail-to link? Simply pass the e-mail address to the **email** method: + + echo HTML::email('example@gmail.com'); + + +### Images + +Since you're building a creative application, you will need to include some images. The **image** method makes simple. Just pass the URL and Alt text to the method: + + echo HTML::image('img/smile.jpg', 'A Smiling Face'); + +Like the link method, any other attributes that should be applied to the image may be passed in the third parameter to the method: + + echo HTML::image('img/smile.jpg', 'A Smiling Face', array('id' => 'smile')); + + +### Lists + +Generating HTML lists doesn't have to be a headache. Check out the **ol** method. All it needs is an array of items: + + echo HTML::ol(array('Get Peanut Butter', 'Get Chocolate', 'Feast')); + +As usual, you may specify any other attributes that should be applied to the list: + + echo HTML::ol(array('Get Peanut Butter', 'Get Chocolate', 'Feast'), array('class' => 'awesome')); + +Need an un-ordered list? No problem. Just use the **ul** method: + + echo HTML::ul(array('Ubuntu', 'Snow Leopard', 'Windows')); \ No newline at end of file diff --git a/public/index.php b/public/index.php index 673b7b0c..38576157 100644 --- a/public/index.php +++ b/public/index.php @@ -3,17 +3,12 @@ * Laravel - A clean and classy framework for PHP web development. * * @package Laravel - * @version 1.1.1 + * @version 1.2.0 * @author Taylor Otwell * @license MIT License * @link http://laravel.com */ -// -------------------------------------------------------------- -// Set the framework starting time. -// -------------------------------------------------------------- -define('LARAVEL_START', microtime(true)); - // -------------------------------------------------------------- // Define the framework paths. // -------------------------------------------------------------- @@ -29,9 +24,10 @@ define('PACKAGE_PATH', APP_PATH.'packages/'); define('EXT', '.php'); // -------------------------------------------------------------- -// Load the configuration class. +// Load the classes used by the auto-loader. // -------------------------------------------------------------- require SYS_PATH.'config'.EXT; +require SYS_PATH.'arr'.EXT; // -------------------------------------------------------------- // Register the auto-loader. @@ -39,9 +35,11 @@ require SYS_PATH.'config'.EXT; spl_autoload_register(require SYS_PATH.'loader'.EXT); // -------------------------------------------------------------- -// Set the error reporting level. +// Set the error reporting and display levels. // -------------------------------------------------------------- -error_reporting((System\Config::get('error.detail')) ? E_ALL | E_STRICT : 0); +error_reporting(E_ALL | E_STRICT); + +ini_set('display_errors', 'Off'); // -------------------------------------------------------------- // Register the error handlers. @@ -49,13 +47,15 @@ error_reporting((System\Config::get('error.detail')) ? E_ALL | E_STRICT : 0); set_exception_handler(function($e) { require_once SYS_PATH.'error'.EXT; + System\Error::handle($e); }); set_error_handler(function($number, $error, $file, $line) { require_once SYS_PATH.'error'.EXT; - System\Error::handle(new ErrorException($error, 0, $number, $file, $line)); + + System\Error::handle(new ErrorException($error, $number, 0, $file, $line)); }); register_shutdown_function(function() @@ -63,7 +63,8 @@ register_shutdown_function(function() if ( ! is_null($error = error_get_last())) { require_once SYS_PATH.'error'.EXT; - System\Error::handle(new ErrorException($error['message'], 0, $error['type'], $error['file'], $error['line'])); + + System\Error::handle(new ErrorException($error['message'], $error['type'], 0, $error['file'], $error['line'])); } }); @@ -77,7 +78,7 @@ date_default_timezone_set(System\Config::get('application.timezone')); // -------------------------------------------------------------- if (System\Config::get('session.driver') != '') { - System\Session::load(); + System\Session::load(System\Cookie::get('laravel_session')); } // -------------------------------------------------------------- @@ -85,28 +86,14 @@ if (System\Config::get('session.driver') != '') // -------------------------------------------------------------- $response = System\Route\Filter::call('before', array(), true); -// -------------------------------------------------------------- -// Only execute the route function if the "before" filter did -// not override by sending a response. -// -------------------------------------------------------------- +// ---------------------------------------------------------- +// Execute the route function. +// ---------------------------------------------------------- if (is_null($response)) { - // ---------------------------------------------------------- - // Route the request to the proper route. - // ---------------------------------------------------------- $route = System\Router::route(Request::method(), Request::uri()); - // ---------------------------------------------------------- - // Execute the route function. - // ---------------------------------------------------------- - if ( ! is_null($route)) - { - $response = $route->call(); - } - else - { - $response = System\Response::make(View::make('error/404'), 404); - } + $response = (is_null($route)) ? System\Response::make(View::make('error/404'), 404) : $route->call(); } else { @@ -134,4 +121,4 @@ if (System\Config::get('session.driver') != '') // -------------------------------------------------------------- // Send the response to the browser. // -------------------------------------------------------------- -$response->send(); +$response->send(); \ No newline at end of file diff --git a/readme.md b/readme.md index 30adf4bc..83f8f632 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,182 @@ # Laravel - A Clean & Classy PHP Framework -### For more information, visit [http://laravel.com](http://laravel.com) +## Introduction -### For complete documentation, visit [http://docs.laravel.com](http://docs.laravel.com) \ No newline at end of file +Laravel is a clean and classy framework for PHP web development. Freeing you from spaghetti code, Laravel helps you create wonderful applications using simple, expressive syntax. Development should be a creative experience that you enjoy, not something that is painful. Enjoy the fresh air. + + +## Table Of Contents + +### Getting Started + +- Requirements & Installation +- Basic Configuration +- Routes +- Views & Responses +- Generating URLs +- Generating HTML +- Errors & Logs + +### Input + +- Retrieving Input +- Cookies +- Validation +- Building Forms + +### Database + +- Configuration +- Usage +- Fluent Query Builder +- Eloquent ORM + +### Caching + +- Configuration +- Usage + +### Sessions + +- Configuration +- Usage + +### Authentication + +- Configuration +- Usage + +### Other Topics + +- Localization +- Encryption + + +## Requirements & Installation + +### Requirements + +- Apache, nginx, or another compatible web server. +- PHP 5.3+ (which supports namespaces, closures, etc.) + +### Installation + +1. Download Laravel +2. Extract the Laravel archive and upload the contents to your web server. +3. Set the URL of your application in the **application/config/application.php** file. +4. Navigate to your application in a web browser. + +If all is well, you should see a pretty Laravel splash page. Get ready, there is lots more to learn! + +### Extras + +Installaing the following goodies will help you take full advantage of Laravel, but they are not required: + +- SQLite, MySQL, or PostgreSQL PDO drivers. +- Memcached or APC. + +### Problems? + +- Make sure the **public** directory is the document root of your web server. +- If you are using mod\_rewrite, set the **index** option in **application/config/application.php** to an empty string. + +[Back To Top](#top) + + +## Basic Configuration + +### Quick Start + +When starting a new project, you shouldn't be bombarded with loads of confusing configuration decisions. For that reason, Laravel is intelligently configured out of the box. The **application/config/application.php** file contains the basic configuration options for your application. + +There is only one option that **must** be set when starting a new application. Laravel needs to know the URL you will use to access your application. Simply set the url in the **application/config/application.php** file: + + 'url' => 'http://localhost'; + +> **Note:** If you are using mod_rewrite for cleaner URLs, you should set the index option to an empty string. + + +### Cleaner URLs + +Most likely, you do not want your application URLs to contain "index.php". You can remove it using HTTP rewrite rules. If you are using Apache to serve your application, make sure to enable mod_rewrite and create a **.htaccess** file like this one in your **public** directory: + + + RewriteEngine on + + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + + RewriteRule ^(.*)$ index.php/$1 [L] + + +Is the .htaccess file above not working for you? Try this one: + + Options +FollowSymLinks + RewriteEngine on + + RewriteCond %{REQUEST_FILENAME} !-f + RewriteCond %{REQUEST_FILENAME} !-d + + RewriteRule . index.php [L] + +After setting up HTTP rewriting, you should set the **index** configuration option in **application/config/application.php** to an empty string. + +> **Note:** Each web server has a different method of doing HTTP rewrites, and may require a slightly different .htaccess file. + +[Back To Top](#top) + + +## Defining Routes + +- [The Basics](#routes-basics) +- [Route URI Wildcards](#routes-wildcards) +- [Route Filters](#route-filters) +- [Named Routes](#routes-named) +- [Organizing Routes](#routes-folder) + + +### The Basics + +Unlike other PHP frameworks, Laravel places routes and their corresponding functions in one file: **application/routes.php**. This file contains the "definition", or public API, of your application. To add functionality to your application, you add to the array located in this file. + +All you need to do is tell Laravel the request methods and URIs it should respond to. You define the behavior of the route using an anonymous method: + + 'GET /home' => function() + { + // Handles GET requests to http://example.com/index.php/home + }, + + 'PUT /user/update' => function() + { + // Handles PUT requests to http://example.com/index.php/user/update + } + +You can easily define a route to handle requests to more than one URI. Just use commas: + + 'POST /, POST /home' => function() + { + // Handles POST requests to http://example.com and http://example.com/index.php/home + } + +> **Note:** The routes.php file replaces the "controllers" found in most frameworks. Have a fat model and keep this file light and clean. Thank us later. + +[Back To Top](#top) + + +### Route URI Wildcards + +You can pass URI segments to your route functions using the **(:num)** and **(:any)** wildcards: + + 'PUT /user/(:num)' => function($id) {} + + 'GET /user/(:any)/edit' => function($username) {} + +You may make segments optional by placing a **?** in the wildcard: + + 'GET /branch/(:any?)' => function($branch = 'master') {} + +If you need more power and precision, you can even use regular expressions: + + 'GET /product/([0-9]+)' => function($id) {} + +[Back To Top](#top) \ No newline at end of file diff --git a/system/arr.php b/system/arr.php index 0b6e7235..ba3875e5 100644 --- a/system/arr.php +++ b/system/arr.php @@ -5,9 +5,11 @@ class Arr { /** * Get an item from an array. * + * If the specified key is null, the entire array will be returned. + * * @param array $array * @param string $key - * @param array $default + * @param mixed $default * @return mixed */ public static function get($array, $key, $default = null) @@ -17,7 +19,12 @@ class Arr { return $array; } - return (array_key_exists($key, $array)) ? $array[$key] : $default; + if (array_key_exists($key, $array)) + { + return $array[$key]; + } + + return is_callable($default) ? call_user_func($default) : $default; } } \ No newline at end of file diff --git a/system/auth.php b/system/auth.php index 817e0a84..92be397a 100644 --- a/system/auth.php +++ b/system/auth.php @@ -29,28 +29,20 @@ class Auth { /** * Get the current user of the application. * + * The user will be loaded using the user ID stored in the session. + * * @return object */ public static function user() { - // ----------------------------------------------------- - // Verify that sessions are enabled. Since the user ID - // is stored in the session, we can't authenticate - // without a session driver specified. - // ----------------------------------------------------- if (Config::get('session.driver') == '') { throw new \Exception("You must specify a session driver before using the Auth class."); } - $model = static::model(); - - // ----------------------------------------------------- - // Load the user using the ID stored in the session. - // ----------------------------------------------------- if (is_null(static::$user) and Session::has(static::$key)) { - static::$user = $model::find(Session::get(static::$key)); + static::$user = call_user_func(Config::get('auth.by_id'), Session::get(static::$key)); } return static::$user; @@ -59,25 +51,17 @@ class Auth { /** * Attempt to login a user. * + * If the user credentials are valid. The user ID will be stored in the session + * and will be considered "logged in" on subsequent requests to the application. + * * @param string $username * @param string $password */ public static function login($username, $password) { - $model = static::model(); - - $user = $model::where(Config::get('auth.username'), '=', $username)->first(); - - if ( ! is_null($user)) + if ( ! is_null($user = call_user_func(Config::get('auth.by_username'), $username))) { - // ----------------------------------------------------- - // Hash the password. If a salt is present on the user - // record, we will recreate the hashed password using - // the salt. Otherwise, we will just use a plain hash. - // ----------------------------------------------------- - $password = (isset($user->salt)) ? Hash::make($password, $user->salt)->value : sha1($password); - - if ($user->password === $password) + if (Hash::check($password, $user->password)) { static::$user = $user; @@ -91,30 +75,15 @@ class Auth { } /** - * Logout the current user of the application. + * Logout the user of the application. * * @return void */ public static function logout() { - // ----------------------------------------------------- - // By removing the user ID from the session, the user - // will no longer be considered logged in on subsequent - // requests to the application. - // ----------------------------------------------------- Session::forget(static::$key); static::$user = null; } - /** - * Get the authentication model. - * - * @return string - */ - private static function model() - { - return '\\'.Config::get('auth.model'); - } - } \ No newline at end of file diff --git a/system/cache.php b/system/cache.php index 6113b906..fe2d2dc1 100644 --- a/system/cache.php +++ b/system/cache.php @@ -7,47 +7,111 @@ class Cache { * * @var Cache\Driver */ - private static $drivers = array(); + public static $drivers = array(); /** - * Get the cache driver instance. + * All of the items retrieved by the cache drivers. + * + * @var array + */ + public static $items = array(); + + /** + * Get a cache driver instance. If no driver name is specified, the default + * cache driver will be returned as defined in the cache configuration file. + * + * Note: Cache drivers are managed as singleton instances. * * @param string $driver * @return Cache\Driver */ public static function driver($driver = null) { - // -------------------------------------------------- - // If the cache driver has already been instantiated, - // we'll just return that existing instance. - // - // Otherwise, we'll instantiate a new one. - // -------------------------------------------------- + if (is_null($driver)) + { + $driver = Config::get('cache.driver'); + } + if ( ! array_key_exists($driver, static::$drivers)) { - if (is_null($driver)) + switch ($driver) { - $driver = Config::get('cache.driver'); - } + case 'file': + static::$drivers[$driver] = new Cache\Driver\File; + break; - static::$drivers[$driver] = Cache\Factory::make($driver); + case 'memcached': + static::$drivers[$driver] = new Cache\Driver\Memcached; + break; + + case 'apc': + static::$drivers[$driver] = new Cache\Driver\APC; + break; + + default: + throw new \Exception("Cache driver [$driver] is not supported."); + } } return static::$drivers[$driver]; } + /** + * Get an item from the cache. + * + * @param string $key + * @param mixed $default + * @param string $driver + * @return mixed + */ + public static function get($key, $default = null, $driver = null) + { + if (isset(static::$items[$driver][$key])) + { + return static::$items[$driver][$key]; + } + + if (is_null($item = static::driver($driver)->get($key))) + { + return is_callable($default) ? call_user_func($default) : $default; + } + + return static::$items[$driver][$key] = $item; + } + + /** + * Get an item from the cache. If the item doesn't exist in the cache, store + * the default value in the cache and return it. + * + * @param string $key + * @param mixed $default + * @param int $minutes + * @param string $driver + * @return mixed + */ + public static function remember($key, $default, $minutes, $driver = null) + { + if ( ! is_null($item = static::get($key))) + { + return $item; + } + + $default = is_callable($default) ? call_user_func($default) : $default; + + static::driver($driver)->put($key, $default, $minutes); + + return $default; + } + /** * Pass all other methods to the default driver. + * + * Passing method calls to the driver instance provides a better API for the + * developer. For instance, instead of saying Cache::driver()->foo(), we can + * now just say Cache::foo(). */ public static function __callStatic($method, $parameters) { - // -------------------------------------------------- - // Passing method calls to the driver instance allows - // a better API for the developer. - // - // For instance, instead of saying Cache::driver()->foo(), - // we can now just say Cache::foo(). - // -------------------------------------------------- return call_user_func_array(array(static::driver(), $method), $parameters); } diff --git a/system/cache/driver.php b/system/cache/driver.php index 0c9fb375..69a93289 100644 --- a/system/cache/driver.php +++ b/system/cache/driver.php @@ -14,10 +14,9 @@ interface Driver { * Get an item from the cache. * * @param string $key - * @param mixed $default * @return mixed */ - public function get($key, $default = null); + public function get($key); /** * Write an item to the cache. diff --git a/system/cache/driver/apc.php b/system/cache/driver/apc.php index 195aa0ad..ba178634 100644 --- a/system/cache/driver/apc.php +++ b/system/cache/driver/apc.php @@ -1,13 +1,8 @@ items)) - { - return $this->items[$key]; - } - - $cache = apc_fetch(\System\Config::get('cache.key').$key); - - if ($cache === false) - { - return $default; - } - - return $this->items[$key] = $cache; + return ( ! is_null($cache = apc_fetch(Config::get('cache.key').$key))) ? $cache : null; } /** @@ -54,7 +36,7 @@ class APC implements \System\Cache\Driver { */ public function put($key, $value, $minutes) { - apc_store(\System\Config::get('cache.key').$key, $value, $minutes * 60); + apc_store(Config::get('cache.key').$key, $value, $minutes * 60); } /** @@ -65,7 +47,7 @@ class APC implements \System\Cache\Driver { */ public function forget($key) { - apc_delete(\System\Config::get('cache.key').$key); + apc_delete(Config::get('cache.key').$key); } } \ No newline at end of file diff --git a/system/cache/driver/file.php b/system/cache/driver/file.php index 0994f75d..442f1cfd 100644 --- a/system/cache/driver/file.php +++ b/system/cache/driver/file.php @@ -2,13 +2,6 @@ class File implements \System\Cache\Driver { - /** - * All of the loaded cache items. - * - * @var array - */ - private $items = array(); - /** * Determine if an item exists in the cache. * @@ -27,32 +20,23 @@ class File implements \System\Cache\Driver { * @param mixed $default * @return mixed */ - public function get($key, $default = null) + public function get($key) { - if (array_key_exists($key, $this->items)) - { - return $this->items[$key]; - } - if ( ! file_exists(APP_PATH.'storage/cache/'.$key)) { - return $default; + return null; } $cache = file_get_contents(APP_PATH.'storage/cache/'.$key); - // -------------------------------------------------- - // Has the cache expired? The UNIX expiration time - // is stored at the beginning of the file. - // -------------------------------------------------- if (time() >= substr($cache, 0, 10)) { $this->forget($key); - return $default; + return null; } - return $this->items[$key] = unserialize(substr($cache, 10)); + return unserialize(substr($cache, 10)); } /** diff --git a/system/cache/driver/memcached.php b/system/cache/driver/memcached.php index 22834727..c2f4fe06 100644 --- a/system/cache/driver/memcached.php +++ b/system/cache/driver/memcached.php @@ -1,13 +1,8 @@ items)) - { - return $this->items[$key]; - } - - // -------------------------------------------------- - // Attempt to the get the item from cache. - // -------------------------------------------------- - $cache = \System\Memcached::instance()->get(\System\Config::get('cache.key').$key); - - // -------------------------------------------------- - // Verify that the item was retrieved. - // -------------------------------------------------- - if ($cache === false) - { - return $default; - } - - return $this->items[$key] = $cache; + return (($cache = \System\Memcached::instance()->get(Config::get('cache.key').$key)) !== false) ? $cache : null; } /** @@ -63,7 +36,7 @@ class Memcached implements \System\Cache\Driver { */ public function put($key, $value, $minutes) { - \System\Memcached::instance()->set(\System\Config::get('cache.key').$key, $value, 0, $minutes * 60); + \System\Memcached::instance()->set(Config::get('cache.key').$key, $value, 0, $minutes * 60); } /** @@ -74,7 +47,7 @@ class Memcached implements \System\Cache\Driver { */ public function forget($key) { - \System\Memcached::instance()->delete(\System\Config::get('cache.key').$key); + \System\Memcached::instance()->delete(Config::get('cache.key').$key); } } \ No newline at end of file diff --git a/system/cache/factory.php b/system/cache/factory.php deleted file mode 100644 index 245f4c85..00000000 --- a/system/cache/factory.php +++ /dev/null @@ -1,29 +0,0 @@ -name = $name; - $this->value = $value; - } - - /** - * Create a new Cookie instance. - * - * @param string $name - * @return Cookie - */ - public static function make($name, $value = null) - { - return new static($name, $value); - } - - /** - * Send the current cookie instance to the user's machine. - * - * @return bool - */ - public function send() - { - if (is_null($this->name)) - { - throw new \Exception("Attempting to send cookie without a name."); - } - - return static::put($this->name, $this->value, $this->lifetime, $this->path, $this->domain, $this->secure); - } - /** * Determine if a cookie exists. * diff --git a/system/crypt.php b/system/crypt.php index fc338de9..a7cd77c2 100644 --- a/system/crypt.php +++ b/system/crypt.php @@ -24,38 +24,16 @@ class Crypt { */ public static function encrypt($value) { - // ----------------------------------------------------- - // Determine the input vector source. Different servers - // and operating systems will have varying options. - // ----------------------------------------------------- - if (defined('MCRYPT_DEV_URANDOM')) - { - $random = MCRYPT_DEV_URANDOM; - } - elseif (defined('MCRYPT_DEV_RANDOM')) - { - $random = MCRYPT_DEV_RANDOM; - } - else - { - $random = MCRYPT_RAND; - } - - // ----------------------------------------------------- - // The system random number generator must be seeded - // to produce adequately random results. - // ----------------------------------------------------- - if ($random === MCRYPT_RAND) + // Seed the system random number generator if it is being used. + if (($random = static::randomizer()) === MCRYPT_RAND) { mt_srand(); } $iv = mcrypt_create_iv(static::iv_size(), $random); + $value = mcrypt_encrypt(static::$cipher, static::key(), $value, static::$mode, $iv); - // ----------------------------------------------------- - // We use base64 encoding to get a nice string value. - // ----------------------------------------------------- return base64_encode($iv.$value); } @@ -67,10 +45,6 @@ class Crypt { */ public static function decrypt($value) { - // ----------------------------------------------------- - // Since all of our encrypted values are base64 encoded, - // we will decode the value here and verify it. - // ----------------------------------------------------- $value = base64_decode($value, true); if ( ! $value) @@ -78,21 +52,38 @@ class Crypt { throw new \Exception('Decryption error. Input value is not valid base64 data.'); } - // ----------------------------------------------------- // Extract the input vector from the value. - // ----------------------------------------------------- $iv = substr($value, 0, static::iv_size()); - // ----------------------------------------------------- // Remove the input vector from the encrypted value. - // ----------------------------------------------------- $value = substr($value, static::iv_size()); return rtrim(mcrypt_decrypt(static::$cipher, static::key(), $value, static::$mode, $iv), "\0"); } /** - * Get the application key. + * Get the random number source that should be used for the OS. + * + * @return int + */ + private static function randomizer() + { + if (defined('MCRYPT_DEV_URANDOM')) + { + return MCRYPT_DEV_URANDOM; + } + elseif (defined('MCRYPT_DEV_RANDOM')) + { + return MCRYPT_DEV_RANDOM; + } + else + { + return MCRYPT_RAND; + } + } + + /** + * Get the application key from the application configuration file. * * @return string */ diff --git a/system/db.php b/system/db.php index 0f064ef8..c4460513 100644 --- a/system/db.php +++ b/system/db.php @@ -7,10 +7,13 @@ class DB { * * @var array */ - private static $connections = array(); + public static $connections = array(); /** - * Get a database connection. + * Get a database connection. If no database name is specified, the default + * connection will be returned as defined in the db configuration file. + * + * Note: Database connections are managed as singletons. * * @param string $connection * @return PDO @@ -22,22 +25,9 @@ class DB { $connection = Config::get('db.default'); } - // --------------------------------------------------- - // If we have already established this connection, - // simply return the existing connection. - // - // Don't want to establish the same connection twice! - // --------------------------------------------------- if ( ! array_key_exists($connection, static::$connections)) { - $config = Config::get('db.connections'); - - if ( ! array_key_exists($connection, $config)) - { - throw new \Exception("Database connection [$connection] is not defined."); - } - - static::$connections[$connection] = DB\Connector::connect((object) $config[$connection]); + static::$connections[$connection] = DB\Connector::connect($connection); } return static::$connections[$connection]; @@ -46,6 +36,13 @@ class DB { /** * Execute a SQL query against the connection. * + * The method returns the following based on query type: + * + * SELECT -> Array of stdClasses + * UPDATE -> Number of rows affected. + * DELETE -> Number of Rows affected. + * ELSE -> Boolean true / false depending on success. + * * @param string $sql * @param array $bindings * @param string $connection @@ -55,17 +52,22 @@ class DB { { $query = static::connection($connection)->prepare($sql); - $result = $query->execute($bindings); + $bindings = array_values($bindings); + + foreach ($bindings as $key => &$binding) + { + if (is_null($binding)) + { + $query->bindValue($key + 1, null, \PDO::PARAM_INT); + } + else + { + $query->bindParam($key + 1, $binding); + } + } + + $result = $query->execute(); - // --------------------------------------------------- - // For SELECT statements, the results will be returned - // as an array of stdClasses. - // - // For UPDATE and DELETE statements, the number of - // rows affected by the query will be returned. - // - // For all other statements, return a boolean. - // --------------------------------------------------- if (strpos(strtoupper($sql), 'SELECT') === 0) { return $query->fetchAll(\PDO::FETCH_CLASS, 'stdClass'); diff --git a/system/db/connector.php b/system/db/connector.php index 25a50375..ee4f275f 100644 --- a/system/db/connector.php +++ b/system/db/connector.php @@ -1,5 +1,7 @@ driver == 'sqlite') + $config = static::configuration($connection); + + switch ($config->driver) { - // ----------------------------------------------------- - // Check the application/db directory first. - // - // If the database doesn't exist there, maybe the full - // path was specified as the database name? - // ----------------------------------------------------- - if (file_exists($path = APP_PATH.'storage/db/'.$config->database.'.sqlite')) - { - return new \PDO('sqlite:'.$path, null, null, static::$options); - } - elseif (file_exists($config->database)) - { - return new \PDO('sqlite:'.$config->database, null, null, static::$options); - } - else - { - throw new \Exception("SQLite database [".$config->database."] could not be found."); - } - } - // ----------------------------------------------------- - // Connect to MySQL or Postgres. - // ----------------------------------------------------- - elseif ($config->driver == 'mysql' or $config->driver == 'pgsql') - { - // ----------------------------------------------------- - // Build the PDO connection DSN. - // ----------------------------------------------------- - $dsn = $config->driver.':host='.$config->host.';dbname='.$config->database; + case 'sqlite': + return static::connect_to_sqlite($config); - if (isset($config->port)) - { - $dsn .= ';port='.$config->port; - } - - $connection = new \PDO($dsn, $config->username, $config->password, static::$options); - - // ----------------------------------------------------- - // Set the appropriate character set for the datbase. - // ----------------------------------------------------- - if (isset($config->charset)) - { - $connection->prepare("SET NAMES '".$config->charset."'")->execute(); - } - - return $connection; + case 'mysql': + case 'pgsql': + return static::connect_to_server($config); } throw new \Exception('Database driver '.$config->driver.' is not supported.'); } + /** + * Establish a PDO connection to a SQLite database. + * + * SQLite database paths can be specified either relative to the application/db + * directory, or as an absolute path to any location on the file system. + * + * @param array $config + * @return PDO + */ + private static function connect_to_sqlite($config) + { + if (file_exists($path = APP_PATH.'storage/db/'.$config->database.'.sqlite')) + { + return new \PDO('sqlite:'.$path, null, null, static::$options); + } + elseif (file_exists($config->database)) + { + return new \PDO('sqlite:'.$config->database, null, null, static::$options); + } + else + { + throw new \Exception("SQLite database [".$config->database."] could not be found."); + } + } + + /** + * Connect to a MySQL or PostgreSQL database server. + * + * @param array $config + * @return PDO + */ + private static function connect_to_server($config) + { + $dsn = $config->driver.':host='.$config->host.';dbname='.$config->database; + + if (isset($config->port)) + { + $dsn .= ';port='.$config->port; + } + + $connection = new \PDO($dsn, $config->username, $config->password, static::$options); + + if (isset($config->charset)) + { + $connection->prepare("SET NAMES '".$config->charset."'")->execute(); + } + + return $connection; + } + + /** + * Get the configuration options for a database connection. + * + * @param string $connection + * @return object + */ + private static function configuration($connection) + { + $config = Config::get('db.connections'); + + if ( ! array_key_exists($connection, $config)) + { + throw new \Exception("Database connection [$connection] is not defined."); + } + + return (object) $config[$connection]; + } + } \ No newline at end of file diff --git a/system/db/eloquent.php b/system/db/eloquent.php index 9263faab..625d7559 100644 --- a/system/db/eloquent.php +++ b/system/db/eloquent.php @@ -83,6 +83,17 @@ abstract class Eloquent { * @return void */ public function __construct($attributes = array()) + { + $this->fill($attributes); + } + + /** + * Set the attributes of the model using an array. + * + * @param array $attributes + * @return void + */ + public function fill($attributes) { foreach ($attributes as $key => $value) { @@ -116,11 +127,8 @@ abstract class Eloquent { { $model = new $class; - // ----------------------------------------------------- - // Since this method is only used for instantiating - // models for querying purposes, we will go ahead and - // set the Query instance on the model. - // ----------------------------------------------------- + // Since this method is only used for instantiating models for querying + // purposes, we will go ahead and set the Query instance on the model. $model->query = Query::table(static::table($class)); return $model; @@ -135,6 +143,7 @@ abstract class Eloquent { public static function with() { $model = static::make(get_called_class()); + $model->includes = func_get_args(); return $model; @@ -200,20 +209,16 @@ abstract class Eloquent { /** * Retrieve the query for a 1:1 or 1:* relationship. * + * The default foreign key for has one and has many relationships is the name + * of the model with an appended _id. For example, the foreign key for a + * User model would be user_id. Photo would be photo_id, etc. + * * @param string $model * @param string $foreign_key * @return mixed */ private function has_one_or_many($model, $foreign_key) { - // ----------------------------------------------------- - // The default foreign key for has one and has many - // relationships is the name of the model with an - // appended _id. - // - // For example, the foreign key for a User model would - // be user_id. Photo would be photo_id, etc. - // ----------------------------------------------------- $this->relating_key = (is_null($foreign_key)) ? strtolower(get_class($this)).'_id' : $foreign_key; return static::make($model)->where($this->relating_key, '=', $this->id); @@ -222,6 +227,10 @@ abstract class Eloquent { /** * Retrieve the query for a 1:1 belonging relationship. * + * The default foreign key for belonging relationships is the name of the + * relationship method name with _id. So, if a model has a "manager" method + * returning a belongs_to relationship, the key would be manager_id. + * * @param string $model * @param string $foreign_key * @return mixed @@ -236,13 +245,6 @@ abstract class Eloquent { } else { - // ----------------------------------------------------- - // The default foreign key for belonging relationships - // is the name of the relationship method name with _id. - // - // So, if a model has a "manager" method returning a - // belongs_to relationship, the key would be manager_id. - // ----------------------------------------------------- list(, $caller) = debug_backtrace(false); $this->relating_key = $caller['function'].'_id'; @@ -254,6 +256,12 @@ abstract class Eloquent { /** * Retrieve the query for a *:* relationship. * + * By default, the intermediate table name is the plural names of the models + * arranged alphabetically and concatenated with an underscore. + * + * The default foreign key for many-to-many relations is the name of the model + * with an appended _id. This is the same convention as has_one and has_many. + * * @param string $model * @param string $table * @return mixed @@ -262,50 +270,34 @@ abstract class Eloquent { { $this->relating = __FUNCTION__; - if ( ! is_null($table)) + if (is_null($table)) { - $this->relating_table = $table; - } - else - { - // ----------------------------------------------------- - // By default, the intermediate table name is the plural - // names of the models arranged alphabetically and - // concatenated with an underscore. - // ----------------------------------------------------- $models = array(Inflector::plural($model), Inflector::plural(get_class($this))); sort($models); $this->relating_table = strtolower($models[0].'_'.$models[1]); } + else + { + $this->relating_table = $table; + } - // ----------------------------------------------------- - // The default foreign key for many-to-many relations - // is the name of the model with an appended _id. - // appended _id. - // - // This is the same convention as has_one and has_many. - // ----------------------------------------------------- $this->relating_key = strtolower(get_class($this)).'_id'; return static::make($model) - ->select(static::table($model).'.*') - ->join($this->relating_table, static::table($model).'.id', '=', $this->relating_table.'.'.strtolower($model).'_id') - ->where($this->relating_table.'.'.$this->relating_key, '=', $this->id); + ->select(array(static::table($model).'.*')) + ->join($this->relating_table, static::table($model).'.id', '=', $this->relating_table.'.'.strtolower($model).'_id') + ->where($this->relating_table.'.'.$this->relating_key, '=', $this->id); } /** * Save the model to the database. * - * @return bool + * @return void */ public function save() { - // ----------------------------------------------------- - // If the model doesn't have any dirty attributes, there - // is no need to save it to the database. - // ----------------------------------------------------- if ($this->exists and count($this->dirty) == 0) { return true; @@ -313,15 +305,10 @@ abstract class Eloquent { $model = get_class($this); - // ----------------------------------------------------- - // Since the model was instantiated using "new", a query - // instance has not been set. We'll do it now. - // ----------------------------------------------------- + // Since the model was instantiated using "new", a query instance has not been set. + // Only models being used for querying have their query instances set by default. $this->query = Query::table(static::table($model)); - // ----------------------------------------------------- - // Set the creation and update timestamps. - // ----------------------------------------------------- if (property_exists($model, 'timestamps') and $model::$timestamps) { $this->updated_at = date('Y-m-d H:i:s'); @@ -332,24 +319,20 @@ abstract class Eloquent { } } - // ----------------------------------------------------- - // If the model already exists in the database, we only - // need to update it. Otherwise, we'll insert it. - // ----------------------------------------------------- + // If the model already exists in the database, we will just update it. + // Otherwise, we will insert the model and set the ID attribute. if ($this->exists) { - $result = $this->query->where('id', '=', $this->attributes['id'])->update($this->dirty) == 1; + $this->query->where('id', '=', $this->attributes['id'])->update($this->dirty); } else { $this->attributes['id'] = $this->query->insert_get_id($this->attributes); + } - $result = $this->exists = is_numeric($this->id); - } + $this->exists = true; $this->dirty = array(); - - return $result; } /** @@ -360,16 +343,12 @@ abstract class Eloquent { */ public function delete($id = null) { - // ----------------------------------------------------- - // If the method is being called from an existing model, - // only delete that model from the database. - // ----------------------------------------------------- if ($this->exists) { return Query::table(static::table(get_class($this)))->delete($this->id); } - return $this->query->delete($id); + return $this->query->delete(); } /** @@ -377,25 +356,18 @@ abstract class Eloquent { */ public function __get($key) { - // ----------------------------------------------------- - // Check the ignored attributes first. These attributes - // hold all of the loaded relationships. - // ----------------------------------------------------- + // The ignored attributes hold all of the loaded relationships for the model. if (array_key_exists($key, $this->ignore)) { return $this->ignore[$key]; } - // ----------------------------------------------------- - // Is the attribute actually a relationship method? - // ----------------------------------------------------- + // If the attribute is a relationship method, return the related models. if (method_exists($this, $key)) { $model = $this->$key(); - return ($this->relating == 'has_one' or $this->relating == 'belongs_to') - ? $this->ignore[$key] = $model->first() - : $this->ignore[$key] = $model->get(); + return $this->ignore[$key] = (in_array($this->relating, array('has_one', 'belongs_to'))) ? $model->first() : $model->get(); } return (array_key_exists($key, $this->attributes)) ? $this->attributes[$key] : null; @@ -406,10 +378,7 @@ abstract class Eloquent { */ public function __set($key, $value) { - // ----------------------------------------------------- - // If the key is a relationship, add it to the ignored. - // Otherwise, we can simply add it as an attribute. - // ----------------------------------------------------- + // If the key is a relationship, add it to the ignored attributes. if (method_exists($this, $key)) { $this->ignore[$key] = $value; @@ -434,9 +403,7 @@ abstract class Eloquent { */ public function __unset($key) { - unset($this->attributes[$key]); - unset($this->ignore[$key]); - unset($this->dirty[$key]); + unset($this->attributes[$key], $this->ignore[$key], $this->dirty[$key]); } /** @@ -454,18 +421,13 @@ abstract class Eloquent { return $this->_first(); } - // ----------------------------------------------------- - // Pass aggregate methods to the query instance. - // ----------------------------------------------------- if (in_array($method, array('count', 'sum', 'min', 'max', 'avg'))) { return call_user_func_array(array($this->query, $method), $parameters); } - // ----------------------------------------------------- - // Pass the method to the query instance. This allows - // the chaining of methods from the query builder. - // ----------------------------------------------------- + // Pass the method to the query instance. This allows the chaining of methods + // from the query builder, providing a nice, convenient API. call_user_func_array(array($this->query, $method), $parameters); return $this; @@ -488,18 +450,13 @@ abstract class Eloquent { return $model->_first(); } - // ----------------------------------------------------- - // Pass aggregate methods to the query instance. - // ----------------------------------------------------- if (in_array($method, array('count', 'sum', 'min', 'max', 'avg'))) { return call_user_func_array(array($model->query, $method), $parameters); } - // ----------------------------------------------------- - // Pass the method to the query instance. This allows - // the chaining of methods from the query builder. - // ----------------------------------------------------- + // Pass the method to the query instance. This allows the chaining of methods + // from the query builder, providing a nice, convenient API. call_user_func_array(array($model->query, $method), $parameters); return $model; diff --git a/system/db/eloquent/hydrator.php b/system/db/eloquent/hydrator.php index f4ba7e02..b2aa942d 100644 --- a/system/db/eloquent/hydrator.php +++ b/system/db/eloquent/hydrator.php @@ -5,21 +5,15 @@ use System\DB\Eloquent; class Hydrator { /** - * Load the array of hydrated models. + * Load the array of hydrated models and their eager relationships. * * @param object $eloquent * @return array */ public static function hydrate($eloquent) { - // ----------------------------------------------------- - // Load the base / parent models from the query results. - // ----------------------------------------------------- $results = static::base(get_class($eloquent), $eloquent->query->get()); - // ----------------------------------------------------- - // Load all of the eager relationships. - // ----------------------------------------------------- if (count($results) > 0) { foreach ($eloquent->includes as $include) @@ -39,6 +33,9 @@ class Hydrator { /** * Hydrate the base models for a query. * + * The resulting model array is keyed by the primary keys of the models. + * This allows the models to easily be matched to their children. + * * @param string $class * @param array $results * @return array @@ -52,13 +49,9 @@ class Hydrator { $model = new $class; $model->attributes = (array) $result; + $model->exists = true; - // ----------------------------------------------------- - // The results are keyed by the ID on the record. This - // will allow us to conveniently match them to child - // models during eager loading. - // ----------------------------------------------------- $models[$model->id] = $model; } @@ -75,39 +68,28 @@ class Hydrator { */ private static function eagerly($eloquent, &$parents, $include) { - // ----------------------------------------------------- // Get the relationship Eloquent model. // - // We temporarily spoof the belongs_to key to allow the - // query to be fetched without any problems, since the - // belongs_to method actually gets the attribute. - // ----------------------------------------------------- + // We temporarily spoof the belongs_to key to allow the query to be fetched without + // any problems, since the belongs_to method actually gets the attribute. $eloquent->attributes[$spoof = $include.'_id'] = 0; $relationship = $eloquent->$include(); unset($eloquent->attributes[$spoof]); - // ----------------------------------------------------- - // Reset the WHERE clause and bindings on the query. - // We'll add our own WHERE clause soon. - // ----------------------------------------------------- + // Reset the WHERE clause and bindings on the query. We'll add our own WHERE clause soon. $relationship->query->where = 'WHERE 1 = 1'; + $relationship->query->bindings = array(); - // ----------------------------------------------------- - // Initialize the relationship attribute on the parents. - // As expected, "many" relationships are initialized to - // an array and "one" relationships to null. - // ----------------------------------------------------- + // Initialize the relationship attribute on the parents. As expected, "many" relationships + // are initialized to an array and "one" relationships are initialized to null. foreach ($parents as &$parent) { $parent->ignore[$include] = (strpos($eloquent->relating, 'has_many') === 0) ? array() : null; } - // ----------------------------------------------------- - // Eagerly load the relationships. Phew, almost there! - // ----------------------------------------------------- if ($eloquent->relating == 'has_one') { static::eagerly_load_one($relationship, $parents, $eloquent->relating_key, $include); @@ -138,14 +120,6 @@ class Hydrator { */ private static function eagerly_load_one($relationship, &$parents, $relating_key, $include) { - // ----------------------------------------------------- - // Get the all of the related models by the parent IDs. - // - // Remember, the parent results are keyed by ID. So, we - // can simply pass the keys of the array into the query. - // - // After getting the models, we'll match by ID. - // ----------------------------------------------------- foreach ($relationship->where_in($relating_key, array_keys($parents))->get() as $key => $child) { $parents[$child->$relating_key]->ignore[$include] = $child; @@ -181,11 +155,6 @@ class Hydrator { */ private static function eagerly_load_belonging($relationship, &$parents, $relating_key, $include) { - // ----------------------------------------------------- - // Gather the keys from the parent models. Since the - // foreign key is on the parent model for this type of - // relationship, we have to gather them individually. - // ----------------------------------------------------- $keys = array(); foreach ($parents as &$parent) @@ -193,14 +162,8 @@ class Hydrator { $keys[] = $parent->$relating_key; } - // ----------------------------------------------------- - // Get the related models. - // ----------------------------------------------------- $children = $relationship->where_in('id', array_unique($keys))->get(); - // ----------------------------------------------------- - // Match the child models with their parent by ID. - // ----------------------------------------------------- foreach ($parents as &$parent) { if (array_key_exists($parent->$relating_key, $children)) @@ -225,37 +188,24 @@ class Hydrator { { $relationship->query->select = null; - // ----------------------------------------------------- - // Retrieve the raw results as stdClasses. - // - // We also add the foreign key to the select which will allow us - // to match the models back to their parents. - // ----------------------------------------------------- - $children = $relationship->query - ->where_in($relating_table.'.'.$relating_key, array_keys($parents)) - ->get(Eloquent::table(get_class($relationship)).'.*', $relating_table.'.'.$relating_key); + $relationship->query->where_in($relating_table.'.'.$relating_key, array_keys($parents)); + + // The foreign key is added to the select to allow us to easily match the models back to their parents. + $children = $relationship->query->get(array(Eloquent::table(get_class($relationship)).'.*', $relating_table.'.'.$relating_key)); $class = get_class($relationship); - // ----------------------------------------------------- - // Create the related models. - // ----------------------------------------------------- foreach ($children as $child) { $related = new $class; $related->attributes = (array) $child; + $related->exists = true; - // ----------------------------------------------------- - // Remove the foreign key from the attributes since it - // was added to the query to help us match the models. - // ----------------------------------------------------- + // Remove the foreign key since it was added to the query to help match to the children. unset($related->attributes[$relating_key]); - // ----------------------------------------------------- - // Match the child model its parent by ID. - // ----------------------------------------------------- $parents[$child->$relating_key]->ignore[$include][$child->id] = $related; } } diff --git a/system/db/query.php b/system/db/query.php index 85e02b2f..cc1e5bb2 100644 --- a/system/db/query.php +++ b/system/db/query.php @@ -115,13 +115,45 @@ class Query { /** * Add columns to the SELECT clause. * + * @param array $columns * @return Query */ - public function select() + public function select($columns = array('*')) { $this->select = ($this->distinct) ? 'SELECT DISTINCT ' : 'SELECT '; - $this->select .= implode(', ', array_map(array($this, 'wrap'), func_get_args())); + $wrapped = array(); + + foreach ($columns as $column) + { + // If the column name is being aliased, we will need to wrap the column + // name and its alias in keyword identifiers. + if (strpos(strtolower($column), ' as ') !== false) + { + $segments = explode(' ', $column); + + $wrapped[] = $this->wrap($segments[0]).' AS '.$this->wrap($segments[2]); + } + else + { + $wrapped[] = $this->wrap($column); + } + } + + $this->select .= implode(', ', $wrapped); + + return $this; + } + + /** + * Set the FROM clause. + * + * @param string $from + * @return Query + */ + public function from($from) + { + $this->from = $from; return $this; } @@ -357,34 +389,38 @@ class Query { /** * Find a record by the primary key. * - * @param int $id + * @param int $id + * @param array $columns * @return object */ - public function find($id) + public function find($id, $columns = array('*')) { - return $this->where('id', '=', $id)->first(); + return $this->where('id', '=', $id)->first($columns); } /** * Execute the query as a SELECT statement and return the first result. * + * @param array $columns * @return object */ - public function first() + public function first($columns = array('*')) { - return (count($results = call_user_func_array(array($this->take(1), 'get'), func_get_args())) > 0) ? $results[0] : null; + + return (count($results = $this->take(1)->get($columns)) > 0) ? $results[0] : null; } /** * Execute the query as a SELECT statement. * + * @param array $columns * @return array */ - public function get() + public function get($columns = array('*')) { if (is_null($this->select)) { - call_user_func_array(array($this, 'select'), (count(func_get_args()) > 0) ? func_get_args() : array('*')); + $this->select($columns); } return DB::query(Query\Compiler::select($this), $this->bindings, $this->connection); @@ -400,6 +436,7 @@ class Query { private function aggregate($aggregator, $column) { $this->select = 'SELECT '.$aggregator.'('.$this->wrap($column).') AS '.$this->wrap('aggregate'); + return $this->first()->aggregate; } @@ -424,10 +461,8 @@ class Query { { $sql = Query\Compiler::insert($this, $values); - // --------------------------------------------------------- - // Use the RETURNING clause on Postgres instead of PDO. - // The Postgres PDO ID method is slightly cumbersome. - // --------------------------------------------------------- + // Use the RETURNING clause on Postgres instead of the PDO lastInsertID method. + // The PDO method is a little cumbersome using Postgres. if (DB::driver($this->connection) == 'pgsql') { $query = DB::connection($this->connection)->prepare($sql.' RETURNING '.$this->wrap('id')); @@ -437,9 +472,6 @@ class Query { return $query->fetch(\PDO::FETCH_CLASS, 'stdClass')->id; } - // --------------------------------------------------------- - // Use the PDO ID method for MySQL and SQLite. - // --------------------------------------------------------- DB::query($sql, array_values($values), $this->connection); return DB::connection($this->connection)->lastInsertId(); @@ -481,6 +513,7 @@ class Query { public function wrap($value) { $wrap = (DB::driver($this->connection) == 'mysql') ? '`' : '"'; + return implode('.', array_map(function($segment) use ($wrap) {return ($segment != '*') ? $wrap.$segment.$wrap : $segment;}, explode('.', $value))); } @@ -500,20 +533,11 @@ class Query { */ public function __call($method, $parameters) { - // --------------------------------------------------------- - // Dynamic methods allows the building of very expressive - // queries. All dynamic methods start with "where_". - // - // Ex: DB::table('users')->where_email($email)->first(); - // --------------------------------------------------------- if (strpos($method, 'where_') === 0) { return Query\Dynamic::build($method, $parameters, $this); } - // --------------------------------------------------------- - // Handle any of the aggregate functions. - // --------------------------------------------------------- if (in_array($method, array('count', 'min', 'max', 'avg', 'sum'))) { return ($method == 'count') ? $this->aggregate(strtoupper($method), '*') : $this->aggregate(strtoupper($method), $parameters[0]); diff --git a/system/db/query/dynamic.php b/system/db/query/dynamic.php index 354ac57b..8993de6b 100644 --- a/system/db/query/dynamic.php +++ b/system/db/query/dynamic.php @@ -14,32 +14,21 @@ class Dynamic { */ public static function build($method, $parameters, $query) { - // --------------------------------------------------------- // Strip the "where_" off of the method. - // --------------------------------------------------------- $finder = substr($method, 6); - // --------------------------------------------------------- // Split the column names from the connectors. - // --------------------------------------------------------- $segments = preg_split('/(_and_|_or_)/i', $finder, -1, PREG_SPLIT_DELIM_CAPTURE); - // --------------------------------------------------------- - // The connector variable will determine which connector - // will be used for the condition. We'll change it as we - // come across new connectors in the dynamic method string. + // The connector variable will determine which connector will be used for the condition. + // We'll change it as we come across new connectors in the dynamic method string. // - // The index variable helps us get the correct parameter - // value for the where condition. We increment it each time - // we add a condition. - // --------------------------------------------------------- + // The index variable helps us get the correct parameter value for the where condition. + // We increment it each time we add a condition. $connector = 'AND'; $index = 0; - // --------------------------------------------------------- - // Iterate through each segment and add the conditions. - // --------------------------------------------------------- foreach ($segments as $segment) { if ($segment != '_and_' and $segment != '_or_') diff --git a/system/error.php b/system/error.php index c8a7c2c1..79069c99 100644 --- a/system/error.php +++ b/system/error.php @@ -31,57 +31,63 @@ class Error { */ public static function handle($e) { - // ----------------------------------------------------- - // Clean the output buffer. We don't want any rendered - // views or text to be sent to the browser. - // ----------------------------------------------------- if (ob_get_level() > 0) { ob_clean(); } - // ----------------------------------------------------- - // Get the error severity in human readable format. - // ----------------------------------------------------- $severity = (array_key_exists($e->getCode(), static::$levels)) ? static::$levels[$e->getCode()] : $e->getCode(); - // ----------------------------------------------------- - // Get the error file. Views require special handling - // since view errors occur within eval'd code. - // ----------------------------------------------------- - if (strpos($e->getFile(), 'view.php') !== false and strpos($e->getFile(), "eval()'d code") !== false) - { - $file = APP_PATH.'views/'.View::$last.EXT; - } - else - { - $file = $e->getFile(); - } + $file = static::file($e); $message = rtrim($e->getMessage(), '.'); if (Config::get('error.log')) { - Log::error($message.' in '.$e->getFile().' on line '.$e->getLine()); + call_user_func(Config::get('error.logger'), $severity, $message.' in '.$e->getFile().' on line '.$e->getLine()); } - // ----------------------------------------------------- - // Detailed error view contains the file name and stack - // trace of the error. It is not wise to have details - // enabled in a production environment. - // - // The generic error view (error/500) only has a simple, - // generic error message suitable for production. - // ----------------------------------------------------- + static::show($e, $severity, $message, $file); + + exit(1); + } + + /** + * Get the path to the file in which an exception occured. + * + * @param Exception $e + * @return string + */ + private static function file($e) + { + if (strpos($e->getFile(), 'view.php') !== false and strpos($e->getFile(), "eval()'d code") !== false) + { + return APP_PATH.'views/'.View::$last.EXT; + } + + return $e->getFile(); + } + + /** + * Show the error view. + * + * @param Exception $e + * @param string $severity + * @param string $message + * @param string $file + * @return void + */ + private static function show($e, $severity, $message, $file) + { if (Config::get('error.detail')) { $view = View::make('exception') - ->bind('severity', $severity) - ->bind('message', $message) - ->bind('file', $file) - ->bind('line', $e->getLine()) - ->bind('trace', $e->getTraceAsString()) - ->bind('contexts', static::context($file, $e->getLine())); + ->bind('severity', $severity) + ->bind('message', $message) + ->bind('file', $file) + ->bind('line', $e->getLine()) + ->bind('trace', $e->getTraceAsString()) + ->bind('contexts', static::context($file, $e->getLine())); Response::make($view, 500)->send(); } @@ -89,17 +95,15 @@ class Error { { Response::make(View::make('error/500'), 500)->send(); } - - exit(1); } /** - * Get the file context of an exception. + * Get the code surrounding a given line in a file. * * @param string $path * @param int $line * @param int $padding - * @return array + * @return string */ private static function context($path, $line, $padding = 5) { @@ -108,20 +112,18 @@ class Error { $file = file($path, FILE_IGNORE_NEW_LINES); array_unshift($file, ''); + + if (($start = $line - $padding) < 0) + { + $start = 0; + } - // ----------------------------------------------------- - // Calculate the starting position of the file context. - // ----------------------------------------------------- - $start = $line - $padding; - $start = ($start < 0) ? 0 : $start; + if (($length = ($line - $start) + $padding + 1) < 0) + { + $length = 0; + } - // ----------------------------------------------------- - // Calculate the context length. - // ----------------------------------------------------- - $length = ($line - $start) + $padding + 1; - $length = (($start + $length) > count($file) - 1) ? null : $length; - - return array_slice($file, $start, $length, true); + return array_slice($file, $start, $length, true); } return array(); diff --git a/system/file.php b/system/file.php index 7156243b..8575b0c3 100644 --- a/system/file.php +++ b/system/file.php @@ -125,11 +125,6 @@ class File { */ public static function upload($key, $path) { - if ( ! array_key_exists($key, $_FILES)) - { - return false; - } - - return move_uploaded_file($_FILES[$key]['tmp_name'], $path); + return array_key_exists($key, $_FILES) ? move_uploaded_file($_FILES[$key]['tmp_name'], $path) : false; } } \ No newline at end of file diff --git a/system/form.php b/system/form.php index 49d60b36..1b6017a9 100644 --- a/system/form.php +++ b/system/form.php @@ -19,15 +19,11 @@ class Form { */ public static function open($action = null, $method = 'POST', $attributes = array()) { - if (is_null($action)) - { - $action = Request::uri(); - } + $attributes['action'] = HTML::entities(URL::to((is_null($action)) ? Request::uri() : $action)); - $action = URL::to($action); - - $attributes['action'] = HTML::entities($action); - $attributes['method'] = ($method == 'GET' or $method == 'POST') ? $method : 'POST'; + // If the request method is PUT or DELETE, we'll default the request method to POST + // since the request method is being spoofed by the form. + $attributes['method'] = ($method == 'PUT' or $method == 'DELETE') ? 'POST' : $method; if ( ! array_key_exists('accept-charset', $attributes)) { @@ -36,15 +32,11 @@ class Form { $html = ''; - // ------------------------------------------------------- - // If the method is PUT or DELETE, we'll need to spoof it - // using a hidden input field. - // - // For more information, see the Input library. - // ------------------------------------------------------- + // If the request method is PUT or DELETE, create a hidden input element with the + // request method in it since HTML forms do not support these two methods. if ($method == 'PUT' or $method == 'DELETE') { - $html .= PHP_EOL.static::hidden('REQUEST_METHOD', $method); + $html .= PHP_EOL.static::input('hidden', 'REQUEST_METHOD', $method); } return $html.PHP_EOL; @@ -58,20 +50,11 @@ class Form { * @param array $attributes * @return string */ - public static function open_multipart($action = null, $method = 'POST', $attributes = array()) + public static function open_for_files($action = null, $method = 'POST', $attributes = array()) { $attributes['enctype'] = 'multipart/form-data'; - return static::open($action, $method, $attributes); - } - /** - * Close a HTML form. - * - * @return string - */ - public static function close() - { - return ''.PHP_EOL; + return static::open($action, $method, $attributes); } /** @@ -81,7 +64,7 @@ class Form { */ public static function token() { - return static::hidden('csrf_token', static::raw_token()); + return static::input('hidden', 'csrf_token', static::raw_token()); } /** @@ -91,10 +74,6 @@ class Form { */ public static function raw_token() { - // ------------------------------------------------------- - // CSRF tokens are stored in the session, so we need to - // make sure a driver has been specified. - // ------------------------------------------------------- if (Config::get('session.driver') == '') { throw new \Exception('Sessions must be enabled to retrieve a CSRF token.'); @@ -114,20 +93,21 @@ class Form { public static function label($name, $value, $attributes = array()) { static::$labels[] = $name; + return ''.PHP_EOL; } /** - * Create a HTML text input element. + * Create a HTML input element. * * @param string $name - * @param string $value + * @param mixed $value * @param array $attributes * @return string */ - public static function text($name, $value = null, $attributes = array()) + public static function input($type, $name, $value = null, $attributes = array()) { - return static::input('text', $name, $value, $attributes); + return ' $type, 'name' => $name, 'value' => $value, 'id' => static::id($name, $attributes)))).'>'.PHP_EOL; } /** @@ -136,22 +116,75 @@ class Form { * @param string $name * @param array $attributes * @return string - */ + */ public static function password($name, $attributes = array()) { return static::input('password', $name, null, $attributes); } /** - * Create a HTML hidden input element. + * Create a HTML search input element. * * @param string $name + * @param string $value * @param array $attributes * @return string - */ - public static function hidden($name, $value = null, $attributes = array()) + */ + public static function search($name, $value = null, $attributes = array()) { - return static::input('hidden', $name, $value, $attributes); + return static::input('search', $name, $value, $attributes); + } + + /** + * Create a HTML email input element. + * + * @param string $name + * @param string $value + * @param array $attributes + * @return string + */ + public static function email($name, $value = null, $attributes = array()) + { + return static::input('email', $name, $value, $attributes); + } + + /** + * Create a HTML telephone input element. + * + * @param string $name + * @param string $value + * @param array $attributes + * @return string + */ + public static function telephone($name, $value = null, $attributes = array()) + { + return static::input('tel', $name, $value, $attributes); + } + + /** + * Create a HTML URL input element. + * + * @param string $name + * @param string $value + * @param array $attributes + * @return string + */ + public static function url($name, $value = null, $attributes = array()) + { + return static::input('url', $name, $value, $attributes); + } + + /** + * Create a HTML number input element. + * + * @param string $name + * @param string $value + * @param array $attributes + * @return string + */ + public static function number($name, $value = null, $attributes = array()) + { + return static::input('number', $name, $value, $attributes); } /** @@ -167,28 +200,51 @@ class Form { } /** - * Create a HTML submit input element. - * - * @param string $name - * @param array $attributes - * @return string - */ - public static function submit($value, $attributes = array()) - { - return static::input('submit', null, $value, $attributes); - } - - /** - * Create a HTML button element. + * Create a HTML textarea element. * * @param string $name * @param string $value * @param array $attributes * @return string */ - public static function button($value, $attributes = array()) + public static function textarea($name, $value = '', $attributes = array()) { - return ''.HTML::entities($value).''.PHP_EOL; + $attributes = array_merge($attributes, array('id' => static::id($name, $attributes), 'name' => $name)); + + if ( ! isset($attributes['rows'])) + { + $attributes['rows'] = 10; + } + + if ( ! isset($attributes['cols'])) + { + $attributes['cols'] = 50; + } + + return ''.HTML::entities($value).''.PHP_EOL; + } + + /** + * Create a HTML select element. + * + * @param string $name + * @param array $options + * @param string $selected + * @param array $attributes + * @return string + */ + public static function select($name, $options = array(), $selected = null, $attributes = array()) + { + $attributes = array_merge($attributes, array('id' => static::id($name, $attributes), 'name' => $name)); + + $html = array(); + + foreach ($options as $value => $display) + { + $html[] = ' HTML::entities($value), 'selected' => ($value == $selected) ? 'selected' : null)).'>'.HTML::entities($display).''; + } + + return ''.implode('', $html).''.PHP_EOL; } /** @@ -231,117 +287,79 @@ class Form { */ private static function checkable($type, $name, $value, $checked, $attributes) { - if ($checked === true) - { - $attributes['checked'] = 'checked'; - } - - $attributes['id'] = static::id($name, $attributes); + $attributes = array_merge($attributes, array('id' => static::id($name, $attributes), 'checked' => ($checked) ? 'checked' : null)); return static::input($type, $name, $value, $attributes); } /** - * Create a HTML textarea element. + * Create a HTML submit input element. + * + * @param string $value + * @param array $attributes + * @return string + */ + public static function submit($value, $attributes = array()) + { + return static::input('submit', null, $value, $attributes); + } + + /** + * Create a HTML reset input element. + * + * @param string $value + * @param array $attributes + * @return string + */ + public static function reset($value, $attributes = array()) + { + return static::input('reset', null, $value, $attributes); + } + + /** + * Create a HTML image input element. + * + * @param string $url + * @param array $attributes + * @return string + */ + public static function image($url, $name = null, $attributes = array()) + { + $attributes['src'] = URL::to_asset($url); + + return static::input('image', $name, null, $attributes); + } + + /** + * Create a HTML button element. * * @param string $name * @param string $value * @param array $attributes * @return string */ - public static function textarea($name, $value = '', $attributes = array()) + public static function button($value, $attributes = array()) { - $attributes['name'] = $name; - $attributes['id'] = static::id($name, $attributes); - - // ------------------------------------------------------- - // Set the default number of rows. - // ------------------------------------------------------- - if ( ! isset($attributes['rows'])) - { - $attributes['rows'] = 10; - } - - // ------------------------------------------------------- - // Set the default number of columns. - // ------------------------------------------------------- - if ( ! isset($attributes['cols'])) - { - $attributes['cols'] = 50; - } - - return ''.HTML::entities($value).''.PHP_EOL; - } - - /** - * Create a HTML select element. - * - * @param string $name - * @param array $options - * @param string $selected - * @param array $attributes - * @return string - */ - public static function select($name, $options = array(), $selected = null, $attributes = array()) - { - $attributes['name'] = $name; - $attributes['id'] = static::id($name, $attributes); - - $html_options = array(); - - foreach ($options as $value => $display) - { - $option_attributes = array(); - - $option_attributes['value'] = HTML::entities($value); - $option_attributes['selected'] = ($value == $selected) ? 'selected' : null; - - $html_options[] = ''.HTML::entities($display).''; - } - - return ''.implode('', $html_options).''.PHP_EOL; - } - - /** - * Create a HTML input element. - * - * @param string $name - * @param mixed $value - * @param array $attributes - * @return string - */ - private static function input($type, $name, $value = null, $attributes = array()) - { - $attributes['type'] = $type; - $attributes['name'] = $name; - $attributes['value'] = $value; - $attributes['id'] = static::id($name, $attributes); - - return ''.PHP_EOL; + return ''.HTML::entities($value).''.PHP_EOL; } /** * Determine the ID attribute for a form element. * + * An explicitly specified ID in the attributes takes first precedence, then + * the label names will be checked for a label matching the element name. + * * @param string $name * @param array $attributes * @return mixed */ private static function id($name, $attributes) { - // ------------------------------------------------------- - // If an ID attribute was already explicitly specified - // for the element, just use that. - // ------------------------------------------------------- if (array_key_exists('id', $attributes)) { return $attributes['id']; } - // ------------------------------------------------------- - // If a label element was created with a value matching - // the name of the form element, use the name as the ID. - // ------------------------------------------------------- if (in_array($name, static::$labels)) { return $name; diff --git a/system/hash.php b/system/hash.php index 66a87e2d..de53321f 100644 --- a/system/hash.php +++ b/system/hash.php @@ -2,51 +2,43 @@ class Hash { - /** - * The salty, hashed value. - * - * @var string - */ - public $value; - /** - * The salt used during hashing. + * Hash a string using PHPass. * - * @var string - */ - public $salt; - - /** - * Create a new hash instance. - * - * @param string $value - * @param string $salt - * @return void - */ - public function __construct($value, $salt = null) - { - // ------------------------------------------------------- - // If no salt is given, we'll create a random salt to - // use when hashing the password. - // - // Otherwise, we will use the given salt. - // ------------------------------------------------------- - $this->salt = (is_null($salt)) ? Str::random(16) : $salt; - - $this->value = sha1($value.$this->salt); - } - - /** - * Factory for creating hash instances. + * PHPass provides reliable bcrypt hashing, and is used by many popular PHP + * applications such as Wordpress and Joomla. * * @access public * @param string $value - * @param string $salt - * @return Hash + * @return string */ - public static function make($value, $salt = null) + public static function make($value) { - return new self($value, $salt); + return static::hasher()->HashPassword($value); + } + + /** + * Determine if an unhashed value matches a given hash. + * + * @param string $value + * @param string $hash + * @return bool + */ + public static function check($value, $hash) + { + return static::hasher()->CheckPassword($value, $hash); + } + + /** + * Create a new PHPass instance. + * + * @return PasswordHash + */ + private static function hasher() + { + require_once SYS_PATH.'vendor/phpass'.EXT; + + return new \PasswordHash(10, false); } } \ No newline at end of file diff --git a/system/html.php b/system/html.php index 89968130..b568efc5 100644 --- a/system/html.php +++ b/system/html.php @@ -32,7 +32,7 @@ class HTML { */ public static function style($url, $media = 'all') { - return ''.PHP_EOL; + return ''.PHP_EOL; } /** @@ -146,29 +146,8 @@ class HTML { public static function image($url, $alt = '', $attributes = array()) { $attributes['alt'] = static::entities($alt); - return ''; - } - /** - * Generate HTML breaks. - * - * @param int $count - * @return string - */ - public static function breaks($count = 1) - { - return str_repeat('
', $count); - } - - /** - * Generate non-breaking spaces. - * - * @param int $count - * @return string - */ - public static function spaces($count = 1) - { - return str_repeat(' ', $count); + return ''; } /** @@ -227,6 +206,13 @@ class HTML { foreach ($attributes as $key => $value) { + // Assume numeric-keyed attributes to have the same key and value. + // Example: required="required", autofocus="autofocus", etc. + if (is_numeric($key)) + { + $key = $value; + } + if ( ! is_null($value)) { $html[] = $key.'="'.static::entities($value).'"'; @@ -246,30 +232,21 @@ class HTML { { $safe = ''; - // ------------------------------------------------------- - // Spin through the string letter by letter. - // ------------------------------------------------------- foreach (str_split($value) as $letter) { switch (rand(1, 3)) { - // ------------------------------------------------------- // Convert the letter to its entity representation. - // ------------------------------------------------------- case 1: $safe .= '&#'.ord($letter).';'; break; - // ------------------------------------------------------- // Convert the letter to a Hex character code. - // ------------------------------------------------------- case 2: $safe .= '&#x'.dechex(ord($letter)).';'; break; - // ------------------------------------------------------- // No encoding. - // ------------------------------------------------------- case 3: $safe .= $letter; } @@ -283,23 +260,21 @@ class HTML { */ public static function __callStatic($method, $parameters) { - // ------------------------------------------------------- // Handle the dynamic creation of links to secure routes. - // ------------------------------------------------------- if (strpos($method, 'link_to_secure_') === 0) { array_unshift($parameters, substr($method, 15)); return forward_static_call_array('HTML::link_to_secure_route', $parameters); } - // ------------------------------------------------------- // Handle the dynamic creation of links to routes. - // ------------------------------------------------------- if (strpos($method, 'link_to_') === 0) { array_unshift($parameters, substr($method, 8)); return forward_static_call_array('HTML::link_to_route', $parameters); } + + throw new \Exception("Static method [$method] is not defined on the HTML class."); } } \ No newline at end of file diff --git a/system/input.php b/system/input.php index ffcc911c..cabe1f96 100644 --- a/system/input.php +++ b/system/input.php @@ -9,6 +9,18 @@ class Input { */ public static $input; + /** + * Get all of the input data for the request. + * + * This method returns a merged array containing Input::get and Input::file. + * + * @return array + */ + public static function all() + { + return array_merge(static::get(), static::file()); + } + /** * Determine if the input data contains an item. * @@ -57,10 +69,6 @@ class Input { */ public static function old($key = null, $default = null) { - // ---------------------------------------------------------- - // Since old input data is flashed to the session, we need - // to make sure a session driver has been specified. - // ---------------------------------------------------------- if (Config::get('session.driver') == '') { throw new \Exception("Sessions must be enabled to retrieve old input data."); @@ -78,6 +86,13 @@ class Input { */ public static function file($key = null, $default = null) { + if (strpos($key, '.') !== false) + { + list($file, $key) = explode('.', $key); + + return Arr::get($_FILES[$file], $key, $default); + } + return Arr::get($_FILES, $key, $default); } @@ -100,20 +115,10 @@ class Input { case 'PUT': case 'DELETE': - // ---------------------------------------------------------------------- - // Typically, browsers do not support PUT and DELETE methods on HTML - // forms. So, we simulate them using a hidden POST variable. - // - // If the request method is being "spoofed", we'll move the POST array - // into the PUT / DELETE array. - // ---------------------------------------------------------------------- - if (isset($_POST['request_method']) and ($_POST['request_method'] == 'PUT' or $_POST['request_method'] == 'DELETE')) + if (Request::spoofed()) { static::$input =& $_POST; } - // ---------------------------------------------------------------------- - // If the request is a true PUT request, read the php://input file. - // ---------------------------------------------------------------------- else { parse_str(file_get_contents('php://input'), static::$input); diff --git a/system/lang.php b/system/lang.php index d74fd017..1611bd56 100644 --- a/system/lang.php +++ b/system/lang.php @@ -28,6 +28,10 @@ class Lang { /** * Create a new Lang instance. * + * Language lines are retrieved using "dot" notation. So, asking for the + * "messages.required" language line would return the "required" line + * from the "messages" language file. + * * @param string $line * @return void */ @@ -50,42 +54,28 @@ class Lang { /** * Get the language line. * + * @param string $language * @param mixed $default * @return string */ - public function get($default = null) + public function get($language = null, $default = null) { - $language = Config::get('application.language'); + if (is_null($language)) + { + $language = Config::get('application.language'); + } list($file, $line) = $this->parse($this->key); $this->load($file, $language); - // -------------------------------------------------------------- - // If the language file did not exist, return the default value. - // -------------------------------------------------------------- - if ( ! array_key_exists($language.$file, static::$lines)) + if ( ! isset(static::$lines[$language.$file][$line])) { - return $default; + return is_callable($default) ? call_user_func($default) : $default; } - // -------------------------------------------------------------- - // Get the language line from the appropriate file array. - // If the line doesn't exist, return the default value. - // -------------------------------------------------------------- - if (array_key_exists($line, static::$lines[$language.$file])) - { - $line = static::$lines[$language.$file][$line]; - } - else - { - return $default; - } + $line = static::$lines[$language.$file][$line]; - // -------------------------------------------------------------- - // Make all place-holder replacements. Place-holders are prefixed - // with a colon for convenient location. - // -------------------------------------------------------------- foreach ($this->replacements as $key => $value) { $line = str_replace(':'.$key, $value, $line); @@ -97,15 +87,14 @@ class Lang { /** * Parse a language key. * + * The value on the left side of the dot is the language file name, + * while the right side of the dot is the item within that file. + * * @param string $key * @return array */ private function parse($key) { - // -------------------------------------------------------------- - // The left side of the dot is the file name, while the right - // side of the dot is the item within that file being requested. - // -------------------------------------------------------------- $segments = explode('.', $key); if (count($segments) < 2) @@ -125,16 +114,10 @@ class Lang { */ private function load($file, $language) { - // -------------------------------------------------------------- - // If we have already loaded the language file or the file - // doesn't exist, bail out. - // -------------------------------------------------------------- - if (array_key_exists($language.$file, static::$lines) or ! file_exists($path = APP_PATH.'lang/'.$language.'/'.$file.EXT)) + if ( ! array_key_exists($language.$file, static::$lines) and file_exists($path = APP_PATH.'lang/'.$language.'/'.$file.EXT)) { - return; + static::$lines[$language.$file] = require $path; } - - static::$lines[$language.$file] = require $path; } /** diff --git a/system/loader.php b/system/loader.php index 86960f89..adf3a126 100644 --- a/system/loader.php +++ b/system/loader.php @@ -2,46 +2,31 @@ /** * This function is registered on the auto-loader stack by the front controller. + * + * All namespace slashes will be replaced with directory slashes since all Laravel + * system classes are organized using a namespace to directory convention. */ return function($class) { - // ---------------------------------------------------------- - // Replace namespace slashes with directory slashes. - // ---------------------------------------------------------- $file = strtolower(str_replace('\\', '/', $class)); - // ---------------------------------------------------------- - // Should the class be aliased? - // ---------------------------------------------------------- if (array_key_exists($class, $aliases = System\Config::get('aliases'))) { return class_alias($aliases[$class], $class); } - // ---------------------------------------------------------- - // Is the class a Laravel framework class? - // ---------------------------------------------------------- if (file_exists($path = BASE_PATH.$file.EXT)) { require $path; } - // ---------------------------------------------------------- - // Is the class in the application/models directory? - // ---------------------------------------------------------- elseif (file_exists($path = APP_PATH.'models/'.$file.EXT)) { require $path; } - // ---------------------------------------------------------- - // Is the class in the application/libraries directory? - // ---------------------------------------------------------- elseif (file_exists($path = APP_PATH.'libraries/'.$file.EXT)) { require $path; } - // ---------------------------------------------------------- - // Is the class anywhere in the application directory? - // ---------------------------------------------------------- elseif (file_exists($path = APP_PATH.$file.EXT)) { require $path; diff --git a/system/log.php b/system/log.php deleted file mode 100644 index eba9d5d0..00000000 --- a/system/log.php +++ /dev/null @@ -1,83 +0,0 @@ -addServer($server['host'], $server['port'], true, $server['weight']); } - // ----------------------------------------------------- - // Verify Memcache was configured successfully. - // ----------------------------------------------------- if ($memcache->getVersion() === false) { throw new \Exception('Memcached is configured. However, no connections could be made. Please verify your memcached configuration.'); diff --git a/system/redirect.php b/system/redirect.php index 70d764bb..df3eb094 100644 --- a/system/redirect.php +++ b/system/redirect.php @@ -34,8 +34,8 @@ class Redirect { $url = URL::to($url, $https); return ($method == 'refresh') - ? new static(Response::make('', $status)->header('Refresh', '0;url='.$url)) - : new static(Response::make('', $status)->header('Location', $url)); + ? new static(Response::make('', $status)->header('Refresh', '0;url='.$url)) + : new static(Response::make('', $status)->header('Location', $url)); } /** @@ -60,15 +60,13 @@ class Redirect { */ public function with($key, $value) { - // ---------------------------------------------------- - // Since this method uses sessions, make sure a driver - // has been specified in the configuration file. - // ---------------------------------------------------- - if (Config::get('session.driver') != '') + if (Config::get('session.driver') == '') { - Session::flash($key, $value); + throw new \Exception("Attempting to flash data to the session, but no session driver has been specified."); } + Session::flash($key, $value); + return $this; } @@ -79,17 +77,13 @@ class Redirect { { $parameters = (isset($parameters[0])) ? $parameters[0] : array(); - // ---------------------------------------------------- // Dynamically redirect to a secure route URL. - // ---------------------------------------------------- if (strpos($method, 'to_secure_') === 0) { return static::to(URL::to_route(substr($method, 10), $parameters, true)); } - // ---------------------------------------------------- // Dynamically redirect a route URL. - // ---------------------------------------------------- if (strpos($method, 'to_') === 0) { return static::to(URL::to_route(substr($method, 3), $parameters)); diff --git a/system/request.php b/system/request.php index 70986c41..6381dd43 100644 --- a/system/request.php +++ b/system/request.php @@ -2,13 +2,6 @@ class Request { - /** - * The request URI. - * - * @var string - */ - public static $uri; - /** * The route handling the current request. * @@ -19,66 +12,46 @@ class Request { /** * Get the request URI. * + * The server PATH_INFO will be used if available. Otherwise, the REQUEST_URI will be used. + * The application URL and index will be removed from the URI. + * + * If the request is to the root of application, a single forward slash will be returned. + * * @return string */ public static function uri() { - if ( ! is_null(static::$uri)) - { - return static::$uri; - } - - // ------------------------------------------------------- - // Use the PATH_INFO variable if it is available. - // ------------------------------------------------------- if (isset($_SERVER['PATH_INFO'])) { $uri = $_SERVER['PATH_INFO']; } - // ------------------------------------------------------- - // No PATH_INFO? Let's try REQUEST_URI. - // ------------------------------------------------------- elseif (isset($_SERVER['REQUEST_URI'])) { $uri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH); - - if ($uri === false) - { - throw new \Exception("Malformed request URI. Request terminated."); - } } else { throw new \Exception('Unable to determine the request URI.'); } - // ------------------------------------------------------- - // Remove the application URL. - // ------------------------------------------------------- - $base_url = parse_url(Config::get('application.url'), PHP_URL_PATH); - - if (strpos($uri, $base_url) === 0) + if ($uri === false) { - $uri = (string) substr($uri, strlen($base_url)); + throw new \Exception("Malformed request URI. Request terminated."); } - // ------------------------------------------------------- - // Remove the application index and any extra slashes. - // ------------------------------------------------------- - $index = Config::get('application.index'); - - if (strpos($uri, '/'.$index) === 0) + // Remove the application URL from the URI. + if (strpos($uri, $base = parse_url(Config::get('application.url'), PHP_URL_PATH)) === 0) { - $uri = (string) substr($uri, strlen('/'.$index)); + $uri = substr($uri, strlen($base)); } - $uri = trim($uri, '/'); + // Remove the application index page from the URI. + if (strpos($uri, $index = '/'.Config::get('application.index')) === 0) + { + $uri = substr($uri, strlen($index)); + } - // ------------------------------------------------------- - // If the requests is to the root of the application, we - // always return a single forward slash. - // ------------------------------------------------------- - return ($uri == '') ? '/' : strtolower($uri); + return (($uri = trim($uri, '/')) == '') ? '/' : strtolower($uri); } /** @@ -88,11 +61,20 @@ class Request { */ public static function method() { - // -------------------------------------------------------------- - // The method can be spoofed using a POST variable, allowing HTML - // forms to simulate PUT and DELETE requests. - // -------------------------------------------------------------- - return Arr::get($_POST, 'REQUEST_METHOD', $_SERVER['REQUEST_METHOD']); + return (static::spoofed()) ? $_POST['REQUEST_METHOD'] : $_SERVER['REQUEST_METHOD']; + } + + /** + * Determine if the request method is being spoofed by a hidden Form element. + * + * Hidden form elements are used to spoof PUT and DELETE requests since + * they are not supported by HTML forms. + * + * @return bool + */ + public static function spoofed() + { + return is_array($_POST) and array_key_exists('REQUEST_METHOD', $_POST); } /** @@ -162,11 +144,7 @@ class Request { */ public static function __callStatic($method, $parameters) { - // -------------------------------------------------------------- - // Dynamically call the "is" method using the given name. - // - // Example: Request::is_login() - // -------------------------------------------------------------- + // Dynamically determine if a given route is handling the request. if (strpos($method, 'route_is_') === 0) { return static::route_is(substr($method, 9)); diff --git a/system/response.php b/system/response.php index a3d1b5cc..c1734d2b 100644 --- a/system/response.php +++ b/system/response.php @@ -109,10 +109,6 @@ class Response { */ public static function prepare($response) { - // -------------------------------------------------------------- - // If the response is a Redirect instance, grab the Response. - // The Redirect class manages a Response instance internally. - // -------------------------------------------------------------- if ($response instanceof Redirect) { $response = $response->response; @@ -181,4 +177,12 @@ class Response { return $this->status == 301 or $this->status == 302; } + /** + * Get the parsed content of the Response. + */ + public function __toString() + { + return (string) $this->content; + } + } \ No newline at end of file diff --git a/system/route.php b/system/route.php index 451bf718..62ce1cce 100644 --- a/system/route.php +++ b/system/route.php @@ -43,33 +43,20 @@ class Route { * * @param mixed $route * @param array $parameters - * @return mixed + * @return Response */ public function call() { $response = null; - // ------------------------------------------------------------ - // If the route value is just a function, all we have to do - // is execute the function! There are no filters to call. - // ------------------------------------------------------------ if (is_callable($this->callback)) { $response = call_user_func_array($this->callback, $this->parameters); } - // ------------------------------------------------------------ - // If the route value is an array, we'll need to check it for - // any filters that may be attached. - // ------------------------------------------------------------ elseif (is_array($this->callback)) { $response = isset($this->callback['before']) ? Route\Filter::call($this->callback['before'], array(), true) : null; - // ------------------------------------------------------------ - // We verify that the before filters did not return a response - // Before filters can override the request cycle to make things - // like authentication convenient to implement. - // ------------------------------------------------------------ if (is_null($response) and isset($this->callback['do'])) { $response = call_user_func_array($this->callback['do'], $this->parameters); diff --git a/system/route/filter.php b/system/route/filter.php index 6b1c59f7..2118595e 100644 --- a/system/route/filter.php +++ b/system/route/filter.php @@ -24,9 +24,6 @@ class Filter { static::$filters = require APP_PATH.'filters'.EXT; } - // -------------------------------------------------------------- - // Filters can be comma-delimited, so spin through each one. - // -------------------------------------------------------------- foreach (explode(', ', $filters) as $filter) { if ( ! isset(static::$filters[$filter])) @@ -36,13 +33,6 @@ class Filter { $response = call_user_func_array(static::$filters[$filter], $parameters); - // -------------------------------------------------------------- - // If overriding is set to true and the filter returned a - // response, return that response. - // - // Overriding allows for convenient halting of the request - // flow for things like authentication, CSRF protection, etc. - // -------------------------------------------------------------- if ( ! is_null($response) and $override) { return $response; diff --git a/system/route/finder.php b/system/route/finder.php index 374da874..f04c1d0c 100644 --- a/system/route/finder.php +++ b/system/route/finder.php @@ -24,6 +24,9 @@ class Finder { */ public static function find($name) { + // This class maintains its own list of routes because the router only loads routes that + // are applicable to the current request URI. But, this class obviously needs access + // to all of the routes, not just the ones applicable to the request URI. if (is_null(static::$routes)) { static::$routes = (is_dir(APP_PATH.'routes')) ? static::load() : require APP_PATH.'routes'.EXT; @@ -34,12 +37,7 @@ class Finder { return static::$names[$name]; } - // --------------------------------------------------------- - // We haven't located the route before, so we'll need to - // iterate through each route to find the matching name. - // --------------------------------------------------------- - $arrayIterator = new \RecursiveArrayIterator(static::$routes); - $recursiveIterator = new \RecursiveIteratorIterator($arrayIterator); + $recursiveIterator = new \RecursiveIteratorIterator($arrayIterator = new \RecursiveArrayIterator(static::$routes)); foreach ($recursiveIterator as $iterator) { diff --git a/system/route/loader.php b/system/route/loader.php deleted file mode 100644 index d03a1d5d..00000000 --- a/system/route/loader.php +++ /dev/null @@ -1,52 +0,0 @@ - $callback) { - // -------------------------------------------------------------- // Only check routes that have multiple URIs or wildcards. - // All other routes would have been caught by a literal match. - // -------------------------------------------------------------- + // Other routes would have been caught by the check for literal matches. if (strpos($keys, '(') !== false or strpos($keys, ',') !== false ) { - // -------------------------------------------------------------- - // Routes can be comma-delimited, so spin through each one. - // -------------------------------------------------------------- foreach (explode(', ', $keys) as $key) { - $key = str_replace(':num', '[0-9]+', str_replace(':any', '[a-zA-Z0-9\-_]+', $key)); - - if (preg_match('#^'.$key.'$#', $method.' '.$uri)) + if (preg_match('#^'.static::translate_wildcards($key).'$#', $uri)) { - return Request::$route = new Route($keys, $callback, Route\Parser::parameters($uri, $key)); + return Request::$route = new Route($keys, $callback, static::parameters($uri, $key)); } } } } } + /** + * Load the appropriate route file for the request URI. + * + * @param string $uri + * @return array + */ + public static function load($uri) + { + $base = require APP_PATH.'routes'.EXT; + + return (is_dir(APP_PATH.'routes') and $uri !== '') ? array_merge(static::load_from_directory($uri), $base) : $base; + } + + /** + * Load the appropriate route file from the routes directory. + * + * @param string $uri + * @return array + */ + private static function load_from_directory($uri) + { + $segments = explode('/', $uri); + + return (file_exists($path = APP_PATH.'routes/'.$segments[0].EXT)) ? require $path : array(); + } + + /** + * Translate route URI wildcards into actual regular expressions. + * + * @param string $key + * @return string + */ + private static function translate_wildcards($key) + { + $replacements = 0; + + // For optional parameters, first translate the wildcards to their regex equivalent, sans the ")?" ending. + $key = str_replace(array('/(:num?)', '/(:any?)'), array('(?:/([0-9]+)', '(?:/([a-zA-Z0-9\-_]+)'), $key, $replacements); + + // Now, to properly close the regular expression, we need to append a ")?" for each optional segment in the route. + if ($replacements > 0) + { + $key .= implode('', array_fill(0, $replacements, ')?')); + } + + return str_replace(array(':num', ':any'), array('[0-9]+', '[a-zA-Z0-9\-_]+'), $key); + } + + /** + * Extract the parameters from a URI based on a route URI. + * + * Any route segment wrapped in parentheses is considered a parameter. + * + * @param string $uri + * @param string $route + * @return array + */ + private static function parameters($uri, $route) + { + return array_values(array_intersect_key(explode('/', $uri), preg_grep('/\(.+\)/', explode('/', $route)))); + } + } \ No newline at end of file diff --git a/system/session.php b/system/session.php index 1a6dc681..cde095ac 100644 --- a/system/session.php +++ b/system/session.php @@ -7,14 +7,14 @@ class Session { * * @var Session\Driver */ - private static $driver; + public static $driver; /** * The session. * * @var array */ - private static $session = array(); + public static $session = array(); /** * Get the session driver. @@ -25,38 +25,47 @@ class Session { { if (is_null(static::$driver)) { - static::$driver = Session\Factory::make(Config::get('session.driver')); + switch (Config::get('session.driver')) + { + case 'file': + static::$driver = new Session\Driver\File; + break; + + case 'db': + static::$driver = new Session\Driver\DB; + break; + + case 'memcached': + static::$driver = new Session\Driver\Memcached; + break; + + case 'apc': + static::$driver = new Session\Driver\APC; + break; + + default: + throw new \Exception("Session driver [$driver] is not supported."); + } } return static::$driver; } /** - * Load the session for the user. + * Load a user session by ID. * + * @param string $id * @return void */ - public static function load() + public static function load($id) { - if ( ! is_null($id = Cookie::get('laravel_session'))) + static::$session = ( ! is_null($id)) ? static::driver()->load($id) : null; + + if (is_null(static::$session) or static::expired(static::$session['last_activity'])) { - static::$session = static::driver()->load($id); + static::$session = array('id' => Str::random(40), 'data' => array()); } - // --------------------------------------------------------- - // If the session is invalid or expired, start a new one. - // --------------------------------------------------------- - if (is_null($id) or is_null(static::$session) or static::expired(static::$session['last_activity'])) - { - static::$session['id'] = Str::random(40); - static::$session['data'] = array(); - } - - // --------------------------------------------------------- - // Create a CSRF token for the session if necessary. This - // token is used by the Form class and filters to protect - // against cross-site request forgeries. - // --------------------------------------------------------- if ( ! static::has('csrf_token')) { static::put('csrf_token', Str::random(16)); @@ -110,7 +119,7 @@ class Session { return static::$session['data'][':new:'.$key]; } - return $default; + return is_callable($default) ? call_user_func($default) : $default; } /** @@ -165,13 +174,6 @@ class Session { */ public static function regenerate() { - // --------------------------------------------------------- - // When regenerating the session ID, we go ahead and delete - // the session data from storage. Then, we assign a new ID. - // - // The session will be re-written to storage at the end - // of the request to the application. - // --------------------------------------------------------- static::driver()->delete(static::$session['id']); static::$session['id'] = Str::random(40); @@ -184,37 +186,22 @@ class Session { */ public static function close() { - // --------------------------------------------------------- - // Flash the old input data to the session. This allows - // the Input::old method to retrieve input from the - // previous request made by the user. - // --------------------------------------------------------- + // Flash the old input data to the session. This allows the Input::old method to + // retrieve the input from the previous request made by the user. static::flash('laravel_old_input', Input::get()); static::age_flash(); static::driver()->save(static::$session); - // --------------------------------------------------------- - // Send the session cookie the browser so we can remember - // who the session belongs to on subsequent requests. - // --------------------------------------------------------- if ( ! headers_sent()) { - $cookie = new Cookie('laravel_session', static::$session['id']); + $minutes = (Config::get('session.expire_on_close')) ? 0 : Config::get('session.lifetime'); - $cookie->lifetime = (Config::get('session.expire_on_close')) ? 0 : Config::get('session.lifetime'); - $cookie->path = Config::get('session.path'); - $cookie->domain = Config::get('session.domain'); - $cookie->secure = Config::get('session.https'); - - $cookie->send(); + Cookie::put('laravel_session', static::$session['id'], $minutes, Config::get('session.path'), Config::get('session.domain'), Config::get('session.https')); } - // --------------------------------------------------------- - // Perform session garbage collection (2% chance). - // Session garbage collection removes all expired sessions. - // --------------------------------------------------------- + // 2% chance of performing session garbage collection... if (mt_rand(1, 100) <= 2) { static::driver()->sweep(time() - (Config::get('session.lifetime') * 60)); @@ -228,9 +215,6 @@ class Session { */ private static function age_flash() { - // ----------------------------------------------------- - // Remove all of the :old: items from the session. - // ----------------------------------------------------- foreach (static::$session['data'] as $key => $value) { if (strpos($key, ':old:') === 0) @@ -239,10 +223,6 @@ class Session { } } - // ----------------------------------------------------- - // Copy all of the :new: items to :old: items and then - // remove the :new: items from the session. - // ----------------------------------------------------- foreach (static::$session['data'] as $key => $value) { if (strpos($key, ':new:') === 0) diff --git a/system/session/driver/db.php b/system/session/driver/db.php index f16e3c85..969c642c 100644 --- a/system/session/driver/db.php +++ b/system/session/driver/db.php @@ -27,6 +27,7 @@ class DB implements \System\Session\Driver { public function save($session) { $this->delete($session['id']); + $this->table()->insert(array('id' => $session['id'], 'last_activity' => $session['last_activity'], 'data' => serialize($session['data']))); } diff --git a/system/session/factory.php b/system/session/factory.php deleted file mode 100644 index 822cd074..00000000 --- a/system/session/factory.php +++ /dev/null @@ -1,32 +0,0 @@ -= $limit) - { - $out = trim($out); - - return (strlen($out) == strlen($value)) ? $out : $out.$end; - } - } - } - - /** - * Censor a string. - * - * @param string $value - * @param array $censored - * @param string $replacement - * @return string - */ - public static function censor($value, $censored, $replacement = '####') - { - $value = ' '.$value.' '; - - // ----------------------------------------------------- - // Assume the word will be book-ended by the following. - // ----------------------------------------------------- - $delim = '[-_\'\"`(){}<>\[\]|!?@#%&,.:;^~*+=\/ 0-9\n\r\t]'; - - // ----------------------------------------------------- - // Replace the censored words. - // ----------------------------------------------------- - foreach ($censored as $word) - { - if ($replacement != '') - { - $value = preg_replace("/({$delim})(".str_replace('\*', '\w*?', preg_quote($word, '/')).")({$delim})/i", "\\1{$replacement}\\3", $value); - } - else - { - $value = preg_replace("/({$delim})(".str_replace('\*', '\w*?', preg_quote($word, '/')).")({$delim})/ie", "'\\1'.str_repeat('#', strlen('\\2')).'\\3'", $value); - } - } - - return trim($value); - } - -} \ No newline at end of file diff --git a/system/url.php b/system/url.php index dfcd8208..76a615d3 100644 --- a/system/url.php +++ b/system/url.php @@ -12,9 +12,6 @@ class URL { */ public static function to($url = '', $https = false, $asset = false) { - // ---------------------------------------------------- - // Return the URL unchanged if it is already formed. - // ---------------------------------------------------- if (strpos($url, '://') !== false) { return $url; @@ -22,19 +19,11 @@ class URL { $base = Config::get('application.url'); - // ---------------------------------------------------- - // Assets live in the public directory, so we don't - // want to append the index file to the URL if the - // URL is to an asset. - // ---------------------------------------------------- if ( ! $asset) { $base .= '/'.Config::get('application.index'); } - // ---------------------------------------------------- - // Does the URL need an HTTPS protocol? - // ---------------------------------------------------- if (strpos($base, 'http://') === 0 and $https) { $base = 'https://'.substr($base, 7); @@ -61,7 +50,7 @@ class URL { * @param string $url * @return string */ - public static function to_asset($url) + public static function to_asset($url = '') { return static::to($url, false, true); } @@ -69,6 +58,10 @@ class URL { /** * Generate a URL from a route name. * + * For routes that have wildcard parameters, an array may be passed as the + * second parameter to the method. The values of this array will be used + * to fill the wildcard segments of the route URI. + * * @param string $name * @param array $parameters * @param bool $https @@ -78,18 +71,10 @@ class URL { { if ( ! is_null($route = Route\Finder::find($name))) { - // ---------------------------------------------------- - // Get the first URI assigned to the route. - // ---------------------------------------------------- $uris = explode(', ', key($route)); $uri = substr($uris[0], strpos($uris[0], '/')); - // ---------------------------------------------------- - // Replace any parameters in the URI. This allows - // the dynamic creation of URLs that contain parameter - // wildcards. - // ---------------------------------------------------- foreach ($parameters as $parameter) { $uri = preg_replace('/\(.+?\)/', $parameter, $uri, 1); @@ -122,16 +107,10 @@ class URL { */ public static function slug($title, $separator = '-') { - // ---------------------------------------------------- - // Remove all characters that are not the separator, - // letters, numbers, or whitespace. - // ---------------------------------------------------- + // Remove all characters that are not the separator, letters, numbers, or whitespace. $title = preg_replace('![^'.preg_quote($separator).'\pL\pN\s]+!u', '', Str::lower($title)); - // ---------------------------------------------------- - // Replace all separator characters and whitespace by - // a single separator - // ---------------------------------------------------- + // Replace all separator characters and whitespace by a single separator $title = preg_replace('!['.preg_quote($separator).'\s]+!u', $separator, $title); return trim($title, $separator); @@ -144,17 +123,13 @@ class URL { { $parameters = (isset($parameters[0])) ? $parameters[0] : array(); - // ---------------------------------------------------- // Dynamically create a secure route URL. - // ---------------------------------------------------- if (strpos($method, 'to_secure_') === 0) { return static::to_route(substr($method, 10), $parameters, true); } - // ---------------------------------------------------- // Dynamically create a route URL. - // ---------------------------------------------------- if (strpos($method, 'to_') === 0) { return static::to_route(substr($method, 3), $parameters); diff --git a/system/validation/error_collector.php b/system/validation/errors.php similarity index 78% rename from system/validation/error_collector.php rename to system/validation/errors.php index b0bbee9b..722eaa84 100644 --- a/system/validation/error_collector.php +++ b/system/validation/errors.php @@ -1,6 +1,6 @@ messages) or ! is_array($this->messages[$attribute]) or ! in_array($message, $this->messages[$attribute])) { $this->messages[$attribute][] = $message; @@ -94,10 +88,6 @@ class Error_Collector { { $all = array(); - // --------------------------------------------------------- - // Add each error message to the array of messages. Each - // messages will have the specified format applied to it. - // --------------------------------------------------------- foreach ($this->messages as $messages) { $all = array_merge($all, $this->format($messages, $format)); diff --git a/system/validation/message.php b/system/validation/message.php deleted file mode 100644 index 34fc95a1..00000000 --- a/system/validation/message.php +++ /dev/null @@ -1,155 +0,0 @@ -error)) - { - $class = explode('\\', get_class($rule)); - - $rule->error = strtolower(end($class)); - } - - return (is_null($rule->message)) ? Lang::line('validation.'.$rule->error)->get() : $rule->message; - } - - /** - * Get the error message for a Rangable rule. - * - * @param Rule $rule - * @return string - */ - private static function get_rangable_message($rule) - { - // --------------------------------------------------------- - // Rangable rules sometimes set a "presence_of" error. - // - // This occurs when an attribute is null and the option to - // allow null values has not been set. - // --------------------------------------------------------- - if ($rule->error == 'presence_of') - { - return static::get_message($rule); - } - - // --------------------------------------------------------- - // Slice "number_" or "string_" off of the error type. - // --------------------------------------------------------- - $error_type = substr($rule->error, 7); - - return (is_null($rule->$error_type)) ? Lang::line('validation.'.$rule->error)->get() : $rule->$error_type; - } - - /** - * Get the error message for an Upload_Of rule. - * - * @param Rule $rule - * @return string - */ - private static function get_upload_of_message($rule) - { - // --------------------------------------------------------- - // Upload_Of rules sometimes set a "presence_of" error. - // - // This occurs when the uploaded file didn't exist and the - // "not_required" method was not called. - // --------------------------------------------------------- - if ($rule->error == 'presence_of') - { - return static::get_message($rule); - } - - // --------------------------------------------------------- - // Slice "file_" off of the error type. - // --------------------------------------------------------- - $error_type = substr($rule->error, 5); - - return (is_null($rule->$error_type)) ? Lang::line('validation.'.$rule->error)->get() : $rule->$error_type; - } - - /** - * Prepare an error message for display. All place-holders will be replaced - * with their actual values. - * - * @param Rule $rule - * @param string $attribute - * @param string $message - * @return string - */ - private static function prepare($rule, $attribute, $message) - { - // --------------------------------------------------------- - // The rangable rule messages have three place-holders that - // must be replaced. - // - // :max = The maximum size of the attribute. - // :min = The minimum size of the attribute. - // :size = The exact size the attribute must be. - // --------------------------------------------------------- - if ($rule instanceof Rangable_Rule) - { - $message = str_replace(':max', $rule->maximum, $message); - $message = str_replace(':min', $rule->minimum, $message); - $message = str_replace(':size', $rule->size, $message); - } - // --------------------------------------------------------- - // The Upload_Of rule message have two place-holders taht - // must be replaced. - // - // :max = The maximum file size of the upload (kilobytes). - // :types = The allowed file types for the upload. - // --------------------------------------------------------- - elseif ($rule instanceof Rules\Upload_Of) - { - $message = str_replace(':max', $rule->maximum, $message); - - if (is_array($rule->types)) - { - $message = str_replace(':types', implode(', ', $rule->types), $message); - } - } - - return str_replace(':attribute', Lang::line('attributes.'.$attribute)->get(str_replace('_', ' ', $attribute)), $message); - } - -} \ No newline at end of file diff --git a/system/validation/nullable_rule.php b/system/validation/nullable_rule.php deleted file mode 100644 index 40f43f6e..00000000 --- a/system/validation/nullable_rule.php +++ /dev/null @@ -1,94 +0,0 @@ -allow_null) - { - $this->error = 'presence_of'; - } - - return is_null($this->error); - } - - // ------------------------------------------------------------- - // Make sure the attribute is not an empty string. An error - // will be raised if the attribute is empty and empty strings - // are not allowed, halting the child's validation. - // ------------------------------------------------------------- - elseif (Str::length((string) $attributes[$attribute]) == 0 and ! $this->allow_empty) - { - $this->error = 'presence_of'; - - return false; - } - } - - /** - * Allow a empty and null to be considered valid. - * - * @return Nullable_Rule - */ - public function not_required() - { - return $this->allow_empty()->allow_null(); - } - - /** - * Allow empty to be considered valid. - * - * @return Nullable_Rule - */ - public function allow_empty() - { - $this->allow_empty = true; - return $this; - } - - /** - * Allow null to be considered valid. - * - * @return Nullable_Rule - */ - public function allow_null() - { - $this->allow_null = true; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rangable_rule.php b/system/validation/rangable_rule.php deleted file mode 100644 index 1845ca29..00000000 --- a/system/validation/rangable_rule.php +++ /dev/null @@ -1,145 +0,0 @@ -size = $size; - return $this; - } - - /** - * Set the minimum and maximum size of the attribute. - * - * @param int $minimum - * @param int $maximum - * @return Rangable_Rule - */ - public function between($minimum, $maximum) - { - $this->minimum = $minimum; - $this->maximum = $maximum; - - return $this; - } - - /** - * Set the minimum size the attribute. - * - * @param int $minimum - * @return Rangable_Rule - */ - public function minimum($minimum) - { - $this->minimum = $minimum; - return $this; - } - - /** - * Set the maximum size the attribute. - * - * @param int $maximum - * @return Rangable_Rule - */ - public function maximum($maximum) - { - $this->maximum = $maximum; - return $this; - } - - /** - * Set the validation error message. - * - * @param string $message - * @return Rangable_Rule - */ - public function message($message) - { - return $this->wrong_size($message)->too_big($message)->too_small($message); - } - - /** - * Set the "wrong size" error message. - * - * @param string $message - * @return Rangable_Rule - */ - public function wrong_size($message) - { - $this->wrong_size = $message; - return $this; - } - - /** - * Set the "too big" error message. - * - * @param string $message - * @return Rangable_Rule - */ - public function too_big($message) - { - $this->too_big = $message; - return $this; - } - - /** - * Set the "too small" error message. - * - * @param string $message - * @return Rangable_Rule - */ - public function too_small($message) - { - $this->too_small = $message; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rule.php b/system/validation/rule.php deleted file mode 100644 index fa0c6692..00000000 --- a/system/validation/rule.php +++ /dev/null @@ -1,72 +0,0 @@ -attributes = $attributes; - } - - /** - * Run the validation rule. - * - * @param array $attributes - * @param Error_Collector $errors - * @return void - */ - public function validate($attributes, $errors) - { - foreach ($this->attributes as $attribute) - { - $this->error = null; - - if ( ! $this->check($attribute, $attributes)) - { - $errors->add($attribute, Message::get($this, $attribute)); - } - } - } - - /** - * Set the validation error message. - * - * @param string $message - * @return Rule - */ - public function message($message) - { - $this->message = $message; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/acceptance_of.php b/system/validation/rules/acceptance_of.php deleted file mode 100644 index 02b505a9..00000000 --- a/system/validation/rules/acceptance_of.php +++ /dev/null @@ -1,39 +0,0 @@ -accepts; - } - - /** - * Set the accepted value. - * - * @param string $value - * @return Acceptance_Of - */ - public function accepts($value) - { - $this->accepts = $value; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/confirmation_of.php b/system/validation/rules/confirmation_of.php deleted file mode 100644 index a6d7de0e..00000000 --- a/system/validation/rules/confirmation_of.php +++ /dev/null @@ -1,25 +0,0 @@ -reserved); - } - - /** - * Set the reserved values for the attribute - * - * @param array $reserved - * @return Exclusion_Of - */ - public function from($reserved) - { - $this->reserved = $reserved; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/format_of.php b/system/validation/rules/format_of.php deleted file mode 100644 index dfcebb16..00000000 --- a/system/validation/rules/format_of.php +++ /dev/null @@ -1,43 +0,0 @@ -expression, $attributes[$attribute]); - } - - /** - * Set the regular expression. - * - * @param string $expression - * @return Format_Of - */ - public function using($expression) - { - $this->expression = $expression; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/inclusion_of.php b/system/validation/rules/inclusion_of.php deleted file mode 100644 index f92ace6f..00000000 --- a/system/validation/rules/inclusion_of.php +++ /dev/null @@ -1,43 +0,0 @@ -accepted); - } - - /** - * Set the accepted values for the attribute. - * - * @param array $accepted - * @return Inclusion_Of - */ - public function in($accepted) - { - $this->accepted = $accepted; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/length_of.php b/system/validation/rules/length_of.php deleted file mode 100644 index f53ff5aa..00000000 --- a/system/validation/rules/length_of.php +++ /dev/null @@ -1,49 +0,0 @@ -size) and Str::length($value) !== $this->size) - { - $this->error = 'string_wrong_size'; - } - // --------------------------------------------------------- - // Validate the maximum length of the attribute. - // --------------------------------------------------------- - elseif ( ! is_null($this->maximum) and Str::length($value) > $this->maximum) - { - $this->error = 'string_too_big'; - } - // --------------------------------------------------------- - // Validate the minimum length of the attribute. - // --------------------------------------------------------- - elseif ( ! is_null($this->minimum) and Str::length($value) < $this->minimum) - { - $this->error = 'string_too_small'; - } - - return is_null($this->error); - } - -} \ No newline at end of file diff --git a/system/validation/rules/numericality_of.php b/system/validation/rules/numericality_of.php deleted file mode 100644 index 43813ba7..00000000 --- a/system/validation/rules/numericality_of.php +++ /dev/null @@ -1,116 +0,0 @@ -error = 'number_not_valid'; - } - // --------------------------------------------------------- - // Validate the attribute is an integer. - // --------------------------------------------------------- - elseif ($this->only_integer and filter_var($attributes[$attribute], FILTER_VALIDATE_INT) === false) - { - $this->error = 'number_not_integer'; - } - // --------------------------------------------------------- - // Validate the exact size of the attribute. - // --------------------------------------------------------- - elseif ( ! is_null($this->size) and $attributes[$attribute] != $this->size) - { - $this->error = 'number_wrong_size'; - } - // --------------------------------------------------------- - // Validate the maximum size of the attribute. - // --------------------------------------------------------- - elseif ( ! is_null($this->maximum) and $attributes[$attribute] > $this->maximum) - { - $this->error = 'number_too_big'; - } - // --------------------------------------------------------- - // Validate the minimum size of the attribute. - // --------------------------------------------------------- - elseif ( ! is_null($this->minimum) and $attributes[$attribute] < $this->minimum) - { - $this->error = 'number_too_small'; - } - - return is_null($this->error); - } - - /** - * Specify that the attribute must be an integer. - * - * @return Numericality_Of - */ - public function only_integer() - { - $this->only_integer = true; - return $this; - } - - /** - * Set the "not valid" error message. - * - * @param string $message - * @return Numericality_Of - */ - public function not_valid($message) - { - $this->not_valid = $message; - return $this; - } - - /** - * Set the "not integer" error message. - * - * @param string $message - * @return Numericality_Of - */ - public function not_integer($message) - { - $this->not_integer = $message; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/presence_of.php b/system/validation/rules/presence_of.php deleted file mode 100644 index 8926e967..00000000 --- a/system/validation/rules/presence_of.php +++ /dev/null @@ -1,29 +0,0 @@ -column)) - { - $this->column = $attribute; - } - - return DB::table($this->table)->where($this->column, '=', $attributes[$attribute])->count() == 0; - } - - /** - * Set the database table and column. - * - * The attribute name will be used as the column name if no other - * column name is specified. - * - * @param string $table - * @param string $column - * @return Uniqueness_Of - */ - public function on($table, $column = null) - { - $this->table = $table; - $this->column = $column; - - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/upload_of.php b/system/validation/rules/upload_of.php deleted file mode 100644 index 4dfba8ca..00000000 --- a/system/validation/rules/upload_of.php +++ /dev/null @@ -1,160 +0,0 @@ -allow_null) - { - $this->error = 'presence_of'; - } - - return is_null($this->error); - } - - // ----------------------------------------------------- - // Uploaded files are stored in the $_FILES array, so - // we use that array instead of the $attributes. - // ----------------------------------------------------- - $file = Input::file($attribute); - - if ( ! is_null($this->maximum) and $file['size'] > $this->maximum * 1000) - { - $this->error = 'file_too_big'; - } - - // ----------------------------------------------------- - // The File::is method uses the Fileinfo PHP extension - // to determine the MIME type of the file. - // ----------------------------------------------------- - foreach ($this->types as $type) - { - if (File::is($type, $file['tmp_name'])) - { - break; - } - - $this->error = 'file_wrong_type'; - } - - return is_null($this->error); - } - - /** - * Set the acceptable file types. - * - * @return Upload_Of - */ - public function is() - { - $this->types = func_get_args(); - return $this; - } - - /** - * Require that the uploaded file is an image type. - * - * @return Upload_Of - */ - public function is_image() - { - $this->types = array_merge($this->types, array('jpg', 'gif', 'png', 'bmp')); - return $this; - } - - /** - * Set the maximum file size in kilobytes. - * - * @param int $maximum - * @return Upload_Of - */ - public function maximum($maximum) - { - $this->maximum = $maximum; - return $this; - } - - /** - * Set the validation error message. - * - * @param string $message - * @return Upload_Of - */ - public function message($message) - { - return $this->wrong_type($message)->too_big($message); - } - - /** - * Set the "wrong type" error message. - * - * @param string $message - * @return Upload_Of - */ - public function wrong_type($message) - { - $this->wrong_type = $message; - return $this; - } - - /** - * Set the "too big" error message. - * - * @param string $message - * @return Upload_Of - */ - public function too_big($message) - { - $this->too_big = $message; - return $this; - } - -} \ No newline at end of file diff --git a/system/validation/rules/with_callback.php b/system/validation/rules/with_callback.php deleted file mode 100644 index ed1d2ff3..00000000 --- a/system/validation/rules/with_callback.php +++ /dev/null @@ -1,48 +0,0 @@ -callback)) - { - throw new \Exception("The validation callback for the [$attribute] attribute is not callable."); - } - - if ( ! is_null($nullable = parent::check($attribute, $attributes))) - { - return $nullable; - } - - return call_user_func($this->callback, $attributes[$attribute]); - } - - /** - * Set the validation callback. - * - * @param function $callback - * @return With_Callback - */ - public function using($callback) - { - $this->callback = $callback; - return $this; - } - -} \ No newline at end of file diff --git a/system/validator.php b/system/validator.php index eb4532f0..937f0b57 100644 --- a/system/validator.php +++ b/system/validator.php @@ -3,97 +3,504 @@ class Validator { /** - * The attributes being validated. + * The array being validated. * * @var array */ public $attributes; - /** - * The validation error collector. - * - * @var Error_Collector - */ - public $errors; - /** * The validation rules. * * @var array */ - public $rules = array(); + public $rules; /** - * Create a new Validator instance. + * The validation messages. * - * @param mixed $target + * @var array + */ + public $messages; + + /** + * The post-validation error messages. + * + * @var array + */ + public $errors; + + /** + * The "size" related validation rules. + * + * @var array + */ + protected $size_rules = array('size', 'between', 'min', 'max'); + + /** + * Create a new validator instance. + * + * @param array $attributes + * @param array $rules + * @param array $messages * @return void */ - public function __construct($target = null) + public function __construct($attributes, $rules, $messages = array()) { - $this->errors = new Validation\Error_Collector; - - if (is_null($target)) - { - $target = Input::get(); - } - - // --------------------------------------------------------- - // If the source is an Eloquent model, use the model's - // attributes as the validation attributes. - // --------------------------------------------------------- - $this->attributes = ($target instanceof DB\Eloquent) ? $target->attributes : (array) $target; + $this->attributes = $attributes; + $this->rules = $rules; + $this->messages = $messages; } /** - * Create a new Validator instance. + * Factory for creating new validator instances. * - * @param mixed $target + * @param array $attributes + * @param array $rules + * @param array $messages * @return Validator */ - public static function make($target = null) + public static function make($attributes, $rules, $messages = array()) { - return new static($target); + return new static($attributes, $rules, $messages); } /** - * Determine if the attributes pass all of the validation rules. + * Validate the target array using the specified validation rules. * * @return bool */ - public function is_valid() + public function invalid() { - $this->errors->messages = array(); + return ! $this->valid(); + } - foreach ($this->rules as $rule) + /** + * Validate the target array using the specified validation rules. + * + * @return bool + */ + public function valid() + { + $this->errors = new Validation\Errors; + + foreach ($this->rules as $attribute => $rules) { - // --------------------------------------------------------- - // The error collector is passed to the rule so that the - // rule may conveniently add error messages. - // --------------------------------------------------------- - $rule->validate($this->attributes, $this->errors); + if (is_string($rules)) + { + $rules = explode('|', $rules); + } + + foreach ($rules as $rule) + { + $this->check($attribute, $rule); + } } return count($this->errors->messages) == 0; } /** - * Magic Method for dynamically creating validation rules. + * Evaluate an attribute against a validation rule. + * + * @param string $attribute + * @param string $rule + * @return void */ - public function __call($method, $parameters) + protected function check($attribute, $rule) { - // --------------------------------------------------------- - // Check if the validation rule is defined in the rules - // directory. If it is, create a new rule and return it. - // --------------------------------------------------------- - if (file_exists(SYS_PATH.'validation/rules/'.$method.EXT)) - { - $rule = '\\System\\Validation\\Rules\\'.$method; + list($rule, $parameters) = $this->parse($rule); - return $this->rules[] = new $rule($parameters); + if ( ! method_exists($this, $validator = 'validate_'.$rule)) + { + throw new \Exception("Validation rule [$rule] doesn't exist."); } - throw new \Exception("Method [$method] does not exist on Validator class."); + // No validation will be run for attributes that do not exist unless the rule being validated + // is "required" or "accepted". No other rules have implicit "required" checks. + if ( ! array_key_exists($attribute, $this->attributes) and ! in_array($rule, array('required', 'accepted'))) + { + return; + } + + if ( ! $this->$validator($attribute, $parameters)) + { + $this->errors->add($attribute, $this->format_message($this->get_message($attribute, $rule), $attribute, $rule, $parameters)); + } + } + + /** + * Validate that a required attribute exists in the attributes array. + * + * @param string $attribute + * @return bool + */ + protected function validate_required($attribute) + { + return array_key_exists($attribute, $this->attributes) and trim($this->attributes[$attribute]) !== ''; + } + + /** + * Validate that an attribute has a matching confirmation attribute. + * + * @param string $attribute + * @return bool + */ + protected function validate_confirmed($attribute) + { + return array_key_exists($attribute.'_confirmation', $this->attributes) and $this->attributes[$attribute] == $this->attributes[$attribute.'_confirmation']; + } + + /** + * Validate that an attribute was "accepted". + * + * This validation rule implies the attribute is "required". + * + * @param string $attribute + * @return bool + */ + protected function validate_accepted($attribute) + { + return static::validate_required($attribute) and ($this->attributes[$attribute] == 'yes' or $this->attributes[$attribute] == '1'); + } + + /** + * Validate that an attribute is numeric. + * + * @param string $attribute + * @return bool + */ + protected function validate_numeric($attribute) + { + return is_numeric($this->attributes[$attribute]); + } + + /** + * Validate that an attribute is an integer. + * + * @param string $attribute + * @return bool + */ + protected function validate_integer($attribute) + { + return filter_var($this->attributes[$attribute], FILTER_VALIDATE_INT) !== false; + } + + /** + * Validate the size of an attribute. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_size($attribute, $parameters) + { + return $this->get_size($attribute) == $parameters[0]; + } + + /** + * Validate the size of an attribute is between a set of values. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_between($attribute, $parameters) + { + return $this->get_size($attribute) >= $parameters[0] and $this->get_size($attribute) <= $parameters[1]; + } + + /** + * Validate the size of an attribute is greater than a minimum value. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_min($attribute, $parameters) + { + return $this->get_size($attribute) >= $parameters[0]; + } + + /** + * Validate the size of an attribute is less than a maximum value. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_max($attribute, $parameters) + { + return $this->get_size($attribute) <= $parameters[0]; + } + + /** + * Get the size of an attribute. + * + * @param string $attribute + * @return mixed + */ + protected function get_size($attribute) + { + if ($this->has_numeric_rule($attribute)) + { + return $this->attributes[$attribute]; + } + + return (array_key_exists($attribute, $_FILES)) ? $this->attributes[$attribute]['size'] / 1000 : Str::length(trim($this->attributes[$attribute])); + } + + /** + * Validate an attribute is contained within a list of values. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_in($attribute, $parameters) + { + return in_array($this->attributes[$attribute], $parameters); + } + + /** + * Validate an attribute is not contained within a list of values. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_not_in($attribute, $parameters) + { + return ! in_array($this->attributes[$attribute], $parameters); + } + + /** + * Validate the uniqueness of an attribute value on a given database table. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_unique($attribute, $parameters) + { + if ( ! isset($parameters[1])) + { + $parameters[1] = $attribute; + } + + return DB::table($parameters[0])->where($parameters[1], '=', $this->attributes[$attribute])->count() == 0; + } + + /** + * Validate than an attribute is a valid e-mail address. + * + * @param string $attribute + * @return bool + */ + protected function validate_email($attribute) + { + return filter_var($this->attributes[$attribute], FILTER_VALIDATE_EMAIL) !== false; + } + + /** + * Validate than an attribute is a valid URL. + * + * @param string $attribute + * @return bool + */ + protected function validate_url($attribute) + { + return filter_var($this->attributes[$attribute], FILTER_VALIDATE_URL) !== false; + } + + /** + * Validate that an attribute is an active URL. + * + * @param string $attribute + * @return bool + */ + protected function validate_active_url($attribute) + { + $url = str_replace(array('http://', 'https://', 'ftp://'), '', Str::lower($this->attributes[$attribute])); + + return checkdnsrr($url); + } + + /** + * Validate the MIME type of a file is an image MIME type. + * + * @param string $attribute + * @return bool + */ + protected function validate_image($attribute) + { + return static::validate_mime($attribute, array('jpg', 'png', 'gif', 'bmp')); + } + + /** + * Validate than an attribute contains only alphabetic characters. + * + * @param string $attribute + * @return bool + */ + protected function validate_alpha($attribute) + { + return preg_match('/^([a-z])+$/i', $this->attributes[$attribute]); + } + + /** + * Validate than an attribute contains only alpha-numeric characters. + * + * @param string $attribute + * @return bool + */ + protected function validate_alpha_num($attribute) + { + return preg_match('/^([a-z0-9])+$/i', $this->attributes[$attribute]); + } + + /** + * Validate than an attribute contains only alpha-numeric characters, dashes, and underscores. + * + * @param string $attribute + * @return bool + */ + protected function validate_alpha_dash($attribute) + { + return preg_match('/^([-a-z0-9_-])+$/i', $this->attributes[$attribute]); + } + + /** + * Validate the MIME type of a file upload attribute is in a set of MIME types. + * + * @param string $attribute + * @param array $parameters + * @return bool + */ + protected function validate_mimes($attribute, $parameters) + { + foreach ($parameters as $extension) + { + if (File::is($extension, $this->attributes[$attribute]['tmp_name'])) + { + return true; + } + } + + return false; + } + + /** + * Get the proper error message for an attribute and rule. + * + * Developer specified attribute specific rules take first priority. + * Developer specified error rules take second priority. + * + * If the message has not been specified by the developer, the default will be used + * from the validation language file. + * + * @param string $attribute + * @param string $rule + * @return string + */ + protected function get_message($attribute, $rule) + { + if (array_key_exists($attribute.'_'.$rule, $this->messages)) + { + return $this->messages[$attribute.'_'.$rule]; + } + elseif (array_key_exists($rule, $this->messages)) + { + return $this->messages[$rule]; + } + else + { + $message = Lang::line('validation.'.$rule)->get(); + + // For "size" rules that are validating strings or files, we need to adjust + // the default error message appropriately. + if (in_array($rule, $this->size_rules) and ! $this->has_numeric_rule($attribute)) + { + return (array_key_exists($attribute, $_FILES)) ? rtrim($message, '.').' kilobytes.' : rtrim($message, '.').' characters.'; + } + + return $message; + } + } + + /** + * Replace all error message place-holders with actual values. + * + * @param string $message + * @param string $attribute + * @param string $rule + * @param array $parameters + * @return string + */ + protected function format_message($message, $attribute, $rule, $parameters) + { + $display = Lang::line('attributes.'.$attribute)->get(null, function() use ($attribute) { return str_replace('_', ' ', $attribute); }); + + $message = str_replace(':attribute', $display, $message); + + if (in_array($rule, $this->size_rules)) + { + $max = ($rule == 'between') ? $parameters[1] : $parameters[0]; + + $message = str_replace(':size', $parameters[0], str_replace(':min', $parameters[0], str_replace(':max', $max, $message))); + } + elseif (in_array($rule, array('in', 'not_in', 'mimes'))) + { + $message = str_replace(':values', implode(', ', $parameters), $message); + } + + return $message; + } + + /** + * Determine if an attribute has either a "numeric" or "integer" rule. + * + * @param string $attribute + * @return bool + */ + protected function has_numeric_rule($attribute) + { + return $this->has_rule($attribute, array('numeric', 'integer')); + } + + /** + * Determine if an attribute has a rule assigned to it. + * + * @param string $attribute + * @param array $rules + * @return bool + */ + protected function has_rule($attribute, $rules) + { + foreach ($this->rules[$attribute] as $rule) + { + list($rule, $parameters) = $this->parse($rule); + + if (in_array($rule, $rules)) + { + return true; + } + } + + return false; + } + + /** + * Extrac the rule name and parameters from a rule. + * + * @param string $rule + * @return array + */ + protected function parse($rule) + { + $parameters = (($colon = strpos($rule, ':')) !== false) ? explode(',', substr($rule, $colon + 1)) : array(); + + return array(is_numeric($colon) ? substr($rule, 0, $colon) : $rule, $parameters); } } \ No newline at end of file diff --git a/system/vendor/phpass.php b/system/vendor/phpass.php new file mode 100644 index 00000000..12958c7f --- /dev/null +++ b/system/vendor/phpass.php @@ -0,0 +1,253 @@ + in 2004-2006 and placed in +# the public domain. Revised in subsequent years, still public domain. +# +# There's absolutely no warranty. +# +# The homepage URL for this framework is: +# +# http://www.openwall.com/phpass/ +# +# Please be sure to update the Version line if you edit this file in any way. +# It is suggested that you leave the main version number intact, but indicate +# your project name (after the slash) and add your own revision information. +# +# Please do not change the "private" password hashing method implemented in +# here, thereby making your hashes incompatible. However, if you must, please +# change the hash type identifier (the "$P$") to something different. +# +# Obviously, since this code is in the public domain, the above are not +# requirements (there can be none), but merely suggestions. +# +class PasswordHash { + var $itoa64; + var $iteration_count_log2; + var $portable_hashes; + var $random_state; + + function PasswordHash($iteration_count_log2, $portable_hashes) + { + $this->itoa64 = './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'; + + if ($iteration_count_log2 < 4 || $iteration_count_log2 > 31) + $iteration_count_log2 = 8; + $this->iteration_count_log2 = $iteration_count_log2; + + $this->portable_hashes = $portable_hashes; + + $this->random_state = microtime(); + if (function_exists('getmypid')) + $this->random_state .= getmypid(); + } + + function get_random_bytes($count) + { + $output = ''; + if (is_readable('/dev/urandom') && + ($fh = @fopen('/dev/urandom', 'rb'))) { + $output = fread($fh, $count); + fclose($fh); + } + + if (strlen($output) < $count) { + $output = ''; + for ($i = 0; $i < $count; $i += 16) { + $this->random_state = + md5(microtime() . $this->random_state); + $output .= + pack('H*', md5($this->random_state)); + } + $output = substr($output, 0, $count); + } + + return $output; + } + + function encode64($input, $count) + { + $output = ''; + $i = 0; + do { + $value = ord($input[$i++]); + $output .= $this->itoa64[$value & 0x3f]; + if ($i < $count) + $value |= ord($input[$i]) << 8; + $output .= $this->itoa64[($value >> 6) & 0x3f]; + if ($i++ >= $count) + break; + if ($i < $count) + $value |= ord($input[$i]) << 16; + $output .= $this->itoa64[($value >> 12) & 0x3f]; + if ($i++ >= $count) + break; + $output .= $this->itoa64[($value >> 18) & 0x3f]; + } while ($i < $count); + + return $output; + } + + function gensalt_private($input) + { + $output = '$P$'; + $output .= $this->itoa64[min($this->iteration_count_log2 + + ((PHP_VERSION >= '5') ? 5 : 3), 30)]; + $output .= $this->encode64($input, 6); + + return $output; + } + + function crypt_private($password, $setting) + { + $output = '*0'; + if (substr($setting, 0, 2) == $output) + $output = '*1'; + + $id = substr($setting, 0, 3); + # We use "$P$", phpBB3 uses "$H$" for the same thing + if ($id != '$P$' && $id != '$H$') + return $output; + + $count_log2 = strpos($this->itoa64, $setting[3]); + if ($count_log2 < 7 || $count_log2 > 30) + return $output; + + $count = 1 << $count_log2; + + $salt = substr($setting, 4, 8); + if (strlen($salt) != 8) + return $output; + + # We're kind of forced to use MD5 here since it's the only + # cryptographic primitive available in all versions of PHP + # currently in use. To implement our own low-level crypto + # in PHP would result in much worse performance and + # consequently in lower iteration counts and hashes that are + # quicker to crack (by non-PHP code). + if (PHP_VERSION >= '5') { + $hash = md5($salt . $password, TRUE); + do { + $hash = md5($hash . $password, TRUE); + } while (--$count); + } else { + $hash = pack('H*', md5($salt . $password)); + do { + $hash = pack('H*', md5($hash . $password)); + } while (--$count); + } + + $output = substr($setting, 0, 12); + $output .= $this->encode64($hash, 16); + + return $output; + } + + function gensalt_extended($input) + { + $count_log2 = min($this->iteration_count_log2 + 8, 24); + # This should be odd to not reveal weak DES keys, and the + # maximum valid value is (2**24 - 1) which is odd anyway. + $count = (1 << $count_log2) - 1; + + $output = '_'; + $output .= $this->itoa64[$count & 0x3f]; + $output .= $this->itoa64[($count >> 6) & 0x3f]; + $output .= $this->itoa64[($count >> 12) & 0x3f]; + $output .= $this->itoa64[($count >> 18) & 0x3f]; + + $output .= $this->encode64($input, 3); + + return $output; + } + + function gensalt_blowfish($input) + { + # This one needs to use a different order of characters and a + # different encoding scheme from the one in encode64() above. + # We care because the last character in our encoded string will + # only represent 2 bits. While two known implementations of + # bcrypt will happily accept and correct a salt string which + # has the 4 unused bits set to non-zero, we do not want to take + # chances and we also do not want to waste an additional byte + # of entropy. + $itoa64 = './ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; + + $output = '$2a$'; + $output .= chr(ord('0') + $this->iteration_count_log2 / 10); + $output .= chr(ord('0') + $this->iteration_count_log2 % 10); + $output .= '$'; + + $i = 0; + do { + $c1 = ord($input[$i++]); + $output .= $itoa64[$c1 >> 2]; + $c1 = ($c1 & 0x03) << 4; + if ($i >= 16) { + $output .= $itoa64[$c1]; + break; + } + + $c2 = ord($input[$i++]); + $c1 |= $c2 >> 4; + $output .= $itoa64[$c1]; + $c1 = ($c2 & 0x0f) << 2; + + $c2 = ord($input[$i++]); + $c1 |= $c2 >> 6; + $output .= $itoa64[$c1]; + $output .= $itoa64[$c2 & 0x3f]; + } while (1); + + return $output; + } + + function HashPassword($password) + { + $random = ''; + + if (CRYPT_BLOWFISH == 1 && !$this->portable_hashes) { + $random = $this->get_random_bytes(16); + $hash = + crypt($password, $this->gensalt_blowfish($random)); + if (strlen($hash) == 60) + return $hash; + } + + if (CRYPT_EXT_DES == 1 && !$this->portable_hashes) { + if (strlen($random) < 3) + $random = $this->get_random_bytes(3); + $hash = + crypt($password, $this->gensalt_extended($random)); + if (strlen($hash) == 20) + return $hash; + } + + if (strlen($random) < 6) + $random = $this->get_random_bytes(6); + $hash = + $this->crypt_private($password, + $this->gensalt_private($random)); + if (strlen($hash) == 34) + return $hash; + + # Returning '*' on error is safe here, but would _not_ be safe + # in a crypt(3)-like function used _both_ for generating new + # hashes and for validating passwords against existing hashes. + return '*'; + } + + function CheckPassword($password, $stored_hash) + { + $hash = $this->crypt_private($password, $stored_hash); + if ($hash[0] == '*') + $hash = crypt($password, $stored_hash); + + return $hash == $stored_hash; + } +} + +?> diff --git a/system/view.php b/system/view.php index 990b2dcd..46159018 100644 --- a/system/view.php +++ b/system/view.php @@ -57,9 +57,7 @@ class View { { static::$last = $this->view; - // ----------------------------------------------------- // Get the evaluated content of all of the sub-views. - // ----------------------------------------------------- foreach ($this->data as &$data) { if ($data instanceof View or $data instanceof Response) @@ -68,35 +66,13 @@ class View { } } - // ----------------------------------------------------- - // Extract the view data into the local scope. - // ----------------------------------------------------- extract($this->data, EXTR_SKIP); - // ----------------------------------------------------- - // Start the output buffer so nothing escapes to the - // browser. The response will be sent later. - // ----------------------------------------------------- ob_start(); $path = $this->find(); - // ----------------------------------------------------- - // We include the view into the local scope within a - // try / catch block to catch any exceptions that may - // occur while the view is rendering. - // - // Otherwise, a white screen of death will be shown - // if an exception occurs while rendering the view. - // ----------------------------------------------------- - try - { - include $path; - } - catch (\Exception $e) - { - Error::handle($e); - } + try { include $path; } catch (\Exception $e) { Error::handle($e); } return ob_get_clean(); } diff --git a/system/views/exception.php b/system/views/exception.php index 996eecf9..5eba8540 100644 --- a/system/views/exception.php +++ b/system/views/exception.php @@ -2,78 +2,101 @@ - Laravel - Error - - + Laravel - <?php echo $severity; ?> + + + + + +
-

- -
-

Message:

- in on line . -
+

Message:

-
-

Stack Trace:

+

in on line .

-
-
+

Stack Trace:

-
-

Context:

+
- 0) { ?> +

Snapshot:

- $context) { ?> -
- +

+ 0): ?> - - Context unavailable. - -

+ $context): ?> +
+ + + + Snapshot Unavailable. + +

\ No newline at end of file diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 00000000..5d978d58 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,31 @@ + + + + suite + + + \ No newline at end of file diff --git a/tests/suite/ArrTest.php b/tests/suite/ArrTest.php new file mode 100644 index 00000000..81d201bd --- /dev/null +++ b/tests/suite/ArrTest.php @@ -0,0 +1,17 @@ +assertNull(System\Arr::get(array(), 'name')); + $this->assertEquals(System\Arr::get(array(), 'name', 'test'), 'test'); + $this->assertEquals(System\Arr::get(array(), 'name', function() {return 'test';}), 'test'); + } + + public function testReturnsItemWhenPresentInArray() + { + $this->assertEquals(System\Arr::get(array('name' => 'test'), 'name'), 'test'); + } + +} \ No newline at end of file diff --git a/tests/suite/InputTest.php b/tests/suite/InputTest.php new file mode 100644 index 00000000..b4fdd458 --- /dev/null +++ b/tests/suite/InputTest.php @@ -0,0 +1,178 @@ +assertEquals(System\Input::get(), $data); + } + + public function inputByMethodProvider() + { + return array( + array('GET', array('method' => 'GET')), + array('POST', array('method' => 'POST')), + ); + } + + /** + * @dataProvider inputBySpoofedMethodProvider + */ + public function testInputShouldHydrateBasedOnSpoofedRequestMethod($method, $data) + { + $_SERVER['REQUEST_METHOD'] = 'POST'; + $_POST = $data; + + $this->assertEquals(System\Input::get(), $data); + } + + public function inputBySpoofedMethodProvider() + { + return array( + array('PUT', array('request_method' => 'PUT', 'method' => 'PUT')), + array('DELETE', array('request_method' => 'DELETE', 'method' => 'DELETE')), + ); + } + + public function testHasMethodReturnsTrueIfItemIsPresentInInputData() + { + System\Input::$input = array('name' => 'taylor'); + $this->assertTrue(System\Input::has('name')); + } + + public function testHasMethodReturnsFalseIfItemIsNotPresentInInputData() + { + System\Input::$input = array(); + $this->assertFalse(System\Input::has('name')); + } + + public function testHasMethodReturnsFalseIfItemIsInInputButIsEmptyString() + { + System\Input::$input = array('name' => ''); + $this->assertFalse(System\Input::has('name')); + } + + public function testGetMethodReturnsItemByInputKey() + { + System\Input::$input = array('name' => 'taylor'); + $this->assertEquals(System\Input::get('name'), 'taylor'); + } + + public function testGetMethodReturnsDefaultValueWhenItemDoesntExist() + { + System\Input::$input = array(); + + $this->assertNull(System\Input::get('name')); + $this->assertEquals(System\Input::get('name', 'test'), 'test'); + $this->assertEquals(System\Input::get('name', function() {return 'test';}), 'test'); + $this->assertTrue(is_array(System\Input::get()) and count(System\Input::get()) == 0); + } + + public function testGetMethodReturnsEntireInputArrayWhenNoKeyGiven() + { + System\Input::$input = array('name' => 'taylor', 'age' => 25); + $this->assertEquals(System\Input::get(), System\Input::$input); + } + + public function testFileMethodReturnsItemFromGlobalFilesArray() + { + $_FILES['test'] = array('name' => 'taylor'); + $this->assertEquals(System\Input::file('test'), $_FILES['test']); + } + + public function testFileMethodReturnsSpecificItemFromFileArrayWhenSpecified() + { + $_FILES['test'] = array('size' => 500); + $this->assertEquals(System\Input::file('test.size'), 500); + } + + public function testAllMethodReturnsBothGetAndFileArrays() + { + $_GET['name'] = 'test'; + $_FILES['picture'] = array(); + + $this->assertArrayHasKey('name', System\Input::all()); + $this->assertArrayHasKey('picture', System\Input::all()); + } + + /** + * @expectedException Exception + */ + public function testOldMethodShouldThrowExceptionWhenSessionsArentEnabled() + { + System\Input::old(); + } + + /** + * @expectedException Exception + */ + public function testHadMethodShouldThrowExceptionWhenSessionsArentEnabled() + { + System\Input::has(); + } + + public function testOldMethodShouldReturnOldInputDataFromSession() + { + System\Config::set('session.driver', 'test'); + System\Session::$session['data']['laravel_old_input'] = array('name' => 'taylor'); + + $this->assertEquals(System\Input::old('name'), 'taylor'); + } + + public function testOldMethodReturnsDefaultValueWhenItemDoesntExist() + { + System\Config::set('session.driver', 'test'); + System\Session::$session['data']['laravel_old_input'] = array(); + + $this->assertNull(System\Input::old('name')); + $this->assertEquals(System\Input::old('name', 'test'), 'test'); + $this->assertEquals(System\Input::old('name', function() {return 'test';}), 'test'); + $this->assertTrue(is_array(System\Input::old()) and count(System\Input::old()) == 0); + } + + public function testHadMethodReturnsTrueIfItemIsPresentInOldInputData() + { + System\Config::set('session.driver', 'test'); + System\Session::$session['data']['laravel_old_input'] = array('name' => 'taylor'); + + $this->assertTrue(System\Input::had('name')); + } + + public function testHadMethodReturnsFalseIfItemIsNotPresentInOldInputData() + { + System\Config::set('session.driver', 'test'); + System\Session::$session['data']['laravel_old_input'] = array(); + + $this->assertFalse(System\Input::had('name')); + } + +} \ No newline at end of file diff --git a/tests/suite/RequestTest.php b/tests/suite/RequestTest.php new file mode 100644 index 00000000..b6cf25c4 --- /dev/null +++ b/tests/suite/RequestTest.php @@ -0,0 +1,172 @@ +callback = array('name' => 'test', 'do' => function() {}); + + System\Request::$route = $route; + } + + public function tearDown() + { + System\Request::$route = null; + } + + /** + * @expectedException Exception + */ + public function testUriMethodThrowsExceptionWhenCantDetermineUri() + { + System\Request::uri(); + } + + public function testUriMethodReturnsPathInfoWhenSet() + { + $_SERVER['PATH_INFO'] = 'test'; + $_SERVER['REQUEST_METHOD'] = 'blah'; + + $this->assertEquals(System\Request::uri(), 'test'); + } + + /** + * @dataProvider rootUriProvider1 + */ + public function testUriMethodReturnsSingleSlashOnRequestForRoot($uri) + { + Config::set('application.url', 'http://example.com'); + Config::set('appliation.index', ''); + + $_SERVER['REQUEST_URI'] = $uri; + $this->assertEquals(System\Request::uri(), '/'); + } + + public function rootUriProvider1() + { + return array( + array(''), + array('/'), + array('/index.php'), + array('/index.php/'), + array('/index.php///'), + array('http://example.com'), + array('http://example.com/'), + ); + } + + /** + * @dataProvider rootUriProvider2 + */ + public function testUriMethodReturnsSingleSlashOnRequestForFolderNestedRoot($uri) + { + Config::set('application.url', 'http://example.com/laravel/public'); + Config::set('appliation.index', 'index.php'); + + $_SERVER['REQUEST_URI'] = $uri; + $this->assertEquals(System\Request::uri(), '/'); + } + + public function rootUriProvider2() + { + return array( + array('http://example.com/laravel/public'), + array('http://example.com/laravel/public/index.php'), + array('http://example.com/laravel/public/index.php/'), + array('http://example.com/laravel/public/index.php///'), + array(''), + array('/'), + array('/index.php'), + array('/index.php/'), + array('/index.php///'), + array('http://example.com'), + array('http://example.com/'), + ); + } + + /** + * @dataProvider segmentedUriProvider1 + */ + public function testUriMethodReturnsSegmentForSingleSegmentUri($uri) + { + Config::set('application.url', 'http://example.com'); + Config::set('appliation.index', ''); + + $_SERVER['REQUEST_URI'] = $uri; + $this->assertEquals(System\Request::uri(), 'user'); + } + + public function segmentedUriProvider1() + { + return array( + array('http://example.com/user'), + array('http://example.com/user/'), + array('http://example.com/user//'), + ); + } + + /** + * @dataProvider segmentedUriProvider2 + */ + public function testUriMethodReturnsSegmentsForMultiSegmentUri($uri) + { + Config::set('application.url', 'http://example.com'); + Config::set('appliation.index', ''); + + $_SERVER['REQUEST_URI'] = $uri; + $this->assertEquals(System\Request::uri(), 'user/something'); + } + + public function segmentedUriProvider2() + { + return array( + array('http://example.com/user/something'), + array('http://example.com/user/something/'), + array('http://example.com/user/something//'), + ); + } + + public function testMethodForNonSpoofedRequests() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + $this->assertEquals(System\Request::method(), 'GET'); + } + + public function testMethodForSpoofedRequests() + { + $_SERVER['REQUEST_METHOD'] = 'GET'; + + $_POST['REQUEST_METHOD'] = 'PUT'; + $this->assertEquals(System\Request::method(), 'PUT'); + + $_POST['REQUEST_METHOD'] = 'DELETE'; + $this->assertEquals(System\Request::method(), 'DELETE'); + } + + public function testRouteIsReturnsFalseWhenNoSuchNamedRouteExists() + { + $route = new System\Route(null, null); + $route->callback = function() {}; + + System\Request::$route = $route; + + $this->assertFalse(System\Request::route_is('test')); + $this->assertFalse(System\Request::route_is_test()); + } + + public function testRouteIsReturnsFalseWhenWrongRouteNameIsGiven() + { + $this->assertFalse(System\Request::route_is('something')); + $this->assertFalse(System\Request::route_is_something()); + } + + public function testRouteIsReturnsTrueWhenNamedRouteExists() + { + $this->assertTrue(System\Request::route_is('test')); + $this->assertTrue(System\Request::route_is_test()); + } + +} \ No newline at end of file diff --git a/tests/suite/RouteFilterTest.php b/tests/suite/RouteFilterTest.php new file mode 100644 index 00000000..f0a984e1 --- /dev/null +++ b/tests/suite/RouteFilterTest.php @@ -0,0 +1,45 @@ + function() {return 'test';}, + 'vars' => function($var) {return $var;}, + 'vars2' => function($var1, $var2) {return $var1.$var2;}, + ); + + System\Route\Filter::$filters = $filters; + } + + public static function tearDownAfterClass() + { + System\Route\Filter::$filters = require APP_PATH.'filters'.EXT; + } + + /** + * @expectedException Exception + */ + public function testCallingUndefinedFilterThrowsException() + { + System\Route\Filter::call('not-found'); + } + + public function testCallingFilterWithoutOverrideReturnsNull() + { + $this->assertNull(System\Route\Filter::call('test')); + } + + public function testCallingFilterWithOverrideReturnsResult() + { + $this->assertEquals(System\Route\Filter::call('test', array(), true), 'test'); + } + + public function testCallingFilterWithParametersPassesParametersToFilter() + { + $this->assertEquals(System\Route\Filter::call('vars', array('test'), true), 'test'); + $this->assertEquals(System\Route\Filter::call('vars2', array('test1', 'test2'), true), 'test1test2'); + } + +} \ No newline at end of file diff --git a/tests/suite/RouteFinderTest.php b/tests/suite/RouteFinderTest.php new file mode 100644 index 00000000..988fad6b --- /dev/null +++ b/tests/suite/RouteFinderTest.php @@ -0,0 +1,42 @@ + array('name' => 'home', 'do' => function() {})); + $routes['GET /user'] = array('GET /user' => array('name' => 'user', 'do' => function() {})); + + System\Route\Finder::$routes = $routes; + } + + public function testRouteFinderReturnsNullWhenRouteIsNotFound() + { + $this->assertNull(System\Route\Finder::find('doesnt-exist')); + } + + public function testRouteFinderReturnsRouteWhenFoundInSingleRoutesFile() + { + $this->assertArrayHasKey('GET /home', System\Route\Finder::find('home')); + $this->assertArrayHasKey('GET /user', System\Route\Finder::find('user')); + } + + public function testRouteFinderLoadsRoutesFromRouteDirectoryToFindRoutes() + { + System\Route\Finder::$routes = null; + $this->setupRoutesDirectory(); + + $this->assertArrayHasKey('GET /user', System\Route\Finder::find('user')); + + Utils::rrmdir(APP_PATH.'routes'); + } + + private function setupRoutesDirectory() + { + mkdir(APP_PATH.'routes', 0777); + file_put_contents(APP_PATH.'routes/user.php', " array('name' => 'user', 'do' => function() {return '/user';})); ?>", LOCK_EX); + } + +} \ No newline at end of file diff --git a/tests/suite/RouteTest.php b/tests/suite/RouteTest.php new file mode 100644 index 00000000..70f0df35 --- /dev/null +++ b/tests/suite/RouteTest.php @@ -0,0 +1,56 @@ +assertInstanceOf('System\\Response', $route->call()); + $this->assertEquals($route->call()->content, 'test'); + } + + public function testRouteCallPassesParametersToCallback() + { + $route = new System\Route('GET /', function($parameter) {return $parameter;}, array('test')); + $this->assertEquals($route->call()->content, 'test'); + + $route = new System\Route('GET /', function($parameter1, $parameter2) {return $parameter1.$parameter2;}, array('test1', 'test2')); + $this->assertEquals($route->call()->content, 'test1test2'); + } + + public function testRouteCallWithNullBeforeFilterReturnsRouteResponse() + { + $route = new System\Route('GET /', array('before' => 'test', 'do' => function() {return 'route';})); + System\Route\Filter::$filters = array('test' => function() {return null;}); + + $this->assertEquals($route->call()->content, 'route'); + } + + public function testRouteCallWithOverridingBeforeFilterReturnsFilterResponse() + { + $route = new System\Route('GET /', array('before' => 'test', 'do' => function() {return 'route';})); + System\Route\Filter::$filters = array('test' => function() {return 'filter';}); + + $this->assertEquals($route->call()->content, 'filter'); + } + + public function testRouteAfterFilterIsCalled() + { + $route = new System\Route('GET /', array('after' => 'test', 'do' => function() {return 'route';})); + System\Route\Filter::$filters = array('test' => function() {define('LARAVEL_TEST_AFTER_FILTER', 'ran');}); + + $route->call(); + + $this->assertTrue(defined('LARAVEL_TEST_AFTER_FILTER')); + } + + public function testRouteAfterFilterDoesNotAffectResponse() + { + $route = new System\Route('GET /', array('after' => 'test', 'do' => function() {return 'route';})); + System\Route\Filter::$filters = array('test' => function() {return 'filter';}); + + $this->assertEquals($route->call()->content, 'route'); + } + +} \ No newline at end of file diff --git a/tests/suite/RouterTest.php b/tests/suite/RouterTest.php new file mode 100644 index 00000000..a6c10a28 --- /dev/null +++ b/tests/suite/RouterTest.php @@ -0,0 +1,125 @@ + 'root', 'do' => function() {}); + $routes['GET /home'] = array('name' => 'home', 'do' => function() {}); + $routes['POST /home'] = array('name' => 'post-home', 'do' => function() {}); + $routes['GET /user/(:num)'] = array('name' => 'user', 'do' => function() {}); + $routes['GET /user/(:any)/(:num)/edit'] = array('name' => 'edit', 'do' => function() {}); + $routes['GET /cart/(:num?)'] = array('name' => 'cart', 'do' => function() {}); + $routes['GET /download/(:num?)/(:any?)'] = array('name' => 'download', 'do' => function() {}); + + System\Router::$routes = $routes; + } + + public static function tearDownAfterClass() + { + System\Router::$routes = null; + } + + public function tearDown() + { + Utils::rrmdir(APP_PATH.'routes'); + } + + public function testRouterReturnsNullWhenNotFound() + { + $this->assertNull(System\Router::route('GET', 'doesnt-exist')); + } + + public function testRouterRoutesToRootWhenItIsRequest() + { + $this->assertEquals(System\Router::route('GET', '/')->callback['name'], 'root'); + } + + public function testRouterRoutesToProperRouteWhenSegmentsArePresent() + { + $this->assertEquals(System\Router::route('GET', 'home')->callback['name'], 'home'); + $this->assertEquals(System\Router::route('GET', 'user/1')->callback['name'], 'user'); + $this->assertEquals(System\Router::route('GET', 'user/taylor/25/edit')->callback['name'], 'edit'); + $this->assertEquals(System\Router::route('POST', 'home')->callback['name'], 'post-home'); + } + + public function testRouterGivesRouteProperSegmentsWhenTheyArePresent() + { + $this->assertEquals(System\Router::route('GET', 'user/1')->parameters[0], 1); + $this->assertEquals(count(System\Router::route('GET', 'user/1')->parameters), 1); + + $this->assertEquals(System\Router::route('GET', 'user/taylor/25/edit')->parameters[0], 'taylor'); + $this->assertEquals(System\Router::route('GET', 'user/taylor/25/edit')->parameters[1], 25); + $this->assertEquals(count(System\Router::route('GET', 'user/taylor/25/edit')->parameters), 2); + } + + public function testRouterRoutesToProperRouteWhenUsingOptionalSegments() + { + $this->assertEquals(System\Router::route('GET', 'cart')->callback['name'], 'cart'); + $this->assertEquals(System\Router::route('GET', 'cart/1')->callback['name'], 'cart'); + $this->assertEquals(System\Router::route('GET', 'download')->callback['name'], 'download'); + $this->assertEquals(System\Router::route('GET', 'download/1')->callback['name'], 'download'); + $this->assertEquals(System\Router::route('GET', 'download/1/a')->callback['name'], 'download'); + } + + public function testRouterGivesRouteProperOptionalSegmentsWhenTheyArePresent() + { + $this->assertTrue(is_array(System\Router::route('GET', 'cart')->parameters)); + $this->assertEquals(count(System\Router::route('GET', 'cart')->parameters), 0); + $this->assertEquals(System\Router::route('GET', 'cart/1')->parameters[0], 1); + + $this->assertEquals(count(System\Router::route('GET', 'download')->parameters), 0); + $this->assertEquals(System\Router::route('GET', 'download/1')->parameters[0], 1); + $this->assertEquals(count(System\Router::route('GET', 'download/1')->parameters), 1); + + $this->assertEquals(System\Router::route('GET', 'download/1/a')->parameters[0], 1); + $this->assertEquals(System\Router::route('GET', 'download/1/a')->parameters[1], 'a'); + $this->assertEquals(count(System\Router::route('GET', 'download/1/a')->parameters), 2); + } + + public function testRouterReturnsNullWhenRouteNotFound() + { + $this->assertNull(System\Router::route('GET', 'user/taylor/taylor/edit')); + $this->assertNull(System\Router::route('GET', 'user/taylor')); + $this->assertNull(System\Router::route('GET', 'user/12-3')); + $this->assertNull(System\Router::route('GET', 'cart/a')); + $this->assertNull(System\Router::route('GET', 'cart/12-3')); + $this->assertNull(System\Router::route('GET', 'download/a')); + $this->assertNull(System\Router::route('GET', 'download/1a')); + $this->assertNull(System\Router::route('POST', 'user/taylor/25/edit')); + } + + public function testRouteLoaderShouldReturnSingleRoutesFileWhenNoFolderIsPresent() + { + $routes = System\Router::load('test'); + + // Only the Laravel default route should be returned. + $this->assertArrayHasKey('GET /', $routes); + } + + public function testRouteLoaderLoadsRouteFilesInRouteDirectoryByURI() + { + $this->setupRoutesDirectory(); + + $this->assertArrayHasKey('GET /user', System\Router::load('user')); + $this->assertArrayHasKey('GET /cart/edit', System\Router::load('cart')); + $this->assertArrayHasKey('GET /cart/edit', System\Router::load('cart/edit')); + } + + public function testRouteLoaderLoadsBaseRoutesFileForEveryRequest() + { + $this->setupRoutesDirectory(); + $this->assertArrayHasKey('GET /', System\Router::load('user')); + } + + private function setupRoutesDirectory() + { + mkdir(APP_PATH.'routes', 0777); + + file_put_contents(APP_PATH.'routes/user.php', " function() {return '/user';}); ?>", LOCK_EX); + file_put_contents(APP_PATH.'routes/cart.php', " function() {return '/cart/edit';}); ?>", LOCK_EX); + } + +} \ No newline at end of file diff --git a/tests/suite/ViewTest.php b/tests/suite/ViewTest.php new file mode 100644 index 00000000..080fb3fe --- /dev/null +++ b/tests/suite/ViewTest.php @@ -0,0 +1,51 @@ + 'test')); + + $this->assertEquals($view->view, 'view'); + $this->assertEquals($view->data, array('name' => 'test')); + + $view = new System\View('view'); + $this->assertEquals($view->data, array()); + } + + public function testMakeMethodReturnsNewViewInstance() + { + $this->assertInstanceOf('System\\View', System\View::make('test')); + } + + public function testBindMethodAddsItemToViewData() + { + $view = System\View::make('test')->bind('name', 'test'); + $this->assertEquals($view->data, array('name' => 'test')); + } + + public function testBoundViewDataCanBeRetrievedThroughMagicMethods() + { + $view = System\View::make('test')->bind('name', 'test'); + + $this->assertTrue(isset($view->name)); + $this->assertEquals($view->name, 'test'); + + unset($view->name); + $this->assertFalse(isset($view->name)); + } + + public function testGetMethodReturnsStringContentOfView() + { + $this->assertTrue(is_string(System\View::make('home/index')->get())); + } + + /** + * @expectedException Exception + */ + public function testExceptionIsThrownWhenViewDoesntExist() + { + System\View::make('doesnt-exist')->get(); + } + +} \ No newline at end of file diff --git a/tests/utils.php b/tests/utils.php new file mode 100644 index 00000000..14399f36 --- /dev/null +++ b/tests/utils.php @@ -0,0 +1,30 @@ +