Documentation

Tourenplan
in package

All methods for the module tourenplan

Table of Contents

Methods

dateConvert()  : mixed
convert a date from format dd.mm.yyyy to yyyy-mm-dd and reverse
delVisitDay()  : mixed
real deletion of entry in table tp_visitDays and linked entries in table tp_visitDayServices
delVisitDienst()  : mixed
real deletion of entry in table tp_visit and linked entries in tables tp_visitDays and tp_visitDayServices
getDaysVisit()  : mixed
get all planned days for selected visits
getDienstByVisit()  : mixed
getKatalogEintrag()  : mixed
get all entries from table katalog_eintrag
getMaBereich()  : mixed
get all ma_id (owner) with entry vg_id = $idBereich
getMaxDateBisVisits()  : mysqli
get MAX of each idClient and colum dateBis in table tp_visit
getPeriodicSingelEvents()  : mixed
get all events in given time-range by type, client and/or tour
getServicesEvent()  : mixed
get all planned visits for selected client
getServicesVisit()  : mixed
get all planned visits for selected client
getTimeByTerminService()  : mixed
get single visits between to dates
getUnscheduledVisits()  : mixed
get all unscheduled single or periodic visits
getVisitById()  : mysqli
get all planned days for selected visits
getVisitClient()  : mixed
<p>get all planned WEEKLY and SINGLE planned visits for selected client</p>
getVisitsByDate()  : mixed
get ALL planned visits for selected day
getVisitVerordnungDienst()  : mixed
<p>get all planned WEEKLY and SINGLE planned visits for selected client</p>
saveDay()  : mixed
save days for planned visit
saveFreetext()  : mixed
save freetext and duration for planned visit
saveServices()  : mixed
save services from verordnung for planned visit
saveSingleEvent()  : mixed
save a single event
saveVisit()  : mixed
save visit who are weekly planned
saveVisitSingle()  : mixed
timeConvert()  : mixed
convert a date from format dd.mm.yyyy to yyyy-mm-dd and reverse
updateDay()  : mixed
update entry day for planned visit
updateVisit()  : mixed
update entry day for planned visit
validateEvents()  : mixed
validation of overlapping events in resource

Methods

dateConvert()

convert a date from format dd.mm.yyyy to yyyy-mm-dd and reverse

public dateConvert(date $date[, int $shortView = 0 ]) : mixed

returns the converted date

Parameters
$date : date

format dd.mm.yyyy or yyyy-mm-dd

$shortView : int = 0

if value = 1: convert date dd.mm.yyyy into dd.mm.yy

delVisitDay()

real deletion of entry in table tp_visitDays and linked entries in table tp_visitDayServices

public delVisitDay(int $idVisitDay) : mixed
Parameters
$idVisitDay : int

id table tp_visitDays

delVisitDienst()

real deletion of entry in table tp_visit and linked entries in tables tp_visitDays and tp_visitDayServices

public delVisitDienst(int $idVisit) : mixed
Parameters
$idVisit : int

id of entry in table tp_visit

getDaysVisit()

get all planned days for selected visits

public getDaysVisit(int $idVisit) : mixed
Parameters
$idVisit : int

select days by id in table tp_visit

getDienstByVisit()

public getDienstByVisit(mixed $selVisit) : mixed
Parameters
$selVisit : mixed

getKatalogEintrag()

get all entries from table katalog_eintrag

public getKatalogEintrag() : mixed

getMaBereich()

get all ma_id (owner) with entry vg_id = $idBereich

public getMaBereich(int $idBereich) : mixed
Parameters
$idBereich : int

getMaxDateBisVisits()

get MAX of each idClient and colum dateBis in table tp_visit

public getMaxDateBisVisits(date $start) : mysqli
Parameters
$start : date

start-date for search, format YYYY-MM-DD

Return values
mysqli —

result with idClient and MAX(dateBis)

getPeriodicSingelEvents()

