doc blocks

This commit is contained in:
David Bomba 2019-03-28 21:20:08 +11:00
parent d2e5563dbe
commit 6c874274b6
2 changed files with 15 additions and 4 deletions

View File

@ -45,6 +45,8 @@ class ClientFilters extends QueryFilters
* *
* @param string query filter * @param string query filter
* @return Illuminate\Database\Query\Builder * @return Illuminate\Database\Query\Builder
* @deprecated
*
*/ */
public function filter(string $filter = '') : Builder public function filter(string $filter = '') : Builder
{ {
@ -119,6 +121,7 @@ class ClientFilters extends QueryFilters
* *
* @param int company_id * @param int company_id
* @return Illuminate\Database\Query\Builder * @return Illuminate\Database\Query\Builder
* @deprecated
*/ */
public function baseQuery(int $company_id, User $user) : Builder public function baseQuery(int $company_id, User $user) : Builder
{ {
@ -167,6 +170,12 @@ class ClientFilters extends QueryFilters
return $query; return $query;
} }
/**
* Filters the query by the users company ID
*
* @param $company_id The company Id
* @return Illuminate\Database\Query\Builder
*/
public function entityFilter() public function entityFilter()
{ {

View File

@ -15,15 +15,17 @@ use Illuminate\Http\Request;
abstract class QueryFilters abstract class QueryFilters
{ {
/** /**
* * active status
*/ */
const STATUS_ACTIVE = 'active'; const STATUS_ACTIVE = 'active';
/** /**
* * archived status
*/ */
const STATUS_ARCHIVED = 'archived'; const STATUS_ARCHIVED = 'archived';
/** /**
* * deleted status
*/ */
const STATUS_DELETED = 'deleted'; const STATUS_DELETED = 'deleted';
@ -62,7 +64,7 @@ abstract class QueryFilters
$this->builder = $builder; $this->builder = $builder;
$this->entityFilter(); $this->entityFilter();
foreach ($this->filters() as $name => $value) { foreach ($this->filters() as $name => $value) {
if (! method_exists($this, $name)) { if (! method_exists($this, $name)) {
continue; continue;