diff --git a/app/DataMapper/DefaultSettings.php b/app/DataMapper/DefaultSettings.php index e0d3f00a20c1..cd0e15e83d6d 100644 --- a/app/DataMapper/DefaultSettings.php +++ b/app/DataMapper/DefaultSettings.php @@ -4,11 +4,21 @@ namespace App\DataMapper; use App\Models\Client; +/** + * Class DefaultSettings + * @package App\DataMapper + */ class DefaultSettings { + /** + * @var int + */ public static $per_page = 25; + /** + * @return \stdClass + */ public static function userSettings() : \stdClass { return (object)[ @@ -16,6 +26,9 @@ class DefaultSettings ]; } + /** + * @return \stdClass + */ private static function clientSettings() : \stdClass { diff --git a/app/Datatables/ClientDatatable.php b/app/Datatables/ClientDatatable.php index b7bc4aa30030..fde6a6c76993 100644 --- a/app/Datatables/ClientDatatable.php +++ b/app/Datatables/ClientDatatable.php @@ -9,13 +9,24 @@ use App\Utils\Traits\UserSessionAttributes; use Illuminate\Http\Request; use Illuminate\Support\Collection; +/** + * Class ClientDatatable + * @package App\Datatables + */ class ClientDatatable extends EntityDatatable { use MakesHash; use MakesActionMenu; + /** + * @var ClientFilters + */ protected $filter; + /** + * ClientDatatable constructor. + * @param ClientFilters $filter + */ public function __construct(ClientFilters $filter) { $this->filter = $filter; @@ -32,7 +43,12 @@ class ClientDatatable extends EntityDatatable } - + + /** + * @param int $company_id + * @param bool $userId + * @return mixed + */ private function find(int $company_id, $userId = false) { diff --git a/app/Datatables/EntityDataTable.php b/app/Datatables/EntityDataTable.php index fef3431fb031..beaff3e4b531 100644 --- a/app/Datatables/EntityDataTable.php +++ b/app/Datatables/EntityDataTable.php @@ -3,6 +3,10 @@ namespace App\Datatables; +/** + * Class EntityDatatable + * @package App\Datatables + */ class EntityDatatable { diff --git a/app/Datatables/MakesActionMenu.php b/app/Datatables/MakesActionMenu.php index 835a75fcd7e2..4b0f588bb5c9 100644 --- a/app/Datatables/MakesActionMenu.php +++ b/app/Datatables/MakesActionMenu.php @@ -4,6 +4,10 @@ namespace App\Datatables; use Illuminate\Support\Collection; +/** + * Class MakesActionMenu + * @package App\Datatables + */ trait MakesActionMenu { /** diff --git a/app/Events/Account/AccountCreated.php b/app/Events/Account/AccountCreated.php index 0b8d9d9c8323..46139a127417 100644 --- a/app/Events/Account/AccountCreated.php +++ b/app/Events/Account/AccountCreated.php @@ -10,10 +10,17 @@ use Illuminate\Foundation\Events\Dispatchable; use Illuminate\Broadcasting\InteractsWithSockets; use Illuminate\Contracts\Broadcasting\ShouldBroadcast; +/** + * Class AccountCreated + * @package App\Events\Account + */ class AccountCreated { use Dispatchable, InteractsWithSockets, SerializesModels; + /** + * @var + */ public $user; /** diff --git a/app/Events/User/UserCreated.php b/app/Events/User/UserCreated.php index ca95be8ce5a0..92548f80952b 100644 --- a/app/Events/User/UserCreated.php +++ b/app/Events/User/UserCreated.php @@ -10,10 +10,17 @@ use Illuminate\Foundation\Events\Dispatchable; use Illuminate\Broadcasting\InteractsWithSockets; use Illuminate\Contracts\Broadcasting\ShouldBroadcast; +/** + * Class UserCreated + * @package App\Events\User + */ class UserCreated { use Dispatchable, InteractsWithSockets, SerializesModels; + /** + * @var + */ public $user; /** diff --git a/app/Filters/QueryFilters.php b/app/Filters/QueryFilters.php index 62f2b1dbb0cf..32a19ff42a9d 100644 --- a/app/Filters/QueryFilters.php +++ b/app/Filters/QueryFilters.php @@ -6,10 +6,23 @@ use App\Models\User; use Illuminate\Database\Query\Builder; use Illuminate\Http\Request; +/** + * Class QueryFilters + * @package App\Filters + */ abstract class QueryFilters { + /** + * + */ const STATUS_ACTIVE = 'active'; + /** + * + */ const STATUS_ARCHIVED = 'archived'; + /** + * + */ const STATUS_DELETED = 'deleted'; /** diff --git a/app/Http/Controllers/ClientController.php b/app/Http/Controllers/ClientController.php index aa867bb05220..cc23c9ddbac7 100644 --- a/app/Http/Controllers/ClientController.php +++ b/app/Http/Controllers/ClientController.php @@ -24,22 +24,40 @@ use Illuminate\Support\Facades\Log; use Yajra\DataTables\Facades\DataTables; use Yajra\DataTables\Html\Builder; +/** + * Class ClientController + * @package App\Http\Controllers + */ class ClientController extends Controller { use UserSessionAttributes; use MakesHash; use MakesMenu; + /** + * @var ClientRepository + */ protected $clientRepo; + /** + * @var ClientDatatable + */ protected $clientDatatable; + /** + * ClientController constructor. + * @param ClientRepository $clientRepo + * @param ClientDatatable $clientDatatable + */ public function __construct(ClientRepository $clientRepo, ClientDatatable $clientDatatable) { $this->clientRepo = $clientRepo; $this->clientDatatable = $clientDatatable; } + /** + * @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\JsonResponse|\Illuminate\View\View + */ public function index() { ; diff --git a/app/Http/Controllers/CompanyController.php b/app/Http/Controllers/CompanyController.php index 4921b3131aaf..a24ebc4e0a5d 100644 --- a/app/Http/Controllers/CompanyController.php +++ b/app/Http/Controllers/CompanyController.php @@ -11,10 +11,17 @@ use Illuminate\Http\Request; use Illuminate\Support\Facades\Auth; use Illuminate\Support\Facades\Hash; +/** + * Class CompanyController + * @package App\Http\Controllers + */ class CompanyController extends Controller { use DispatchesJobs; + /** + * CompanyController constructor. + */ public function __construct() { $this->middleware('guest'); diff --git a/app/Http/Controllers/ContactController.php b/app/Http/Controllers/ContactController.php index 221f13c0f30b..abe46ae11024 100644 --- a/app/Http/Controllers/ContactController.php +++ b/app/Http/Controllers/ContactController.php @@ -4,8 +4,15 @@ namespace App\Http\Controllers; use Illuminate\Http\Request; +/** + * Class ContactController + * @package App\Http\Controllers + */ class ContactController extends Controller { + /** + * ContactController constructor. + */ public function __construct() { $this->middleware('auth:contact'); diff --git a/app/Http/Controllers/SettingsController.php b/app/Http/Controllers/SettingsController.php index 42820f700a58..0e17884444fc 100644 --- a/app/Http/Controllers/SettingsController.php +++ b/app/Http/Controllers/SettingsController.php @@ -4,6 +4,10 @@ namespace App\Http\Controllers; use Illuminate\Http\Request; +/** + * Class SettingsController + * @package App\Http\Controllers + */ class SettingsController extends Controller { /** diff --git a/app/Http/Controllers/Traits/VerifiesUserEmail.php b/app/Http/Controllers/Traits/VerifiesUserEmail.php index b53fa3bd8d20..63cd24fda2ac 100644 --- a/app/Http/Controllers/Traits/VerifiesUserEmail.php +++ b/app/Http/Controllers/Traits/VerifiesUserEmail.php @@ -6,10 +6,18 @@ use App\Models\User; use App\Utils\Traits\UserSessionAttributes; use Illuminate\Support\Facades\Auth; +/** + * Class VerifiesUserEmail + * @package App\Http\Controllers\Traits + */ trait VerifiesUserEmail { use UserSessionAttributes; + /** + * @param $code + * @return \Illuminate\Http\RedirectResponse + */ public function confirm($code) { $user = User::where('confirmation_code', $code)->first(); diff --git a/app/Http/Controllers/TranslationController.php b/app/Http/Controllers/TranslationController.php index e381427aa165..8e11bc63e16d 100644 --- a/app/Http/Controllers/TranslationController.php +++ b/app/Http/Controllers/TranslationController.php @@ -5,6 +5,10 @@ namespace App\Http\Controllers; use Illuminate\Http\Request; use Illuminate\Support\Facades\Cache; +/** + * Class TranslationController + * @package App\Http\Controllers + */ class TranslationController extends Controller { /** diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php index ca911bf224fc..a4d562ba3f60 100644 --- a/app/Http/Controllers/UserController.php +++ b/app/Http/Controllers/UserController.php @@ -5,6 +5,10 @@ namespace App\Http\Controllers; use App\Http\Controllers\Traits\VerifiesUserEmail; use Illuminate\Http\Request; +/** + * Class UserController + * @package App\Http\Controllers + */ class UserController extends Controller { use VerifiesUserEmail; diff --git a/app/Http/Middleware/UrlSetDb.php b/app/Http/Middleware/UrlSetDb.php index 2f6e3acc4d6f..54e5f74a9697 100644 --- a/app/Http/Middleware/UrlSetDb.php +++ b/app/Http/Middleware/UrlSetDb.php @@ -6,6 +6,10 @@ use App\Libraries\MultiDB; use Closure; use Hashids\Hashids; +/** + * Class UrlSetDb + * @package App\Http\Middleware + */ class UrlSetDb { /** diff --git a/app/Http/ValidationRules/UniqueUserRule.php b/app/Http/ValidationRules/UniqueUserRule.php index 3b0703dd229e..d42e53dc628d 100644 --- a/app/Http/ValidationRules/UniqueUserRule.php +++ b/app/Http/ValidationRules/UniqueUserRule.php @@ -6,19 +6,35 @@ use App\Libraries\MultiDB; use App\Models\User; use Illuminate\Contracts\Validation\Rule; +/** + * Class UniqueUserRule + * @package App\Http\ValidationRules + */ class UniqueUserRule implements Rule { + /** + * @param string $attribute + * @param mixed $value + * @return bool + */ public function passes($attribute, $value) { return ! $this->checkIfEmailExists($value); //if it exists, return false! } + /** + * @return string + */ public function message() { return ctrans('texts.email_already_register'); } + /** + * @param $email + * @return bool + */ private function checkIfEmailExists($email) : bool { return MultiDB::checkUserEmailExists($email); diff --git a/app/Http/ViewComposers/HeaderComposer.php b/app/Http/ViewComposers/HeaderComposer.php index 40c5b8c7633e..84ce6615151c 100644 --- a/app/Http/ViewComposers/HeaderComposer.php +++ b/app/Http/ViewComposers/HeaderComposer.php @@ -5,6 +5,10 @@ namespace App\Http\ViewComposers; use App\Utils\Traits\UserSessionAttributes; use Illuminate\View\View; +/** + * Class HeaderComposer + * @package App\Http\ViewComposers + */ class HeaderComposer { use UserSessionAttributes; @@ -20,6 +24,9 @@ class HeaderComposer $view->with('header', $this->headerData()); } + /** + * @return array + */ private function headerData() { if(!auth()->user()) diff --git a/app/Models/Presenters/ClientContactPresenter.php b/app/Models/Presenters/ClientContactPresenter.php index d1d20827f58d..8e8be18269dd 100644 --- a/app/Models/Presenters/ClientContactPresenter.php +++ b/app/Models/Presenters/ClientContactPresenter.php @@ -2,6 +2,10 @@ namespace App\Models\Presenters; +/** + * Class ClientContactPresenter + * @package App\Models\Presenters + */ class ClientContactPresenter extends EntityPresenter { diff --git a/app/Models/Presenters/ClientPresenter.php b/app/Models/Presenters/ClientPresenter.php index 353962484894..aade4f6949a0 100644 --- a/app/Models/Presenters/ClientPresenter.php +++ b/app/Models/Presenters/ClientPresenter.php @@ -2,9 +2,16 @@ namespace App\Models\Presenters; +/** + * Class ClientPresenter + * @package App\Models\Presenters + */ class ClientPresenter extends EntityPresenter { + /** + * @return string + */ public function name() { return $this->entity->name ?: $this->entity->primary_contact->first()->first_name . ' '. $this->entity->primary_contact->first()->last_name; diff --git a/app/Models/Presenters/CompanyPresenter.php b/app/Models/Presenters/CompanyPresenter.php index 9a72f2a72cd2..e32f0531639a 100644 --- a/app/Models/Presenters/CompanyPresenter.php +++ b/app/Models/Presenters/CompanyPresenter.php @@ -2,9 +2,16 @@ namespace App\Models\Presenters; +/** + * Class CompanyPresenter + * @package App\Models\Presenters + */ class CompanyPresenter extends EntityPresenter { + /** + * @return string + */ public function name() { return $this->entity->name ?: ctrans('texts.untitled_account'); diff --git a/app/Models/Presenters/EntityPresenter.php b/app/Models/Presenters/EntityPresenter.php index a1b354b3c937..0f1555e81cb4 100644 --- a/app/Models/Presenters/EntityPresenter.php +++ b/app/Models/Presenters/EntityPresenter.php @@ -9,49 +9,80 @@ use URL; use Utils; use stdClass; +/** + * Class EntityPresenter + * @package App\Models\Presenters + */ class EntityPresenter extends Presenter { use MakesHash; + /** + * @return string + */ public function id() { return $this->encodePrimaryKey($this->entity->id); } + /** + * + */ public function url() { } + /** + * + */ public function path() { } + /** + * + */ public function editUrl() { } + /** + * @param bool $label + */ public function statusLabel($label = false) { } + /** + * + */ public function statusColor() { } + /** + * + */ public function link() { } + /** + * + */ public function titledName() { } + /** + * @param bool $subColors + */ public function calendarEvent($subColors = false) { diff --git a/app/Models/Presenters/UserPresenter.php b/app/Models/Presenters/UserPresenter.php index b06194d71657..41a2f84df179 100644 --- a/app/Models/Presenters/UserPresenter.php +++ b/app/Models/Presenters/UserPresenter.php @@ -2,9 +2,16 @@ namespace App\Models\Presenters; +/** + * Class UserPresenter + * @package App\Models\Presenters + */ class UserPresenter extends EntityPresenter { + /** + * @return string + */ public function name() { return $this->entity->first_name . ' ' . $this->entity->last_name; diff --git a/app/Utils/Traits/MakesHeaderData.php b/app/Utils/Traits/MakesHeaderData.php index fe886dbf5295..51d6d1de8084 100644 --- a/app/Utils/Traits/MakesHeaderData.php +++ b/app/Utils/Traits/MakesHeaderData.php @@ -4,7 +4,7 @@ namespace App\Utils\Traits; /** - * Class MakesHash + * Class MakesHeaderData * @package App\Utils\Traits */ trait MakesHeaderData @@ -12,6 +12,9 @@ trait MakesHeaderData use UserSessionAttributes; + /** + * @return array + */ public function headerData() : array { //companies diff --git a/app/Utils/Traits/UserSessionAttributes.php b/app/Utils/Traits/UserSessionAttributes.php index a198d23639fb..087016e42e7d 100644 --- a/app/Utils/Traits/UserSessionAttributes.php +++ b/app/Utils/Traits/UserSessionAttributes.php @@ -3,14 +3,24 @@ namespace App\Utils\Traits; +/** + * Class UserSessionAttributes + * @package App\Utils\Traits + */ trait UserSessionAttributes { + /** + * @param $value + */ public function setCurrentCompanyId($value) : void { session(['current_company_id' => $value]); } + /** + * @return int + */ public function getCurrentCompanyId() : int { return session('current_company_id'); diff --git a/app/Utils/Traits/UserSettings.php b/app/Utils/Traits/UserSettings.php index 7c782a2cc8c7..f74f6704aa29 100644 --- a/app/Utils/Traits/UserSettings.php +++ b/app/Utils/Traits/UserSettings.php @@ -2,14 +2,26 @@ namespace App\Utils\Traits; +/** + * Class UserSettings + * @package App\Utils\Traits + */ trait UserSettings { + /** + * @param string $entity + * @return \stdClass + */ public function getEntity(string $entity) : \stdClass { return $this->settings()->{$entity}; } + /** + * @param string $entity + * @return \stdClass + */ public function getColumnVisibility(string $entity) : \stdClass { return $this->settings()->{class_basename($entity)}->datatable->column_visibility;