get all events in given time-range by type, client and/or tour

public getPeriodicSingelEvents(datetime $start, datetime $end, int $type[, int $idClient = 0 ][, int $idTour = 0 ]) : mixed
Parameters
$start : datetime

start of search-range, format yyyy-mm-ddThh:mm:ss

$end : datetime

end of search-range, format yyyy-mm-ddThh:mm:ss

$type : int

1 = periodic events, 2 = single events

$idClient : int = 0

ref to table klient, get all events for client

$idTour : int = 0

id of selected tour, get all events for tour

getServicesEvent()

get all planned visits for selected client

public getServicesEvent([int $idVisit = 0 ][, int $idVisitDay = 0 ][, mixed $asArray = null ]) : mixed
Parameters
$idVisit : int = 0

ref to id of table tp_visit if singel termin

$idVisitDay : int = 0

ref to id of table tp_visitDays

$asArray : mixed = null

getServicesVisit()

get all planned visits for selected client

public getServicesVisit([int $idVisit = 0 ][, int $idVisitDay = 0 ]) : mixed
Parameters
$idVisit : int = 0

ref to id of table tp_visit if singel termin

$idVisitDay : int = 0

ref to id of table tp_visitDays

getTimeByTerminService()

get single visits between to dates

public getTimeByTerminService(date $start, date $end, int $selDienst[, int $clients = 0 ][, int $type = 0 ]) : mixed
Parameters
$start : date

start-date for search, format dd.mm.yyyy

$end : date

end-date for search, format dd.mm.yyyy

$selDienst : int

id of selected dienst

$clients : int = 0

if value = 1, get additional client name and id

$type : int = 0

value = 0: get all, value = 1: get all unscheduled

getUnscheduledVisits()

get all unscheduled single or periodic visits

public getUnscheduledVisits(int $type[, int $selDienst = 0 ][, int $clients = 0 ]) : mixed
Parameters
$type : int

0 = singel visit, 1 = periodic visits

$selDienst : int = 0

id of selected dienst

$clients : int = 0

if value = 1, get additional client name, adress and id

getVisitById()

get all planned days for selected visits

public getVisitById(int $idVisit) : mysqli
Parameters
$idVisit : int

select days by id in table tp_visit

Return values
mysqli —

result set as assoc array

getVisitClient()

<p>get all planned WEEKLY and SINGLE planned visits for selected client</p>

public getVisitClient(int $idClient, date $dateFrom[, int $idVerordnung = 0 ]) : mixed
Parameters
$idClient : int

id of klient in table klient

$dateFrom : date

check-date for visits, format dd.mm.yyyy

$idVerordnung : int = 0

default 0, id of selected verordnung, ref to table verordung

getVisitsByDate()

get ALL planned visits for selected day

public getVisitsByDate(date $date, int $selDienst[, int $clients = 0 ][, int $type = 0 ]) : mixed
Parameters
$date : date

dateFrom set in planning-form, format dd.mm.yyyy

$selDienst : int

id of selected dienst

$clients : int = 0

if value = 1, get additional client name and id

$type : int = 0

value = 0: get all, value = 1: get all unscheduled

getVisitVerordnungDienst()

<p>get all planned WEEKLY and SINGLE planned visits for selected client</p>

public getVisitVerordnungDienst(int $idVerordnung, int $idDienst) : mixed
Parameters
$idVerordnung : int

default 0, id of selected verordnung, ref to table verordung

$idDienst : int

id of selected dienst, ref to id of table dp_vorgaben

saveDay()

save days for planned visit

public saveDay(int $idVisit, int $weekday, int $dauer) : mixed
Parameters
$idVisit : int

ref to id of table tp_visitDays

$weekday : int

value between 0 .. 6 - mo .. so

$dauer : int

planned duration of visit

saveFreetext()

save freetext and duration for planned visit

public saveFreetext(int $idVisit, int $idVisitDay, text $freetext, int $dauer) : mixed
Parameters
$idVisit : int

