This class is important to access the data from the event array given from the API-Function GetEventList and GetEvent.

 Methods

Time Conversion the calendar stringtime YYYY-MM-DD HH:MM:SS is convted to UNIX time value

CalTimeToTime(string $cal_time) : int

Parameters

$cal_time

string

time

Returns

intUNIX time

Gives back the Category of the event

Category() : string

Returns

stringe.g. 'party', 'concert', 'retreat'...

Gives back the Category-group of the event

Catgroup() : string

Returns

stringone of each 'event', 'workshop', 'lesson'

Gives back the Clientstate if it exists in the event-array

ClientState() : int

Returns

intclientstate 0 = the event does not belong to a client 1 or higher = the location or the organizer is registered as a client

Compares the Event-Start with a UNIX Timestamp

CompareStart(int $time, string $precision) : bool

Parameters

$time

int

time

$precision

string

if precision is day, the hour, minute and second values are ignored

Returns

boolreturns true on equal

Check wether the event is for free

CostFree() : bool

Returns

bool

Gives back the AK (Abendkasse) value if it exists in the event

CostPerAK() : string

Returns

string

Give back the cost per unit value if it exists

CostPerUnit() : string

Returns

stringthe cost per unit

Gives back the VVK (Vorverkauf) value if it exists in the event

CostPerVVK() : string

Returns

string

the cost may be specified in a two column table

CostTable() : mixed

Returns

mixedan array for the costtabele if it exists or null

Give back the text of the cost

CostText() : string

Returns

string

Get a formatted string of the events creation date

Created(string $format) : string

Parameters

$format

string

format: see PHP date function

Returns

stringthe formatted creation date

The Name of the user who created the Event

CreatedBy() : string

Returns

stringusername

Get the description of event-struct.

Description(int $lines, int $columns, string $eol) : string

If the values for lines and columns are specified the method will use the ResiseTest Method to resize the text

Parameters

$lines

int

columns for resizing

$columns

int

lines for resizing*

$eol

string

the linebreakes usually will be replaced with a br tag

Returns

stringthe description or an empty string resized by the params

Get an FastBroadcastPerson object of the Dj

Dj(int $index) : mixed

Parameters

$index

int

index of the dj, The default is zero.

Returns

mixedgives back an object of the class FastBroadcastPerson when the Location exists; otherwise null

download are specified in an array with two columns, the text and the file specification

Download() : mixed

Returns

mixedarray, if there is something to download otherwise null

The URL of Files to Download

DownloadURL(int $index) : string

Parameters

$index

int

the index of the file in the event array

Returns

stringthe path, if an valid download-row is indexed, otherwise an empty string is returned

Get a formatted string of the events end date

End(string $format) : string

Parameters

$format

string

format: see PHP date function

Returns

stringthe formatted end date

The current state of the hitcounter

Hits() : int

Returns

inthits

Get the eventid of event-struct.

Id() : string

Returns

stringthe eventid

If the indexed Image exists this function will return the name of the image

ImageName(int $index) : bool

Parameters

$index

int

index

Returns

bool

a complete HTML img-tag is created and returned by this method the params are equal to the method ImageURL

ImageTag(int $index, int $width, int $height) : string

Parameters

$index

int

index

$width

int

width

$height

int

height

Returns

stringthe html img-tag

The URL of an image identified by index

ImageURL(int $index, int $width, int $height) : string

Parameters

$index

int

index

$width

int

width oft the image

$height

int

height of the image

Returns

stringthe url of the image if the index is valid otherwise an empty string

Is there a category in the event-array?

IsCategory() : bool

Returns

bool

Is there a category-group in the event-array?

IsCatgroup() : bool

Returns

bool

Is the clientstate part of the event-array?

IsClientState() : bool

Returns

bool

Check for existens of a valid cost row in event-array.

IsCost() : bool

Returns

bool

Is there a AK entry in the event? (AK means Abendkasse)

IsCostAK() : bool

Returns

bool

Check wether the event is for free

IsCostFree() : bool

Returns

bool

Is there a cost per unit entry in the event?

IsCostPerUnit() : bool

Returns

bool

Is the table used for the specification of the event price

IsCostTable() : bool

Returns

bool

Checks wether the textfield for the price for mor complex prices is used

IsCostText() : bool

Returns

