tp TouchPointWP Interfaces involvementMeetingCommon

tp\TouchPointWP\Interfaces\involvementMeetingCommon

This class contains the elements common between the Involvement and Meeting classes.

• Interface name: involvementMeetingCommon
• Namespace: \tp\TouchPointWP\Interfaces
• This is an interface
• This interface extends: tp\TouchPointWP\Interfaces\scheduled, tp\TouchPointWP\Interfaces\hierarchical, tp\TouchPointWP\Interfaces\actionButtons, tp\TouchPointWP\Interfaces\hasGeo

Methods

isPast

bool tp\TouchPointWP\Interfaces\involvementMeetingCommon::isPast()

Indicates if the meeting is in the past.

• Visibility: public

Returns

• bool -

scheduleString

?string tp\TouchPointWP\Interfaces\scheduled::scheduleString(int objId, mixed obj)

Get a description of the schedule in a human-friendly phrase, e.g. Sunday, March 31 at 2:00pm.

These strings should be cached.

• Visibility: public
• This method is static.
• This method is defined by tp\TouchPointWP\Interfaces\scheduled

Arguments

• objId int* obj mixed - Needs to be of the type that implements this interface.

Returns

• ?string -

getParent

mixed tp\TouchPointWP\Interfaces\hierarchical::getParent()

Get the parent of this object which may be an object of a different class.

Returns null if there is no parent.

• Visibility: public
• This method is defined by tp\TouchPointWP\Interfaces\hierarchical

Returns

• mixed -

getActionButtons

\tp\TouchPointWP\Utilities\StringableArray tp\TouchPointWP\Interfaces\actionButtons::getActionButtons(string|null context, string btnClass, bool withTouchPointLink, bool absoluteLinks)

• Visibility: public
• This method is defined by tp\TouchPointWP\Interfaces\actionButtons

Arguments

• context string|null - A string that gives filters some context for where the request is coming from
• btnClass string - HTML class names to put into the buttons/links
• withTouchPointLink bool - Whether to include a link to the item within TouchPoint.
• absoluteLinks bool - Set true to make the links absolute, so they work from apps or emails.

Returns

• \tp\TouchPointWP\Utilities\StringableArray -

hasGeo

bool tp\TouchPointWP\Interfaces\hasGeo::hasGeo()

Indicates whether a map of a single item can be displayed.

• Visibility: public
• This method is defined by tp\TouchPointWP\Interfaces\hasGeo

Returns

• bool -

asGeoIFace

object|null tp\TouchPointWP\Interfaces\hasGeo::asGeoIFace(string type)

Returns a standardized stdObject, or null if not viable.

Return object properties are lat, lng, human, and type.

• Visibility: public
• This method is defined by tp\TouchPointWP\Interfaces\hasGeo

Arguments

• type string - 'loc' for navigator location, or 'ip' for ip address location

Returns

• object|null -

locationName

?string tp\TouchPointWP\Interfaces\hasGeo::locationName()

Get the name of the location.

• Visibility: public
• This method is defined by tp\TouchPointWP\Interfaces\hasGeo

Returns

• ?string -