Stars: 257
Forks: 61
Pull Requests: 63
Issues: 58
Watchers: 17
Last Updated: 2022-10-07 10:37:59
A Laravel package to manage your polls
License: MIT License
Languages: PHP, Blade
A Laravel package to manage your polls
First, install the package through Composer.
composer require inani/larapoll
You can skip the next two steps
Then include the service provider inside config/app.php
.
'providers' => [
...
Inani\Larapoll\LarapollServiceProvider::class,
...
];
'aliases' => [
...
'PollWriter' => Inani\Larapoll\PollWriterFacade::class,
...
];
Publish migrations, and migrate
php artisan vendor:publish
php artisan migrate
To setup a model all you have to do is add (and import) the Voter
trait.
use Inani\Larapoll\Traits\Voter;
class User extends Model
{
use Voter;
...
}
// create the question
$poll = new Poll([
'question' => 'What is the best PHP framework?'
]);
// attach options and how many options you can vote to
// more than 1 options will be considered as checkboxes
$poll->addOptions(['Laravel', 'Zend', 'Symfony', 'Cake'])
->maxSelection() // you can ignore it as well
->generate();
$poll->isRadio(); // true
$poll->isCheckable(); // false
$poll->optionsNumber(); // 4
// to add new elements
$bool = $poll->attach([
'Yii', 'CodeIgniter'
]);
$poll->optionsNumber(); // 6
// to remove options(not voted yet)
$option = $poll->options()->first(); // get first option
$bool = $poll->detach($option);
$poll->optionsNumber(); // 5
$bool = $poll->lock();
$bool = $poll->unLock();
All related options and votes will be deleted once the Poll is removed
$bool = $poll->remove();
// a voter(user) picks a poll to vote for
// only ids or array of ids are accepted
$voter->poll($poll)->vote($voteFor->getKey());
// get results unordered
$poll->results()->grab();
// get results in order (desc)
$poll->results()->inOrder();
LaraPoll ships with a UI a system to manage polls, very easy and fast. you need practically nothing to start using it. Please visit the link for the explantation of the interface.
A larapoll_config.php file will be added where you can put the name of the middleware used to protect the access and other things like pagination and prefix to protect your routes Add this line in the .env too
LARAPOLL_ADMIN_AUTH_MIDDLEWARE = auth
LARAPOLL_ADMIN_AUTH_GUARD = web
LARAPOLL_PAGINATION = 10
LARAPOLL_PREFIX = Larapoll
With Larapoll its easy to integrate a poll for users to vote, you only have to specify two things
{{ PollWriter::draw(Inani\Larapoll\Poll::find(77)) }}
You can override the views related to the results page and both pages checkbox/radio via the same larapoll_config.php file in the config folder.
{{ route('poll.vote', $id) }}