ref to id of table tp_visit if singel termin

$idVisitDay : int

ref to id of table tp_visitDays if weekly planning

$freetext : text
$dauer : int

duration of service defined in verordnung

saveServices()

save services from verordnung for planned visit

public saveServices(int $idLeistung, int $dauer, varchar $tarif[, int $idVisit = 0 ][, int $idVisitDay = 0 ]) : mixed
Parameters
$idLeistung : int

ref to id of table v_leistungen

$dauer : int

duration of service defined in verordnung

$tarif : varchar

name of tariff

$idVisit : int = 0

ref to id of table tp_visit if singel termin

$idVisitDay : int = 0

ref to id of table tp_visitDays

saveSingleEvent()

save a single event

public saveSingleEvent(text $name, datetime $start, datetime $end, int $resource_id, int $visit_id, int $idClient, int $typ) : mixed
Parameters
$name : text
$start : datetime

format yyyy-mm-ddThh:mm:ss

$end : datetime

format yyyy-mm-ddThh:mm:ss

$resource_id : int
$visit_id : int
$idClient : int
$typ : int

saveVisit()

save visit who are weekly planned

public saveVisit(int $idClient, int $idDienst, date $dateVon[, date $dateBis = null ][, int $idVerordnung = 0 ][, time $wishFrom = null ][, time $wishTo = null ][, int $wishMa = 0 ][, mixed $prioWish = 0 ]) : mixed
Parameters
$idClient : int

id of klient, ref to table klient

$idDienst : int

id of selected dienst, ref to id of table dp_vorgaben

$dateVon : date

startdate of visit, format dd.mm.yyyy

$dateBis : date = null

enddate of visit, format dd.mm.yyyy

$idVerordnung : int = 0

id of selected verordnung, ref to table verordung

$wishFrom : time = null

wish starttim of visit, format HH:ii

$wishTo : time = null

wish endtime of visit, format HH:ii

$wishMa : int = 0

id of wish nurse, ref to table owner

$prioWish : mixed = 0

saveVisitSingle()

public saveVisitSingle(mixed $idClient, mixed $idDienst, mixed $termin, mixed $idVerordnung[, mixed $wishFrom = null ][, mixed $wishTo = null ][, mixed $prioWish = 0 ]) : mixed
Parameters
$idClient : mixed
$idDienst : mixed
$termin : mixed
$idVerordnung : mixed
$wishFrom : mixed = null
$wishTo : mixed = null
$prioWish : mixed = 0

timeConvert()

convert a date from format dd.mm.yyyy to yyyy-mm-dd and reverse

public timeConvert(date $time) : mixed

returns the converted date

Parameters
$time : date

format h:i:s

Tags
@return

string format h:i

updateDay()

update entry day for planned visit

public updateDay(int $idDay, int $dauer) : mixed
Parameters
$idDay : int

id of table tp_visitDays

$dauer : int

new duration for the day

updateVisit()

update entry day for planned visit

public updateVisit(int $idVisit, int $dateVon[, int $dateBis = null ][, time $wishFrom = null ][, time $wishTo = null ][, int $wishMa = null ][, int $prioWish = null ]) : mixed
Parameters
$idVisit : int

id of table tp_visit

$dateVon : int

startdate of visit, format dd.mm.yyyy

$dateBis : int = null

enddate of visit, format dd.mm.yyyy or null

$wishFrom : time = null

wish starttime visit, format HH:ii

$wishTo : time = null

wish endtime visit, format HH:ii

$wishMa : int = null

id of wish nurse, ref to table owner

$prioWish : int = null

0 - 2, priority of wishTime

validateEvents()

validation of overlapping events in resource

public validateEvents(date $start, int $tour) : mixed
Parameters
$start : date

startdate for validation

$tour : int

id of selected tour/dienst, ref to id of table dp_vorgaben


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results