bool

Is there a VVK entry in the event? (VVK means Vorverkauf)

IsCostVVK() : bool

Returns

bool

Check for existens of a event-Description

IsDescription() : bool

Returns

bool

Is the requested dj valid?

IsDj(int $index) : bool

Parameters

$index

int

index of the dj

Returns

bool

does the event have something to download (php-file for example)

IsDownload() : bool

Returns

bool

Is there an end-value in the event-array?

IsEnd() : bool

Returns

bool

if a flyer exist in the imagetable this function will return true

IsFlyer(int $index) : bool

Parameters

$index

int

index

Returns

bool

Is the hitcounter part of the event-array?

IsHits() : bool

Returns

bool

Checks the existance of an image at pos $index

IsImage(int $index) : bool

Parameters

$index

int

index

Returns

bool

Is the requested location number valid?

IsLocation(int $index) : bool

Parameters

$index

int

index of the location

Returns

bool

Is the requested organizer valid?

IsOrganizer(int $index) : bool

Parameters

$index

int

index of the organizer

Returns

bool

A program may be specified as a table width two columns represented as an array by the user for an event.

IsProgram() : bool

Returns

bool

Is there a scene in the event-array?

IsScene() : bool

Returns

bool

Check for existens of a slogan-string in event-array.

IsSlogan() : bool

Returns

bool

Is there a start-value in the event-array?

IsStart() : bool

Returns

bool

Checks wether the Event-start matches the current day

IsToday() : bool

Returns

bool

Checks wether there is an event assigned

IsValid() : bool

Returns

bool

Get an FastBroadcastPerson object of the Location

Location(int $index) : mixed

Parameters

$index

int

index of the location. The default is zero.

Returns

mixedgives back an object of the class FastBroadcastPerson when the Location exists; otherwise null

Get a formatted string of the events last modified date

Modified(string $format) : string

Parameters

$format

string

format: see PHP date function

Returns

stringthe formatted modified date

The Name of the user who last modified the Event

ModifiedBy() : string

Returns

stringusername

Get the eventnr of event-struct.

Nr() : string

Returns

stringthe eventnr

Get an FastBroadcastPerson object of the Organizer

Organizer(int $index) : mixed

Parameters

$index

int

index of the organizer, The default is zero.

Returns

mixedgives back an object of the class FastBroadcastPerson when the Location exists; otherwise null

A program may be specified as a table width two columns represented as an array by the user for an event.

Program() : mixed

Returns

mixedarray if there is a program otherwise null

this method can be used to resize the amount of text of the event description

ResizeText(string $text_in, int $max_lines, int $max_chars_per_line, string $eol, string $ellipse) 

Parameters

$text_in

string

the text to resize

$max_lines

int

max lines oft the resized text

$max_chars_per_line

int

max char per line ( requred to braek paragraphs to lines)

$eol

string

for html output the eol should be set to a br tag

$ellipse

string

if the result is smaller when the input, an ellipse or an other string is added to the end of the text

Gives back the Scene of the event

Scene() : string

Returns

stringe.g. 'salsa', 'tango', 'mediation'...

Init function for this object.

SetEvent(array $event) 

It is recommended that each application shoud use objetc of class FastBroadcastCalendarEvent to access the values of an event returned by the the FastBroadcast API

Parameters

$event

array

event

Get the slogan of event-struct.

Slogan() : string

Returns

stringthe slogan or an empty string

Get a formatted string of the events start date

Start(string $format) : string

Parameters

$format

string

format: see PHP date function

Returns

stringthe formatted start date

Get the summary of event-struct.

Summary() : string

Returns

stringthe Title of the Event

complex formattings can be done with this method.

sprintf(string $format) : \the

Variables must be enclosed with brackets {variable}. sample: "{location_city}: {start_H}:{start_i} {location_fullname}" for the resolution of time-variables see the date funktion in php.net

Parameters

$format

string

format

Returns

\theformatstring where the valid params are resolved

This Method will return an Object of NosFastBroadcastPerson

Person() : mixed

Returns

mixedif there is an Object the method returns an object of the class NosFastBroadcastPerson. otherwise it returns null

 Properties

 

The start time in UNIX time format

$end 

 

The start time in UNIX time format

$start 

 

some params.

$_event 

.

 

person

$_person