completed functionality and docs update

master
glmdev 7 years ago
parent 529f22c4b9
commit 68165c948a

@ -1,24 +1,5 @@
# The GNU Affero GPL (AGPL-3.0)
Copyright (c) 2016 :author_name <:author_email>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU Affero General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU Affero General Public License for more details.
>
> You should have received a copy of the GNU Affero General Public License
> along with this program. If not, see <http://www.gnu.org/licenses/>.
```
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
@ -26,15 +7,17 @@ Copyright (c) 2016 :author_name <:author_email>
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
@ -43,34 +26,44 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
@ -79,7 +72,7 @@ modification follow.
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
@ -556,45 +549,35 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
@ -635,6 +618,4 @@ an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
```
END OF TERMS AND CONDITIONS

@ -3,95 +3,64 @@
[![Latest Version on Packagist](https://img.shields.io/packagist/v/element/search.svg?maxAge=2592000&style=flat-square)](https://packagist.org/packages/element/search)
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg?style=flat-square)](LICENSE.md)
[![Author](http://img.shields.io/badge/author-Garrett_Mills-blue.svg?style=flat-square)](https://glmdev.github.io/)
[![Build Status](https://img.shields.io/travis/element/search/master.svg?style=flat-square)](https://travis-ci.org/element/search)
This is a simple hit based search engine for Eloquent models. It can take a string and will search the given set of models for each word in that string.
This is a simple hit-based search engine for Eloquent models. It can take a string and will search the given set of models for each word in that string.
It prioritizes models based on the number of times each word in the search string is found in the searchable fields in the model, with more emphasis
on longer words, and less on shorter.
## Install
The search Element is available on composer. To install it, simply run:
Using Composer:
``` bash
$ composer require element/search
$ composer require glmdev/search
```
Then, add the following line to the `$providers` array in the `config/app.php` file:
Update Laravel's providers array (`app/config.php`):
``` php
Element\Search\SearchServiceProvider::class,
'providers' => [
// ... other providers ...
Glmdev\Search\SearchServiceProvider::class,
]
```
## Use
Making your models searchable is easy. The models simply need to implement the `Element\Search\SearchableContract`
interface. Then, add the `getSearchable()` method to the model. This method should return an array of the names
of the Model's fields that the search engine can search. These fields should hold string/text data only.
Making your models searchable is easy. The models need to implement the `Glmdev\Search\SearchableContract`
interface, use the `Glmdev\Search\SearchableAgreement` trait, and have the searchable fields defined.
For Example:
Add the fields the engine should search in the `$searchable` variable.
``` php
<?php
For example:
``` php
namespace App;
use Element\Search\SearchableContract;
use Glmdev\Search\SearchableContract;
use Glmdev\Search\SearchableAgreement;
use Illuminate\Database\Eloquent\Model;
class BlogPost extends Model implements SearchableContract {
protected $fillable = [ 'date-created', 'date-published', 'title', 'body',
'author', 'image', 'viewcount' ];
public static function getSearchable(){
return [ 'title', 'body', 'author' ];
}
public static function search( $string ){
return Search::search( new self, $string );
}
use SearchableAgreement;
protected $fillable = [ 'date-created', 'date-published', 'title', 'body', 'author' ];
protected $searchable = [ 'title', 'body', 'author' ];
}
```
In the model above, we can see from the `getSearchable()` function that the Search Engine will search
In the model above, we can see from the `$searchable` variable that the search engine will search
the 'title', 'body', and 'author' fields.
The second function is optional, but it allows you to call the search function statically from the
model, rather than the search facade.
ie:
``` php
App\BlogPost::search('search string');
```
### The Search Facade
### Using the search functionality
The Element Search plugin adds a Search facade to the Laravel app. This allows you to call a
search on any model from anywhere using the following function:
Once your model is set up, you can search it using the `search()` function in the model, like so:
``` php
Search::search( new App\ModelName, 'search string');
BlogPost::search('search query');
```
Where `App\ModelName` is a new instance of the model you wish to search, and `'search string'` is
any string you wish to search for. Additionally, you don't have to worry about removing punctuation
or capital letters from your search string, the function does it automatically.
The search function, whether in the model, or called from the facade, returns the models in the form
of a `\Laravel\Database\Eloquent\Collection` collection. This allows you to perform all the usual
functions you would be able to perform on a database query.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email glmdev@outlook.com instead of using the issue tracker.
## Credits
- [Garrett Mills](https://glmdev.github.io/)
@ -99,15 +68,15 @@ If you discover any security related issues, please email glmdev@outlook.com ins
## License
The search Element is licensed under the GNU Affero General Public
The search package is licensed under the GNU General Public
License, version 3.0.
```
element/search
glmdev/search
Copyright (C) 2016 Garrett Mills
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
@ -116,6 +85,6 @@ element/search
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
```

@ -1,13 +1,15 @@
{
"name": "element/search",
"name": "glmdev/search",
"type": "library",
"description": "A simple tag-based search engine for Laravel models.",
"keywords": [
"element",
"search"
"glmdev",
"search",
"eloquent",
"laravel"
],
"homepage": "https://github.com/elementalize/search",
"license": "AGPL-3.0",
"homepage": "https://github.com/glmdev/search",
"license": "GPL-3.0",
"authors": [
{
"name": "Garrett Mills",
@ -26,12 +28,12 @@
},
"autoload": {
"psr-4": {
"Element\\Search\\": "src"
"Glmdev\\Search\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Element\\Search\\Test\\": "tests"
"Glmdev\\Search\\Test\\": "tests"
}
}
}

@ -6,22 +6,39 @@
* Time: 6:27 PM
*/
namespace Element\Search;
namespace Glmdev\Search;
class Search {
/**
* Searches the collection of given $model type for
* Searches the collection of given $modelClass type for
* $string and returns the results.
*
* @param SearchableContract $model
* @param string $modelClass
* @param $string
* @return \Illuminate\Support\Collection
*/
public function search( SearchableContract $model, $string ){
/* @var $model \Illuminate\Database\Eloquent\Model */
$query = $this->formatQuery( $string );
public static function search( $modelClass, $string ){
// define the model container in the correct scope
$model = null;
// check if the provided class name is searchable
if ( new $modelClass() instanceof SearchableContract ){
// set the model
$model = new $modelClass();
}
else {
throw new \Exception('Cannot attempt to search non-searchable class.');
return;
}
// sanitize and format the query
$query = self::formatQuery( $string );
// get all the models
$models = $model->all();
// initialize working arrays
$returns = [];
$toOpt = [];
$optHits = [];
@ -129,7 +146,7 @@ class Search {
* @param $string
* @return array
*/
public function formatQuery( $string ){
public static function formatQuery( $string ){
$words = explode(' ', $string);
$return = [];
foreach ( $words as $word ){

@ -1,20 +0,0 @@
<?php
/**
* Created by PhpStorm.
* User: 91373
* Date: 7/8/2016
* Time: 6:31 PM
*/
namespace Element\Search;
use Illuminate\Support\Facades\Facade;
class SearchFacade extends Facade
{
public static function getFacadeAccessor()
{
return 'e-search';
}
}

@ -1,24 +1,22 @@
<?php
namespace Element\Search;
namespace Glmdev\Search;
use Illuminate\Support\ServiceProvider;
class SearchServiceProvider extends ServiceProvider
{
public function boot(){
}
public function boot(){}
/**
* Register the service and alias the Search class.
*
* @return void
*/
public function register(){
$this->app->bind('e-search', function(){
return new Search;
});
$loader = \Illuminate\Foundation\AliasLoader::getInstance();
$loader->alias('Search', 'Element\Search\SearchFacade');
$loader->alias('Search', 'Glmdev\Search\Search');
}
}

@ -0,0 +1,28 @@
<?php
namespace Glmdev\Search;
trait SearchableAgreement {
/**
* returns the searchable fields from the protected $searchable array
*
* @return array
*/
public static function getSearchable(){
$inst = new self();
return $inst->searchable;
}
/**
* searches the model for the query and returns the results
*
* @param string $query
*
* @return \Illuminate\Support\Collection
*/
public static function search( $query ){
return \Search::search( self::class, $query );
}
}

@ -1,6 +1,6 @@
<?php
namespace Element\Search;
namespace Glmdev\Search;
interface SearchableContract {

Loading…
Cancel
Save