KMP PHP API Reference

MemberExpirationImportService
in package

Imports member expiration dates from the shared two-column CSV format.

Table of Contents

Constants

TYPE_BACKGROUND_CHECK  : mixed = 'background_check'
TYPE_MEMBERSHIP  : mixed = 'membership'
IMPORT_FIELDS  : mixed = [self::TYPE_MEMBERSHIP => 'membership_expires_o...
IMPORT_HEADERS  : mixed = [self::TYPE_MEMBERSHIP => ['expiration date', '...

Properties

$Members  : MembersTable

Methods

__construct()  : mixed
getImportTypeOptions()  : array<string, string>
Return the supported import types for form options.
import()  : ServiceResult
Import one expiration-date type from an uploaded CSV file.
isBlankRow()  : bool
parseCsv()  : ServiceResult|array<string, Date>
Parse and validate the shared Member Number / Expiration Date CSV format.

Constants

IMPORT_FIELDS

private mixed IMPORT_FIELDS = [self::TYPE_MEMBERSHIP => 'membership_expires_on', self::TYPE_BACKGROUND_CHECK => 'background_check_expires_on']

IMPORT_HEADERS

private mixed IMPORT_HEADERS = [self::TYPE_MEMBERSHIP => ['expiration date', 'membership expiration date'], self::TYPE_BACKGROUND_CHECK => ['expiration date', 'background check expiration date']]

Properties

Methods

getImportTypeOptions()

Return the supported import types for form options.

public static getImportTypeOptions() : array<string, string>
Return values
array<string, string>

isBlankRow()

private isBlankRow(array<int, mixed> $row) : bool
Parameters
$row : array<int, mixed>

Parsed CSV row

Return values
bool

parseCsv()

Parse and validate the shared Member Number / Expiration Date CSV format.

private parseCsv(resource $handle, string $importType) : ServiceResult|array<string, Date>
Parameters
$handle : resource

Readable CSV stream

$importType : string

Selected expiration-date type

Return values
ServiceResult|array<string, Date>
On this page

Search results