Wallogit.com
2017 © Pedro Peláez
a laravel wrapper for the flywheel package
This is a wrapper class for the Jamesmoss/flywheel package., (*1)
This is a facade that can be used beside the default laravel database structure. Since this doesn't override Laravel's core database functionality you can use both at the same time., (*2)
composer require allenjd3\laravel-flywheel
Then add to your config/app file under application providers, (*3)
'providers' => [
...
/*
* Package Service Providers...
*/
Allenjd3\Flywheel\FlywheelServiceProvider::class,
...
]
If you want to use the Facade then add this to your aliases array, (*4)
'aliases' => [
...
'Flywheel' => Allenjd3\Flywheel\facades\Flywheel::class,
...
]
This method is optional if you want to change either the table name or storage path, (*5)
Example- (optional), (*6)
$flywheel = Flywheel::config($name, $path); $flywheel->findAll();
This method creates a new Document and saves it to your path. You can use laravel validation on the request before running this., (*7)
$id = Flywheel::create($array)
This method updates a post. You must find the post by id before updating it., (*8)
$doc = Flywheel::findById($id); $doc->param = "new value"; Flywheel::update($doc);
This method finds all documents within the given configuration path, (*9)
$docs = Flywheel::findAll();
This method deletes a post that matches a given id., (*10)
Flywheel::delete($id)
This method returns a query object that can be chained, (*11)
$docs = Flywheel::where('title', '==', 'Shiver Me Timbers')->get();
Get ends the queries and executes the result., (*12)
$docs = Flywheel::limit($count, $offset)->get();
$docs = Flywheel::orderBy('fieldname ASC|DESC')->get();
andWhere is a wrapper for additional where queries., (*13)
All types of queries, (where, limit, orderby, andWhere) can be chained before calling get. Example-, (*14)
$docs = Flywheel::where('title','==','Most Excellent')
->limit(5,2)
->orderBy('title ASC')
->get();
If you only want to return a single document you can run first instead of get, (*15)
$doc = Flywheel::where('title', '==', 'Most Excellent')->first();
All returned values can be returned and will return a json string., (*16)
return $docs;
If you want to return a laravel response object with application/json headers then you can run, (*17)
return $docs->toJson();
or, (*18)
return $docs->toArray();
of course you can always pass the variable into a Blade template, (*19)
return view('template.name', compact('docs'));
Send a pull request!, (*20)
a laravel wrapper for the flywheel package
MIT
a laravel wrapper for the flywheel package
MIT
a laravel wrapper for the flywheel package
a laravel wrapper for the flywheel package