Heratio Framework API Reference

VendorRepository
in package

Table of Contents

Methods

addAttachment()  : int
addContact()  : int
addTransactionItem()  : int
assignServiceToVendor()  : bool
createTransaction()  : int
createVendor()  : int
deleteAttachment()  : bool
deleteContact()  : bool
deleteVendor()  : bool
getActiveTransactions()  : Collection
getAllServiceTypes()  : Collection
getAllTransactions()  : Collection
getAllVendors()  : Collection
getConditionRatings()  : array<string|int, mixed>
getDashboardStats()  : array<string|int, mixed>
getItemTransactionHistory()  : Collection
getMonthlyTransactionCounts()  : Collection
getOverdueTransactions()  : Collection
getPaymentStatuses()  : array<string|int, mixed>
getServiceTypeById()  : object|null
getServiceTypeBySlug()  : object|null
getStatusOptions()  : array<string|int, mixed>
getTransactionAttachments()  : Collection
getTransactionById()  : object|null
getTransactionByNumber()  : object|null
getTransactionHistory()  : Collection
getTransactionItems()  : Collection
getTransactionsByStatus()  : Collection
getVendorById()  : object|null
getVendorBySlug()  : object|null
getVendorContacts()  : Collection
getVendorServices()  : Collection
getVendorsForService()  : Collection
getVendorStats()  : object
getVendorTypes()  : array<string|int, mixed>
removeServiceFromVendor()  : bool
removeTransactionItem()  : bool
updateContact()  : bool
updateTransaction()  : bool
updateTransactionItem()  : bool
updateTransactionStatus()  : bool
updateVendor()  : bool

Methods

addAttachment()

public addAttachment(int $transactionId, array<string|int, mixed> $data) : int
Parameters
$transactionId : int
$data : array<string|int, mixed>
Return values
int

addContact()

public addContact(int $vendorId, array<string|int, mixed> $data) : int
Parameters
$vendorId : int
$data : array<string|int, mixed>
Return values
int

addTransactionItem()

public addTransactionItem(int $transactionId, int $informationObjectId[, array<string|int, mixed> $data = [] ]) : int
Parameters
$transactionId : int
$informationObjectId : int
$data : array<string|int, mixed> = []
Return values
int

assignServiceToVendor()

public assignServiceToVendor(int $vendorId, int $serviceTypeId[, array<string|int, mixed> $data = [] ]) : bool
Parameters
$vendorId : int
$serviceTypeId : int
$data : array<string|int, mixed> = []
Return values
bool

createTransaction()

public createTransaction(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

createVendor()

public createVendor(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>
Return values
int

deleteAttachment()

public deleteAttachment(int $attachmentId) : bool
Parameters
$attachmentId : int
Return values
bool

deleteContact()

public deleteContact(int $contactId) : bool
Parameters
$contactId : int
Return values
bool

deleteVendor()

public deleteVendor(int $id) : bool
Parameters
$id : int
Return values
bool

getActiveTransactions()

public getActiveTransactions() : Collection
Return values
Collection

getAllServiceTypes()

public getAllServiceTypes([bool $activeOnly = true ]) : Collection
Parameters
$activeOnly : bool = true
Return values
Collection

getAllTransactions()

public getAllTransactions([array<string|int, mixed> $filters = [] ]) : Collection
Parameters
$filters : array<string|int, mixed> = []
Return values
Collection

getAllVendors()

public getAllVendors([array<string|int, mixed> $filters = [] ]) : Collection
Parameters
$filters : array<string|int, mixed> = []
Return values
Collection

getConditionRatings()

public getConditionRatings() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDashboardStats()

public getDashboardStats() : array<string|int, mixed>
Return values
array<string|int, mixed>

getItemTransactionHistory()

public getItemTransactionHistory(int $informationObjectId) : Collection
Parameters
$informationObjectId : int
Return values
Collection

getMonthlyTransactionCounts()

public getMonthlyTransactionCounts([int $months = 12 ]) : Collection
Parameters
$months : int = 12
Return values
Collection

getOverdueTransactions()

public getOverdueTransactions() : Collection
Return values
Collection

getPaymentStatuses()

public getPaymentStatuses() : array<string|int, mixed>
Return values
array<string|int, mixed>

getServiceTypeById()

public getServiceTypeById(int $id) : object|null
Parameters
$id : int
Return values
object|null

getServiceTypeBySlug()

public getServiceTypeBySlug(string $slug) : object|null
Parameters
$slug : string
Return values
object|null

getStatusOptions()

public getStatusOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTransactionAttachments()

public getTransactionAttachments(int $transactionId[, string|null $type = null ]) : Collection
Parameters
$transactionId : int
$type : string|null = null
Return values
Collection

getTransactionById()

public getTransactionById(int $id) : object|null
Parameters
$id : int
Return values
object|null

getTransactionByNumber()

public getTransactionByNumber(string $transactionNumber) : object|null
Parameters
$transactionNumber : string
Return values
object|null

getTransactionHistory()

public getTransactionHistory(int $transactionId) : Collection
Parameters
$transactionId : int
Return values
Collection

getTransactionItems()

public getTransactionItems(int $transactionId) : Collection
Parameters
$transactionId : int
Return values
Collection

getTransactionsByStatus()

public getTransactionsByStatus() : Collection
Return values
Collection

getVendorById()

public getVendorById(int $id) : object|null
Parameters
$id : int
Return values
object|null

getVendorBySlug()

public getVendorBySlug(string $slug) : object|null
Parameters
$slug : string
Return values
object|null

getVendorContacts()

public getVendorContacts(int $vendorId) : Collection
Parameters
$vendorId : int
Return values
Collection

getVendorServices()

public getVendorServices(int $vendorId) : Collection
Parameters
$vendorId : int
Return values
Collection

getVendorsForService()

public getVendorsForService(int $serviceTypeId) : Collection
Parameters
$serviceTypeId : int
Return values
Collection

getVendorStats()

public getVendorStats(int $vendorId) : object
Parameters
$vendorId : int
Return values
object

getVendorTypes()

public getVendorTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

removeServiceFromVendor()

public removeServiceFromVendor(int $vendorId, int $serviceTypeId) : bool
Parameters
$vendorId : int
$serviceTypeId : int
Return values
bool

removeTransactionItem()

public removeTransactionItem(int $itemId) : bool
Parameters
$itemId : int
Return values
bool

updateContact()

public updateContact(int $contactId, array<string|int, mixed> $data) : bool
Parameters
$contactId : int
$data : array<string|int, mixed>
Return values
bool

updateTransaction()

public updateTransaction(int $id, array<string|int, mixed> $data, int $userId[, string|null $notes = null ]) : bool
Parameters
$id : int
$data : array<string|int, mixed>
$userId : int
$notes : string|null = null
Return values
bool

updateTransactionItem()

public updateTransactionItem(int $itemId, array<string|int, mixed> $data) : bool
Parameters
$itemId : int
$data : array<string|int, mixed>
Return values
bool

updateTransactionStatus()

public updateTransactionStatus(int $id, string $status, int $userId[, string|null $notes = null ]) : bool
Parameters
$id : int
$status : string
$userId : int
$notes : string|null = null
Return values
bool

updateVendor()

public updateVendor(int $id, array<string|int, mixed> $data) : bool
Parameters
$id : int
$data : array<string|int, mixed>
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results