fixed constructors PHPDocs wrong class names

This commit is contained in:
omair saleh
2020-12-08 16:21:53 +08:00
parent 05ecbc44fb
commit 372803e068
52 changed files with 137 additions and 84 deletions
@@ -72,8 +72,9 @@ class CreateUserLogic extends AbstractControllerLogic
/** @var CreatesSegmentCompany */
private $createsSegmentCompany;
/**
* CreateUserControllerLogic constructor.
* CreateUserLogic constructor.
* @param CanCreateUser $canCreateUser
* @param CreatesUser $createsUser
* @param CanCreateCompany $canCreateCompany
@@ -67,8 +67,9 @@ class RegistrationStep2Logic extends AbstractControllerLogic
/** @var Convert64ToFile */
private $convert64ToFile;
/**
* UpdateUserControllerLogic constructor.
* RegistrationStep2Logic constructor.
* @param FetchesUser $fetchesUser
* @param CanUpdateCompany $canUpdateCompany
* @param UpdatesCompany $updatesCompany
@@ -76,6 +77,7 @@ class RegistrationStep2Logic extends AbstractControllerLogic
* @param CreatesDocument $createsDocument
* @param CanCreateFile $canCreateFile
* @param CreatesFile $createsFile
* @param Convert64ToFile $convert64ToFile
*/
public function __construct(
FetchesUser $fetchesUser,
@@ -67,8 +67,9 @@ class UpdateUserLogic extends AbstractControllerLogic
/** @var Convert64ToFile */
private $convert64ToFile;
/**
* UpdateUserControllerLogic constructor.
* UpdateUserLogic constructor.
* @param FetchesUser $fetchesUser
* @param CanUpdateCompany $canUpdateCompany
* @param UpdatesCompany $updatesCompany
@@ -76,6 +77,7 @@ class UpdateUserLogic extends AbstractControllerLogic
* @param CreatesDocument $createsDocument
* @param CanCreateFile $canCreateFile
* @param CreatesFile $createsFile
* @param Convert64ToFile $convert64ToFile
*/
public function __construct(
FetchesUser $fetchesUser,
@@ -17,11 +17,12 @@ class AuthenticationCredentialsObject implements DataTransferObject
/** @var boolean */
private $rememberUser;
/**
* AuthenticationCredentials constructor.
* AuthenticationCredentialsObject constructor.
* @param string $email
* @param string $password
* @param bool $rememberUser
* @param bool|null $rememberUser
*/
public function __construct(string $email, string $password, ?bool $rememberUser = false)
{
@@ -21,7 +21,7 @@ class UserObject implements DataTransferObject
/** @var int */
private $type;
/** @var status */
/** @var int */
private $status;
/**
@@ -50,10 +50,12 @@ class CreateBookingLogic extends AbstractControllerLogic
/** @var FetchesCurrency */
private $fetchesCurrency;
/**
* CreateSegmentLogic constructor.
* CreateBookingLogic constructor.
* @param CanCreateBooking $canCreateBooking
* @param CreatesBooking $createsBooking
* @param GeneratesBookingMarking $generatesBookingMarking
* @param FetchesCompany $fetchesCompany
* @param FetchesCompanyBank $fetchesCompanyBank
* @param FetchesCurrency $fetchesCurrency
@@ -2,6 +2,8 @@
namespace App\Classes\Modules\Bookings\ControllersLogic;
use App\Classes\Modules\Segments\Services\UpdatesSegment;
use App\Classes\Modules\Segments\Standards\Rules\CanUpdateSegment;
use App\Http\Resources\BookingResource;
use App\Classes\General\Abstracts\AbstractControllerLogic;
@@ -39,12 +41,7 @@ class DeleteBookingLogic extends AbstractControllerLogic
/** @var FetchesBooking */
private $fetchesBooking;
/**
* UpdateStandardSegmentConstantLogic constructor.
* @param CanUpdateSegment $canDeleteBooking
* @param UpdatesSegment $deletesSegment
* @param FetchesBooking $fetchesBooking
*/
public function __construct(
CanDeleteBooking $canDeleteBooking,
DeletesBooking $deletesBooking,
@@ -33,14 +33,15 @@ class UpdateBookingLogic extends AbstractControllerLogic
/** @var CanUpdateBooking */
private $canUpdateBooking;
/** @var UpdatesBookingRate */
private $updatesBookingRate;
/** @var UpdatesBooking */
private $updatesBooking;
/** @var FetchesBooking */
private $fetchesBooking;
/**
* UpdateStandardSegmentConstantLogic constructor.
* UpdateBookingLogic constructor.
* @param CanUpdateBooking $canUpdateBooking
* @param UpdatesBooking $updatesBooking
* @param FetchesBooking $fetchesBooking
@@ -14,6 +14,7 @@ class BookingObject implements DataTransferObject
private $fix_currency_id;
private $convertible_currency_id;
private $conversion_currency_id;
/**
* BookingObject constructor.
* @param int|null $company_id
@@ -11,6 +11,7 @@ class ChecksIfBookingMarkingExists
/** @var Booking */
private $repository;
/**
* ChecksIfBookingMarkingExists constructor.
* @param Booking $repository
@@ -12,9 +12,10 @@ class CanCreateBooking extends AbstractRule
/** @var BookingValidation */
private $bookingValidation;
/**
* CanCreateBooking constructor.
* @param BookingValidation $BookingValidation
* @param BookingValidation $bookingValidation
*/
public function __construct(BookingValidation $bookingValidation)
{
@@ -13,9 +13,10 @@ class CanUpdateBooking extends AbstractRule
/** @var BookingValidation */
private $bookingValidation;
/**
* CanCreateAddress constructor.
* @param BookingValidation $BookingValidation
* CanUpdateBooking constructor.
* @param BookingValidation $bookingValidation
*/
public function __construct(BookingValidation $bookingValidation)
{
@@ -13,8 +13,9 @@ class FetchesCompany extends AbstractFetchRecord
/** @var Company */
private $repository;
/**
* FetchesUser constructor.
* FetchesCompany constructor.
* @param Company $repository
*/
public function __construct(Company $repository)
@@ -11,8 +11,9 @@ class CanCreateCompany extends AbstractRule
/** @var CompanyValidation */
private $companyValidation;
/**
* CanCreateUser constructor.
* CanCreateCompany constructor.
* @param CompanyValidation $companyValidation
*/
public function __construct(CompanyValidation $companyValidation)
@@ -11,8 +11,9 @@ class CanUpdateCompany extends AbstractRule
/** @var CompanyValidation */
private $companyValidation;
/**
* CanCreateUser constructor.
* CanUpdateCompany constructor.
* @param CompanyValidation $companyValidation
*/
public function __construct(CompanyValidation $companyValidation)
@@ -32,8 +32,9 @@ class CreateCompanyBankLogic extends AbstractControllerLogic
/** @var CreatesCompanyBank */
private $createsCompanyBank;
/**
* CreateSegmentLogic constructor.
* CreateCompanyBankLogic constructor.
* @param CanCreateCompanyBank $canCreateCompanyBank
* @param CreatesCompanyBank $createsCompanyBank
*/
@@ -39,10 +39,11 @@ class DeleteCompanyBankLogic extends AbstractControllerLogic
/** @var FetchesCompanyBank */
private $fetchesCompanyBank;
/**
* UpdateStandardSegmentConstantLogic constructor.
* @param CanUpdateSegment $canDeleteCompanyBank
* @param UpdatesSegment $deletesSegment
* DeleteCompanyBankLogic constructor.
* @param CanDeleteCompanyBank $canDeleteCompanyBank
* @param DeletesCompanyBank $deletesCompanyBank
* @param FetchesCompanyBank $fetchesCompanyBank
*/
public function __construct(
@@ -39,8 +39,9 @@ class UpdateCompanyBankLogic extends AbstractControllerLogic
/** @var FetchesCompanyBank */
private $fetchesCompanyBank;
/**
* UpdateStandardSegmentConstantLogic constructor.
* UpdateCompanyBankLogic constructor.
* @param CanUpdateCompanyBank $canUpdateCompanyBank
* @param UpdatesCompanyBank $updatesCompanyBank
* @param FetchesCompanyBank $fetchesCompanyBank
@@ -13,8 +13,9 @@ class FetchesCompanyBank extends AbstractFetchRecord
/** @var CompanyBank */
private $repository;
/**
* FetchesUser constructor.
* FetchesCompanyBank constructor.
* @param CompanyBank $repository
*/
public function __construct(CompanyBank $repository)
@@ -13,9 +13,10 @@ class CanUpdateCompanyBank extends AbstractRule
/** @var CompanyBankValidation */
private $CompanyBankValidation;
/**
* CanCreateAddress constructor.
* @param CompanyBankValidation $CompanyBankValidation
* CanUpdateCompanyBank constructor.
* @param CompanybankValidation $CompanyBankValidation
*/
public function __construct(CompanyBankValidation $CompanyBankValidation)
{
@@ -12,8 +12,9 @@ class CompanyEmployeeObject implements DataTransferObject
/** @var int|null */
private $user_id;
/**
* CompanyObject constructor.
* CompanyEmployeeObject constructor.
* @param int|null $company_id
* @param int|null $user_id
*/
@@ -13,8 +13,9 @@ class CanCreateCompanyEmployee extends AbstractRule
/** @var CompanyEmployeeValidation */
private $companyEmployeeValidation;
/**
* CanCreateAddress constructor.
* CanCreateCompanyEmployee constructor.
* @param CompanyEmployeeValidation $companyEmployeeValidation
*/
public function __construct(CompanyEmployeeValidation $companyEmployeeValidation)
@@ -24,14 +24,15 @@ class ContactObject implements DataTransferObject
/** @var string|null */
private $wechat_id;
/**
* CompanyObject constructor.
* ContactObject constructor.
* @param int|null $country_id
* @param int|null $company_id
* @param string|null $reference
* @param string|null $phone
* @param string|null $email
* @param string|null $wechat_id
* @param null|string $reference
* @param null|string $phone
* @param null|string $email
* @param null|string $wechat_id
*/
public function __construct(
?int $country_id,
@@ -13,8 +13,9 @@ class CanCreateContact extends AbstractRule
/** @var ContactValidation */
private $contactValidation;
/**
* CanCreateAddress constructor.
* CanCreateContact constructor.
* @param ContactValidation $contactValidation
*/
public function __construct(ContactValidation $contactValidation)
@@ -39,10 +39,11 @@ class DeleteCurrencyLogic extends AbstractControllerLogic
/** @var FetchesCurrency */
private $fetchesCurrency;
/**
* UpdateStandardSegmentConstantLogic constructor.
* @param CanUpdateSegment $canDeleteCurrency
* @param UpdatesSegment $deletesSegment
* DeleteCurrencyLogic constructor.
* @param CanDeleteCurrency $canDeleteCurrency
* @param DeletesCurrency $deletesCurrency
* @param FetchesCurrency $fetchesCurrency
*/
public function __construct(
@@ -47,6 +47,7 @@ class UpdateCurrencyRateLogic extends AbstractControllerLogic
* UpdateStandardSegmentConstantLogic constructor.
* @param CanUpdateCurrency $canUpdateCurrency
* @param UpdatesCurrencyRate $updatesCurrencyRate
* @param CreatesCurrencyLog $createsCurrencyLog
* @param FetchesCurrency $fetchesCurrency
*/
public function __construct(
@@ -13,12 +13,13 @@ class CurrencyObject implements DataTransferObject
private $symbol;
private $selling;
/**
* CompanyBankObject constructor.
* CurrencyObject constructor.
* @param int|null $country_id
* @param string|null $name
* @param string|null $short_code
* @param string|null $symbol
* @param null|string $name
* @param null|string $short_code
* @param null|string $symbol
* @param float|null $selling
*/
public function __construct(
@@ -13,8 +13,9 @@ class FetchesCurrency extends AbstractFetchRecord
/** @var Currency */
private $repository;
/**
* FetchesUser constructor.
* FetchesCurrency constructor.
* @param Currency $repository
*/
public function __construct(Currency $repository)
@@ -13,9 +13,10 @@ class CanUpdateCurrency extends AbstractRule
/** @var currencyValidation */
private $currencyValidation;
/**
* CanCreateAddress constructor.
* @param CurrencyValidation $CurrencyValidation
* CanUpdateCurrency constructor.
* @param CurrencyValidation $currencyValidation
*/
public function __construct(CurrencyValidation $currencyValidation)
{
@@ -41,8 +41,9 @@ class ApproveDocumentLogic extends AbstractControllerLogic
/** @var FetchesDocument */
private $fetchesDocument;
/**
* UpdateStandardSegmentConstantLogic constructor.
* ApproveDocumentLogic constructor.
* @param CanUpdateDocument $canUpdateDocument
* @param ApprovesDocument $approvesDocument
* @param FetchesDocument $fetchesDocument
@@ -30,8 +30,9 @@ class ListDocumentLogic extends AbstractControllerLogic
/** @var ListsDocuments */
private $listsDocuments;
/**
* ListStandardSegmentLogic constructor.
* ListDocumentLogic constructor.
* @param CanListDocuments $canListDocuments
* @param ListsDocuments $listsDocuments
*/
@@ -35,12 +35,15 @@ class DocumentObject implements DataTransferObject
/**
* CompanyObject constructor.
* @param int|null $country_id
* @param int|null $company_id
* @param int|null $owner_id
* @param int|null $owner_type
* @param null|string $document_type
* @param string|null $reference
* @param string|null $phone
* @param string|null $email
* @param string|null $wechat_id
* @param int|null $status
* @param int|null $approved_by
* @param timestamp|null $issued_date
* @param timestamp|null $expired_date
* @param timestamp|null $approved_date
*/
public function __construct(
?int $owner_id,
@@ -18,7 +18,7 @@ class FileObject implements DataTransferObject
/**
* CompanyObject constructor.
* @param int|null $document_id
* @param text|null $file
* @param null|string $file
* @param string|null $file_type
*/
public function __construct(
@@ -9,6 +9,7 @@ class Convert64ToFile
{
/**
* @param array|null file_set
* @return array|bool
*/
public function convert($file_set = [], $path = 'file')
{
@@ -13,8 +13,9 @@ class FetchesDocument extends AbstractFetchRecord
/** @var Document */
private $repository;
/**
* FetchesUser constructor.
* FetchesDocument constructor.
* @param Document $repository
*/
public function __construct(Document $repository)
@@ -13,8 +13,9 @@ class CanCreateDocument extends AbstractRule
/** @var DocumentValidation */
private $documentValidation;
/**
* CanCreateAddress constructor.
* CanCreateDocument constructor.
* @param DocumentValidation $documentValidation
*/
public function __construct(DocumentValidation $documentValidation)
@@ -13,8 +13,9 @@ class CanUpdateDocument extends AbstractRule
/** @var DocumentValidation */
private $documentValidation;
/**
* CanCreateAddress constructor.
* CanUpdateDocument constructor.
* @param DocumentValidation $documentValidation
*/
public function __construct(DocumentValidation $documentValidation)
@@ -12,8 +12,9 @@ class SegmentCompanyObject implements DataTransferObject
/** @var int|null */
private $company_id;
/**
* CompanyObject constructor.
* SegmentCompanyObject constructor.
* @param int|null $segment_id
* @param int|null $company_id
*/
@@ -13,8 +13,9 @@ class CanCreateSegmentCompany extends AbstractRule
/** @var SegmentCompanyValidation */
private $segmentCompanyValidation;
/**
* CanCreateAddress constructor.
* CanCreateSegmentCompany constructor.
* @param SegmentCompanyValidation $segmentCompanyValidation
*/
public function __construct(SegmentCompanyValidation $segmentCompanyValidation)
@@ -43,10 +43,11 @@ class CreateSegmentConstantLogic extends AbstractControllerLogic
/** @var FetchesSegment */
private $fetchesSegment;
/**
* CreateSegmentConstantLogic constructor.
* @param CanCreateSegmentConstant $canCreateSegmentConstant
* @param createsSegmentConstant $createsSegmentConstantTax
* @param CreatesSegmentConstant $createsSegmentConstant
* @param FetchesSegmentConstant $fetchesSegmentConstant
* @param FetchesSegment $fetchesSegment
*/
@@ -23,7 +23,7 @@ class SegmentConstantObject implements DataTransferObject
/**
* SegmentConstantObject constructor.
* @param string|null $segment_id
* @param int|null $segment_id
* @param string|null $name
* @param string|null $reference
* @param string|null $type
@@ -14,7 +14,7 @@ class CanUpdateSegmentConstant extends AbstractRule
private $segmentConstantValidation;
/**
* CanCreateAddress constructor.
* CanUpdateSegmentConstant constructor.
* @param SegmentConstantValidation $segmentConstantValidation
*/
public function __construct(SegmentConstantValidation $segmentConstantValidation)
@@ -13,8 +13,9 @@ class CanUpdateStandardSegmentConstant extends AbstractRule
/** @var SegmentConstantValidation */
private $segmentConstantValidation;
/**
* CanCreateAddress constructor.
* CanUpdateStandardSegmentConstant constructor.
* @param SegmentConstantValidation $segmentConstantValidation
*/
public function __construct(SegmentConstantValidation $segmentConstantValidation)
@@ -10,7 +10,6 @@ use App\Classes\Modules\Segments\Services\FetchesSegment;
use App\Classes\Modules\Segments\Standards\Rules\CanDeleteSegment;
use App\Classes\Modules\Segments\Services\DeletesSegment;
use App\Classes\Modules\Segments\DataTransferObjects\SegmentObject;
use ErrorException;
use Illuminate\Http\JsonResponse;
@@ -39,10 +38,11 @@ class DeleteSegmentLogic extends AbstractControllerLogic
/** @var FetchesSegment */
private $fetchesSegment;
/**
* UpdateStandardSegmentConstantLogic constructor.
* @param CanUpdateSegment $canDeleteSegment
* @param UpdatesSegment $deletesSegment
* DeleteSegmentLogic constructor.
* @param CanDeleteSegment $canDeleteSegment
* @param DeletesSegment $deletesSegment
* @param FetchesSegment $fetchesSegment
*/
public function __construct(
@@ -39,8 +39,9 @@ class UpdateSegmentLogic extends AbstractControllerLogic
/** @var FetchesSegment */
private $fetchesSegment;
/**
* UpdateStandardSegmentConstantLogic constructor.
* UpdateSegmentLogic constructor.
* @param CanUpdateSegment $canUpdateSegment
* @param UpdatesSegment $updatesSegment
* @param FetchesSegment $fetchesSegment
@@ -13,8 +13,9 @@ class FetchesSegment extends AbstractFetchRecord
/** @var Segment */
private $repository;
/**
* FetchesUser constructor.
* FetchesSegment constructor.
* @param Segment $repository
*/
public function __construct(Segment $repository)
@@ -13,8 +13,9 @@ class CanUpdateSegment extends AbstractRule
/** @var SegmentValidation */
private $segmentValidation;
/**
* CanCreateAddress constructor.
* CanUpdateSegment constructor.
* @param SegmentValidation $segmentValidation
*/
public function __construct(SegmentValidation $segmentValidation)
@@ -56,11 +56,17 @@ class CreateTransactionLogic extends AbstractControllerLogic
private $canCreateTransactionDetail;
private $createsTransactionDetail;
/**
* CreateWalletLogic constructor.
* @param CreatesWallet $createsWallet
* @param GeneratesWalletCode $generatesWalletCode
* @param CanCreateCompanyWallet $canCreateCompanyWallet
* @param GeneratesTransactionBillNo $generatesTransactionBillNo
* @param CanCreateTransaction $canCreateTransaction
* @param FetchesCurrency $fetchesCurrency
* @param RateCalculatesCurrency $rateCalculatesCurrency
* @param FetchesCompany $fetchesCompany
* @param CreatesTransaction $createsTransaction
* @param CanCreateTransactionDetail $canCreateTransactionDetail
* @param CreatesTransactionDetail $createsTransactionDetail
*/
public function __construct(
GeneratesTransactionBillNo $generatesTransactionBillNo, CanCreateTransaction $canCreateTransaction,
@@ -71,9 +71,12 @@ class CreateWalletTransactionLogic extends AbstractControllerLogic
/**
* CreateWalletLogic constructor.
* @param CreatesWallet $createsWallet
* @param GeneratesWalletCode $generatesWalletCode
* @param CanCreateCompanyWallet $canCreateCompanyWallet
* @param CreatesWalletTransaction $createsWalletTransaction
* @param GeneratesWalletTransactionBillNo $generatesWalletTransactionBillNo
* @param CanCreateWalletTransaction $canCreateWalletTransaction
* @param FetchesCurrency $fetchesCurrency
* @param RateCalculatesCurrency $rateCalculatesCurrency
* @param FetchesWallet $fetchesWallet
*/
public function __construct(
CreatesWalletTransaction $createsWalletTransaction, GeneratesWalletTransactionBillNo $generatesWalletTransactionBillNo, CanCreateWalletTransaction $canCreateWalletTransaction,
@@ -11,9 +11,10 @@ class ChecksIfWalletCodeExists
/** @var wallet */
private $repository;
/**
* ChecksIfAccountNumberExists constructor.
* @param wallet $repository
* ChecksIfWalletCodeExists constructor.
* @param Wallet $repository
*/
public function __construct(wallet $repository)
{
@@ -13,9 +13,10 @@ class FetchesWallet extends AbstractFetchRecord
/** @var Currency */
private $repository;
/**
* FetchesUser constructor.
* @param Currency $repository
* FetchesWallet constructor.
* @param Wallet $repository
*/
public function __construct(Wallet $repository)
{
@@ -21,13 +21,12 @@ class ApiResponseObject
private $data;
/**
* ApiResponseObject constructor.
* @param string $title
* @param string $message
* @param int $statusCode
* @param array|null $data
* @param array $data
*/
public function __construct(string $title, string $message, int $statusCode, array $data = [])
{