Involvement_PostTypeSettings
in package
Contains the settings for a single Involvement Post Type. This is instantiated as an array of these objects.
Table of Contents
Constants
- POST_TYPE_PREFIX = "inv_"
Properties
- $contactKeywords : array<string|int, int>
- $excludeIf : array<string|int, string>
- $filters : array<string|int, string>
- $groupBy : string
- $hierarchical : bool
- $hostTypes : array<string|int, string>
- $importDivs : array<string|int, string>
- $joinKeywords : array<string|int, int>
- $leaderTypes : array<string|int, string>
- $namePlural : string
- $nameSingular : string
- $postType : string
- $slug : string
- $taskOwner : string
- $useGeo : bool
- $useImages : bool
Methods
- __construct() : mixed
- __get() : mixed
- getForInvType() : Involvement_PostTypeSettings|null
- Gets the Involvement Post Type Settings object for a given inv type.
- getPostTypes() : array<string|int, string>
- Gets an array of the postType strings.
- getPostTypesWithGeoEnabled() : array<string|int, string>
- Gets an array of the postType strings for post type that use Geo.
- hostTypeInts() : array<string|int, int>|null
- Get the host member types, as an array of ints. Will be null if useGeo is false.
- instance() : array<string|int, Involvement_PostTypeSettings>
- leaderTypeInts() : array<string|int, int>
- Get the leader member types, as an array of ints
- postTypeWithoutPrefix() : string
- postTypeWithPrefix() : string
- validateNewSettings() : string
Constants
POST_TYPE_PREFIX
public
mixed
POST_TYPE_PREFIX
= "inv_"
Properties
$contactKeywords read-only
public
array<string|int, int>
$contactKeywords
$excludeIf read-only
public
array<string|int, string>
$excludeIf
$filters read-only
public
array<string|int, string>
$filters
$groupBy read-only
public
string
$groupBy
$hierarchical read-only
public
bool
$hierarchical
$hostTypes read-only
public
array<string|int, string>
$hostTypes
$importDivs read-only
public
array<string|int, string>
$importDivs
$joinKeywords read-only
public
array<string|int, int>
$joinKeywords
$leaderTypes read-only
public
array<string|int, string>
$leaderTypes
$namePlural read-only
public
string
$namePlural
$nameSingular read-only
public
string
$nameSingular
$postType read-only
public
string
$postType
$slug read-only
public
string
$slug
$taskOwner read-only
public
string
$taskOwner
$useGeo read-only
public
bool
$useGeo
$useImages read-only
public
bool
$useImages
Methods
__construct()
public
__construct(object $o) : mixed
Parameters
- $o : object
__get()
public
__get(mixed $what) : mixed
Parameters
- $what : mixed
getForInvType()
Gets the Involvement Post Type Settings object for a given inv type.
public
static getForInvType(string $postType) : Involvement_PostTypeSettings|null
Parameters
- $postType : string
Return values
Involvement_PostTypeSettings|nullgetPostTypes()
Gets an array of the postType strings.
public
final static getPostTypes() : array<string|int, string>
Return values
array<string|int, string>getPostTypesWithGeoEnabled()
Gets an array of the postType strings for post type that use Geo.
public
final static getPostTypesWithGeoEnabled() : array<string|int, string>
Return values
array<string|int, string>hostTypeInts()
Get the host member types, as an array of ints. Will be null if useGeo is false.
public
hostTypeInts() : array<string|int, int>|null
Return values
array<string|int, int>|nullinstance()
public
final static & instance() : array<string|int, Involvement_PostTypeSettings>
Return values
array<string|int, Involvement_PostTypeSettings>leaderTypeInts()
Get the leader member types, as an array of ints
public
leaderTypeInts() : array<string|int, int>
Return values
array<string|int, int>postTypeWithoutPrefix()
public
postTypeWithoutPrefix() : string
Return values
stringpostTypeWithPrefix()
public
postTypeWithPrefix() : string
Return values
stringvalidateNewSettings()
public
static validateNewSettings(string $new) : string
Parameters
- $new : string