Commit 62072e52 authored by Phill Sparks's avatar Phill Sparks

PHPDoc fixes

parent f3be544b
...@@ -7,7 +7,7 @@ class Base_Controller extends Controller { ...@@ -7,7 +7,7 @@ class Base_Controller extends Controller {
* *
* @param string $method * @param string $method
* @param array $parameters * @param array $parameters
* @return Response * @return Laravel\Response
*/ */
public function __call($method, $parameters) public function __call($method, $parameters)
{ {
......
...@@ -183,8 +183,8 @@ class Autoloader { ...@@ -183,8 +183,8 @@ class Autoloader {
/** /**
* Map namespaces to directories. * Map namespaces to directories.
* *
* @param string $namespace * @param array $mappings
* @param string $path * @return void
*/ */
public static function namespaces($mappings) public static function namespaces($mappings)
{ {
......
...@@ -27,8 +27,7 @@ class Bundle { ...@@ -27,8 +27,7 @@ class Bundle {
* Register a bundle for the application. * Register a bundle for the application.
* *
* @param string $bundle * @param string $bundle
* @param string $location * @param mixed $config Array of 'location', 'handles' and 'auto'; or string of location.
* @param string $handles
* @return void * @return void
*/ */
public static function register($bundle, $config = array()) public static function register($bundle, $config = array())
...@@ -111,7 +110,7 @@ class Bundle { ...@@ -111,7 +110,7 @@ class Bundle {
* *
* If no bundle is assigned to handle the URI, the default bundle is returned. * If no bundle is assigned to handle the URI, the default bundle is returned.
* *
* @param string $bundle * @param string $uri
* @return string * @return string
*/ */
public static function handles($uri) public static function handles($uri)
......
...@@ -23,7 +23,7 @@ class Cache { ...@@ -23,7 +23,7 @@ class Cache {
* </code> * </code>
* *
* @param string $driver * @param string $driver
* @return Cache\Driver * @return Cache\Drivers\Driver
*/ */
public static function driver($driver = null) public static function driver($driver = null)
{ {
...@@ -41,7 +41,7 @@ class Cache { ...@@ -41,7 +41,7 @@ class Cache {
* Create a new cache driver instance. * Create a new cache driver instance.
* *
* @param string $driver * @param string $driver
* @return Driver * @return Cache\Drivers\Driver
*/ */
protected static function factory($driver) protected static function factory($driver)
{ {
......
...@@ -101,7 +101,7 @@ class Database extends Driver { ...@@ -101,7 +101,7 @@ class Database extends Driver {
/** /**
* Get a query builder for the database table. * Get a query builder for the database table.
* *
* @return Query * @return Laravel\Database\Query
*/ */
protected function table() protected function table()
{ {
......
...@@ -23,7 +23,6 @@ abstract class Driver { ...@@ -23,7 +23,6 @@ abstract class Driver {
* *
* @param string $key * @param string $key
* @param mixed $default * @param mixed $default
* @param string $driver
* @return mixed * @return mixed
*/ */
public function get($key, $default = null) public function get($key, $default = null)
......
...@@ -5,14 +5,14 @@ class Redis extends Driver { ...@@ -5,14 +5,14 @@ class Redis extends Driver {
/** /**
* The Redis database instance. * The Redis database instance.
* *
* @var Redis * @var Laravel\Redis
*/ */
protected $redis; protected $redis;
/** /**
* Create a new Redis cache driver instance. * Create a new Redis cache driver instance.
* *
* @param Redis $redis * @param Laravel\Redis $redis
* @return void * @return void
*/ */
public function __construct(\Laravel\Redis $redis) public function __construct(\Laravel\Redis $redis)
......
...@@ -6,7 +6,7 @@ class Console { ...@@ -6,7 +6,7 @@ class Console {
* Parse the command line arguments and return the results. * Parse the command line arguments and return the results.
* *
* @param array $argv * @param array $argv
* @param array * @return array
*/ */
public static function options($argv) public static function options($argv)
{ {
......
...@@ -74,7 +74,7 @@ class Database { ...@@ -74,7 +74,7 @@ class Database {
/** /**
* Get a database query instance for the migration table. * Get a database query instance for the migration table.
* *
* @return Query * @return Laravel\Database\Query
*/ */
protected function table() protected function table()
{ {
......
...@@ -14,7 +14,7 @@ class Resolver { ...@@ -14,7 +14,7 @@ class Resolver {
/** /**
* Create a new instance of the migration resolver. * Create a new instance of the migration resolver.
* *
* @param Database $datbase * @param Database $database
* @return void * @return void
*/ */
public function __construct(Database $database) public function __construct(Database $database)
......
...@@ -41,7 +41,7 @@ class Runner extends Task { ...@@ -41,7 +41,7 @@ class Runner extends Task {
/** /**
* Run the tests for a given bundle. * Run the tests for a given bundle.
* *
* @param array $arguments * @param array $bundles
* @return void * @return void
*/ */
public function bundle($bundles = array()) public function bundle($bundles = array())
......
...@@ -113,7 +113,7 @@ class Cookie { ...@@ -113,7 +113,7 @@ class Cookie {
* @param string $path * @param string $path
* @param string $domain * @param string $domain
* @param bool $secure * @param bool $secure
* @return bool * @return void
*/ */
public static function put($name, $value, $minutes = 0, $path = '/', $domain = null, $secure = false) public static function put($name, $value, $minutes = 0, $path = '/', $domain = null, $secure = false)
{ {
......
...@@ -26,7 +26,7 @@ class Database { ...@@ -26,7 +26,7 @@ class Database {
* </code> * </code>
* *
* @param string $connection * @param string $connection
* @return Connection * @return Database\Connection
*/ */
public static function connection($connection = null) public static function connection($connection = null)
{ {
...@@ -62,7 +62,7 @@ class Database { ...@@ -62,7 +62,7 @@ class Database {
* Create a new database connector instance. * Create a new database connector instance.
* *
* @param string $driver * @param string $driver
* @return Connector * @return Database\Connectors\Connector
*/ */
protected static function connector($driver) protected static function connector($driver)
{ {
...@@ -90,7 +90,7 @@ class Database { ...@@ -90,7 +90,7 @@ class Database {
* *
* @param string $table * @param string $table
* @param string $connection * @param string $connection
* @return Queries\Query * @return Database\Query
*/ */
public static function table($table, $connection = null) public static function table($table, $connection = null)
{ {
......
...@@ -625,7 +625,7 @@ class Query { ...@@ -625,7 +625,7 @@ class Query {
/** /**
* Get an aggregate value. * Get an aggregate value.
* *
* @param string $aggregate * @param string $aggregator
* @param string $column * @param string $column
* @return mixed * @return mixed
*/ */
......
...@@ -99,7 +99,9 @@ class Table { ...@@ -99,7 +99,9 @@ class Table {
/** /**
* Create a new index on the table. * Create a new index on the table.
* *
* @param string|array * @param string|array $columns
* @param string $name
* @return Fluent
*/ */
public function index($columns, $name) public function index($columns, $name)
{ {
...@@ -237,7 +239,6 @@ class Table { ...@@ -237,7 +239,6 @@ class Table {
* Add a float column to the table. * Add a float column to the table.
* *
* @param string $name * @param string $name
* @param bool $increment
* @return Fluent * @return Fluent
*/ */
public function float($name) public function float($name)
......
...@@ -93,7 +93,7 @@ class File { ...@@ -93,7 +93,7 @@ class File {
/** /**
* Get the file size of a given file. * Get the file size of a given file.
* *
* @param string $file * @param string $path
* @return int * @return int
*/ */
public static function size($path) public static function size($path)
...@@ -149,7 +149,7 @@ class File { ...@@ -149,7 +149,7 @@ class File {
* $image = File::is(array('jpg', 'png', 'gif'), 'path/to/file'); * $image = File::is(array('jpg', 'png', 'gif'), 'path/to/file');
* </code> * </code>
* *
* @param array|string $extension * @param array|string $extensions
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
......
...@@ -186,6 +186,7 @@ class Form { ...@@ -186,6 +186,7 @@ class Form {
* echo Form::input('text', 'email', 'example@gmail.com'); * echo Form::input('text', 'email', 'example@gmail.com');
* </code> * </code>
* *
* @param string $type
* @param string $name * @param string $name
* @param mixed $value * @param mixed $value
* @param array $attributes * @param array $attributes
...@@ -389,7 +390,7 @@ class Form { ...@@ -389,7 +390,7 @@ class Form {
* *
* @param string $value * @param string $value
* @param string $display * @param string $display
* @return string $selected * @param string $selected
* @return string * @return string
*/ */
protected static function option($value, $display, $selected) protected static function option($value, $display, $selected)
...@@ -506,6 +507,7 @@ class Form { ...@@ -506,6 +507,7 @@ class Form {
* </code> * </code>
* *
* @param string $url * @param string $url
* @param string $name
* @param array $attributes * @param array $attributes
* @return string * @return string
*/ */
...@@ -519,7 +521,6 @@ class Form { ...@@ -519,7 +521,6 @@ class Form {
/** /**
* Create a HTML button element. * Create a HTML button element.
* *
* @param string $name
* @param string $value * @param string $value
* @param array $attributes * @param array $attributes
* @return string * @return string
......
...@@ -26,7 +26,7 @@ function __($key, $replacements = array(), $language = null) ...@@ -26,7 +26,7 @@ function __($key, $replacements = array(), $language = null)
return Laravel\Lang::line($key, $replacements, $language); return Laravel\Lang::line($key, $replacements, $language);
} }
/**a /**
* Get an item from an array using "dot" notation. * Get an item from an array using "dot" notation.
* *
* <code> * <code>
......
...@@ -173,6 +173,7 @@ class HTML { ...@@ -173,6 +173,7 @@ class HTML {
* @param string $title * @param string $title
* @param array $parameters * @param array $parameters
* @param array $attributes * @param array $attributes
* @param bool $https
* @return string * @return string
*/ */
public static function link_to_route($name, $title, $parameters = array(), $attributes = array(), $https = false) public static function link_to_route($name, $title, $parameters = array(), $attributes = array(), $https = false)
......
...@@ -21,6 +21,7 @@ class IoC { ...@@ -21,6 +21,7 @@ class IoC {
* *
* @param string $name * @param string $name
* @param Closure $resolver * @param Closure $resolver
* @param bool $singleton
* @return void * @return void
*/ */
public static function register($name, Closure $resolver, $singleton = false) public static function register($name, Closure $resolver, $singleton = false)
......
...@@ -5,7 +5,7 @@ class Memcached { ...@@ -5,7 +5,7 @@ class Memcached {
/** /**
* The Memcached connection instance. * The Memcached connection instance.
* *
* @var Memcache * @var Memcached
*/ */
protected static $connection; protected static $connection;
...@@ -20,7 +20,7 @@ class Memcached { ...@@ -20,7 +20,7 @@ class Memcached {
* Memcached::connection()->set('name', 'Taylor'); * Memcached::connection()->set('name', 'Taylor');
* </code> * </code>
* *
* @return Memcache * @return Memcached
*/ */
public static function connection() public static function connection()
{ {
...@@ -36,7 +36,7 @@ class Memcached { ...@@ -36,7 +36,7 @@ class Memcached {
* Create a new Memcached connection instance. * Create a new Memcached connection instance.
* *
* @param array $servers * @param array $servers
* @return Memcache * @return Memcached
*/ */
protected static function connect($servers) protected static function connect($servers)
{ {
......
...@@ -12,6 +12,7 @@ class Messages { ...@@ -12,6 +12,7 @@ class Messages {
/** /**
* Create a new Messages instance. * Create a new Messages instance.
* *
* @param array $messages
* @return void * @return void
*/ */
public function __construct($messages = array()) public function __construct($messages = array())
......
...@@ -71,10 +71,10 @@ class Paginator { ...@@ -71,10 +71,10 @@ class Paginator {
* Create a new Paginator instance. * Create a new Paginator instance.
* *
* @param array $results * @param array $results
* @param int $last
* @param int $page * @param int $page
* @param int $total * @param int $total
* @param int $per_page * @param int $per_page
* @param int $last
* @return void * @return void
*/ */
protected function __construct($results, $page, $total, $per_page, $last) protected function __construct($results, $page, $total, $per_page, $last)
...@@ -246,6 +246,7 @@ class Paginator { ...@@ -246,6 +246,7 @@ class Paginator {
* echo $paginator->previous('Go Back'); * echo $paginator->previous('Go Back');
* </code> * </code>
* *
* @param string $text
* @return string * @return string
*/ */
public function previous($text = null) public function previous($text = null)
...@@ -266,6 +267,7 @@ class Paginator { ...@@ -266,6 +267,7 @@ class Paginator {
* echo $paginator->next('Skip Forwards'); * echo $paginator->next('Skip Forwards');
* </code> * </code>
* *
* @param string $text
* @return string * @return string
*/ */
public function next($text = null) public function next($text = null)
...@@ -364,7 +366,7 @@ class Paginator { ...@@ -364,7 +366,7 @@ class Paginator {
* *
* @param int $page * @param int $page
* @param string $text * @param string $text
* @param string $attributes * @param string $class
* @return string * @return string
*/ */
protected function link($page, $text, $class) protected function link($page, $text, $class)
......
...@@ -28,7 +28,7 @@ class Redirect extends Response { ...@@ -28,7 +28,7 @@ class Redirect extends Response {
* *
* @param string $url * @param string $url
* @param int $status * @param int $status
* @return Response * @return Redirect
*/ */
public static function to_secure($url, $status = 302) public static function to_secure($url, $status = 302)
{ {
...@@ -82,7 +82,7 @@ class Redirect extends Response { ...@@ -82,7 +82,7 @@ class Redirect extends Response {
* *
* @param string $key * @param string $key
* @param mixed $value * @param mixed $value
* @return Response * @return Redirect
*/ */
public function with($key, $value) public function with($key, $value)
{ {
......
...@@ -155,6 +155,7 @@ class Filter_Collection { ...@@ -155,6 +155,7 @@ class Filter_Collection {
* *
* @param string|array $filters * @param string|array $filters
* @param mixed $parameters * @param mixed $parameters
* @return void
*/ */
public function __construct($filters, $parameters = null) public function __construct($filters, $parameters = null)
{ {
......
...@@ -142,7 +142,7 @@ class Route { ...@@ -142,7 +142,7 @@ class Route {
* *
* If the route belongs to a bundle, the bundle's global filters are returned too. * If the route belongs to a bundle, the bundle's global filters are returned too.
* *
* @param string $filter * @param string $event
* @return array * @return array
*/ */
protected function filters($event) protected function filters($event)
......
...@@ -254,8 +254,8 @@ class Router { ...@@ -254,8 +254,8 @@ class Router {
/** /**
* Locate the URI segment matching a controller name. * Locate the URI segment matching a controller name.
* *
* @param string $directory
* @param array $segments * @param array $segments
* @param string $directory
* @return int * @return int
*/ */
protected static function locate($segments, $directory) protected static function locate($segments, $directory)
......
...@@ -5,7 +5,7 @@ class Session { ...@@ -5,7 +5,7 @@ class Session {
/** /**
* The session singleton instance for the request. * The session singleton instance for the request.
* *
* @var Payload * @var Session\Payload
*/ */
public static $instance; public static $instance;
...@@ -31,7 +31,7 @@ class Session { ...@@ -31,7 +31,7 @@ class Session {
* Create a new session driver instance. * Create a new session driver instance.
* *
* @param string $driver * @param string $driver
* @return Driver * @return Session\Drivers\Driver
*/ */
public static function factory($driver) public static function factory($driver)
{ {
...@@ -71,7 +71,7 @@ class Session { ...@@ -71,7 +71,7 @@ class Session {
* Session::instance()->put('name', 'Taylor'); * Session::instance()->put('name', 'Taylor');
* </code> * </code>
* *
* @return Payload * @return Session\Payload
*/ */
public static function instance() public static function instance()
{ {
......
...@@ -5,14 +5,14 @@ class APC implements Driver { ...@@ -5,14 +5,14 @@ class APC implements Driver {
/** /**
* The APC cache driver instance. * The APC cache driver instance.
* *
* @var Cache\Drivers\APC * @var Laravel\Cache\Drivers\APC
*/ */
private $apc; private $apc;
/** /**
* Create a new APC session driver instance. * Create a new APC session driver instance.
* *
* @param Cache\Drivers\APC $apc * @param Laravel\Cache\Drivers\APC $apc
* @return void * @return void
*/ */
public function __construct(\Laravel\Cache\Drivers\APC $apc) public function __construct(\Laravel\Cache\Drivers\APC $apc)
......
...@@ -5,14 +5,14 @@ class Memcached implements Driver { ...@@ -5,14 +5,14 @@ class Memcached implements Driver {
/** /**
* The Memcache cache driver instance. * The Memcache cache driver instance.
* *
* @var Cache\Drivers\Memcached * @var Laravel\Cache\Drivers\Memcached
*/ */
private $memcached; private $memcached;
/** /**
* Create a new Memcached session driver instance. * Create a new Memcached session driver instance.
* *
* @param Memcached $memcached * @param Laravel\Cache\Drivers\Memcached $memcached
* @return void * @return void
*/ */
public function __construct(\Laravel\Cache\Drivers\Memcached $memcached) public function __construct(\Laravel\Cache\Drivers\Memcached $memcached)
......
...@@ -5,14 +5,14 @@ class Redis implements Driver { ...@@ -5,14 +5,14 @@ class Redis implements Driver {
/** /**
* The Redis cache driver instance. * The Redis cache driver instance.
* *
* @var Cache\Drivers\Redis * @var Laravel\Cache\Drivers\Redis
*/ */
protected $redis; protected $redis;
/** /**
* Create a new Redis session driver. * Create a new Redis session driver.
* *
* @param Cache\Drivers\Redis $redis * @param Laravel\Cache\Drivers\Redis $redis
* @return void * @return void
*/ */
public function __construct(\Laravel\Cache\Drivers\Redis $redis) public function __construct(\Laravel\Cache\Drivers\Redis $redis)
......
...@@ -202,7 +202,7 @@ class Payload { ...@@ -202,7 +202,7 @@ class Payload {
* Session::keep(array('name', 'email')); * Session::keep(array('name', 'email'));
* </code> * </code>
* *
* @param string|array $key * @param string|array $keys
* @return void * @return void
*/ */
public function keep($keys) public function keep($keys)
......
...@@ -154,6 +154,7 @@ class Str { ...@@ -154,6 +154,7 @@ class Str {
* </code> * </code>
* *
* @param string $value * @param string $value
* @param int $count
* @return string * @return string
*/ */
public static function plural($value, $count = 2) public static function plural($value, $count = 2)
...@@ -177,7 +178,7 @@ class Str { ...@@ -177,7 +178,7 @@ class Str {
* </code> * </code>
* *
* @param string $value * @param string $value
* @param int $length * @param int $words
* @param string $end * @param string $end
* @return string * @return string
*/ */
......
...@@ -946,7 +946,7 @@ class Validator { ...@@ -946,7 +946,7 @@ class Validator {
/** /**
* Get the database connection for the Validator. * Get the database connection for the Validator.
* *
* @return Connection * @return Database\Connection
*/ */
protected function db() protected function db()
{ {
......
...@@ -183,7 +183,7 @@ class View implements ArrayAccess { ...@@ -183,7 +183,7 @@ class View implements ArrayAccess {
* </code> * </code>
* *
* @param string $view * @param string $view
* @param Closure * @param Closure $composer
* @return void * @return void
*/ */
public static function composer($view, $composer) public static function composer($view, $composer)
......
...@@ -68,17 +68,28 @@ foreach ($paths as $name => $path) ...@@ -68,17 +68,28 @@ foreach ($paths as $name => $path)
$GLOBALS['laravel_paths'][$name] = realpath($path).DS; $GLOBALS['laravel_paths'][$name] = realpath($path).DS;
} }
// -------------------------------------------------------------- /**
// Define a global path helper function. * A global path helper function.
// -------------------------------------------------------------- *
* <code>
* $storage = path('storage');
* </code>
*
* @param string $path
* @return string
*/
function path($path) function path($path)
{ {
return $GLOBALS['laravel_paths'][$path]; return $GLOBALS['laravel_paths'][$path];
} }
// -------------------------------------------------------------- /**
// Define a global path setter function. * A global path setter function.
// -------------------------------------------------------------- *
* @param string $path
* @param string $value
* @return void
*/
function set_path($path, $value) function set_path($path, $value)
{ {
$GLOBALS['laravel_paths'][$path] = $value; $GLOBALS['laravel_paths'][$path] = $value;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment