Interne API (Funktionsübersicht)

Enwikuna License Manager besitzt Funktionen, welche du intern verwenden kannst, um Lizenzen & Generatoren anzupassen. Im Folgenden findest du eine Übersicht aller Funktionen, welche dazu verwendet werden können. Bitte beachte, dass diese Funktionen nur verfügbar sind, wenn das Plugin aktiv ist.

Die aufgeführten Methoden abstrahieren ausschließlich vorhandene Klassen und deren Methoden. Als erfahrener Entwickler empfehlen wir dir, die Methoden einer Klasse direkt zu verwenden und die Klasse in PHP zu importieren.

Hier ein Beispiel

use Enwikuna\Enwikuna_License_Manager\ELM_License;

$license = ELM_License::get_instance()->find( $license_id );

Wenn du jedoch keine Importe verwenden willst, kannst du auf Methoden zurückgreifen, welche diesen Import bereits tun und deine Anfrage an die ausführende Methode der jeweiligen Klasse weitergeben.

Hier ein Beispiel

$license = elm_find_license_by( array $where );

Lizenz

Im Folgenden findest du alle Funktionen, um Lizenzen beeinflussen zu können.

elm_create_license()

/**
 * Creates a new license in the database
 *
 * @param array $license_data
 *
 * @return ELM_Data_Store_License_Model|false
 */
function elm_create_license( array $license_data );

Beschreibung

Diese Funktion erstellt eine neue Lizenz in der Datenbank.

Parameter

$license_data (array) Die Lizenzdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

elm_update_license()

/**
 * Updates a license in the database
 *
 * @param array $license_update_data
 * @param ELM_Data_Store_License_Model $license
 * @param bool $skip_before_functions
 *
 * @return ELM_Data_Store_License_Model|false
 */
function elm_update_license( array $license_update_data, ELM_Data_Store_License_Model $license, bool $skip_before_functions = false );

Beschreibung

Diese Funktion aktualisiert eine Lizenz in der Datenbank.

Parameter

$license_update_data (array) Die Lizenzaktualisierungsdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

$license (ELM_Data_Store_License_Model) Das Lizenzobjekt

$skip_before_functions (bool) Ob die Vorfunktionen übersprungen werden sollen oder nicht

elm_update_license_by()

/**
 * Updates a license in the database
 *
 * @param array $license_update_data
 * @param array $where
 * @param bool $skip_before_functions
 *
 * @return bool|ELM_Data_Store_License_Model[]
 */
function elm_update_license_by( array $license_update_data, array $where, bool $skip_before_functions = false );

Beschreibung

Diese Funktion aktualisiert eine Lizenz in der Datenbank.

Parameter

$license_update_data (array) Die Lizenzaktualisierungsdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

$where (array) Die Lizenzlokalisierungsdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

$skip_before_functions (bool) Ob die Vorfunktionen übersprungen werden sollen oder nicht

elm_find_license()

/**
 * Finds a license in the database
 *
 * @param int $license_id
 *
 * @return bool|ELM_Data_Store_License_Model
 */
function elm_find_license( int $license_id );

Beschreibung

Diese Funktion sucht eine Lizenz in der Datenbank.

Parameter

$license_id (int) Die Lizenz ID

elm_find_license_by()

/**
 * Finds a license in the database
 *
 * @param array $where
 * @param array|null $order_by
 *
 * @return bool|ELM_Data_Store_License_Model
 */
function elm_find_license_by( array $where, array $order_by = null );

Beschreibung

Diese Funktion sucht eine Lizenz in der Datenbank.

Parameter

$where (array) Die Lizenzlokalisierungsdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

$order_by (array) Die Daten zur Sortierung

elm_lock_license()

/**
 * Locks a license in the database
 *
 * @param ELM_Data_Store_License_Model $license
 *
 * @return bool|ELM_Data_Store_License_Model
 */
function elm_lock_license( ELM_Data_Store_License_Model $license );

Beschreibung

Diese Funktion sperrt eine Lizenz in der Datenbank.

Parameter

$license (ELM_Data_Store_License_Model) Das Lizenzobjekt

elm_unlock_license()

/**
 * Unlocks a license in the database
 *
 * @param ELM_Data_Store_License_Model $license
 *
 * @return bool|ELM_Data_Store_License_Model
 */
function elm_unlock_license( ELM_Data_Store_License_Model $license );

Beschreibung

Diese Funktion entsperrt eine Lizenz in der Datenbank.

Parameter

$license (ELM_Data_Store_License_Model) Das Lizenzobjekt

elm_change_license_status()

/**
 * Changes a license status
 *
 * @param ELM_Data_Store_License_Model $license
 * @param string $status
 *
 * @return bool|ELM_Data_Store_License_Model
 */
function elm_change_license_status( ELM_Data_Store_License_Model $license, string $status );

Beschreibung

Diese Funktion ändert den Status einer Lizenz in der Datenbank.

Parameter

$license (ELM_Data_Store_License_Model) Das Lizenzobjekt

$status (string) Der Lizenzstatus

elm_delete_license()

/**
 * Deletes a license from the database
 *
 * @param ELM_Data_Store_License_Model $license
 *
 * @return bool
 */
function elm_delete_license( ELM_Data_Store_License_Model $license ): bool;

Beschreibung

Diese Funktion löscht eine Lizenz aus der Datenbank.

Parameter

$license (ELM_Data_Store_License_Model) Das Lizenzobjekt

elm_delete_license_by()

/**
 * Deletes a license from the database
 *
 * @param array $where
 *
 * @return bool
 */
function elm_delete_license_by( array $where ): bool;

Beschreibung

Diese Funktion löscht eine Lizenz aus der Datenbank.

Parameter

$where (array) Die Lizenzlokalisierungsdaten (muss mit den Spalten der Lizenztabelle übereinstimmen)

Lizenzaktivierung

Im Folgenden findest du alle Funktionen, um Lizenzaktivierungen beeinflussen zu können.

elm_create_license_activation()

/**
 * Creates a new license activation in the database
 *
 * @param array $license_activation_data
 *
 * @return ELM_Data_Store_License_Activation_Model|false
 */
function elm_create_license_activation( array $license_activation_data );

Beschreibung

Diese Funktion erstellt eine neue Lizenzaktivierung in der Datenbank.

Parameter

$license_activation_data (array) Die Lizenzaktivierungsdaten (muss mit den Spalten der Lizenzaktivierungstabelle übereinstimmen)

elm_update_license_activation()

/**
 * Updates a license activation in the database
 *
 * @param array $license_activation_update_data
 * @param ELM_Data_Store_License_Activation_Model $license_activation
 *
 * @return ELM_Data_Store_License_Activation_Model|false
 */
function elm_update_license_activation( array $license_activation_update_data, ELM_Data_Store_License_Activation_Model $license_activation );

Beschreibung

Diese Funktion aktualisiert eine Lizenzaktivierung in der Datenbank.

Parameter

$license_activation_update_data (array) Die Lizenzaktivierungsaktualisierungsdaten (muss mit den Spalten der Lizenzaktivierungstabelle übereinstimmen)

$license_activation (ELM_Data_Store_License_Activation_Model) Das Lizenzaktivierungsobjekt

elm_find_license_activation()

/**
 * Finds a license activation in the database
 *
 * @param int $license_activation_id
 *
 * @return bool|ELM_Data_Store_License_Activation_Model
 */
function elm_find_license_activation( int $license_activation_id );

Beschreibung

Diese Funktion sucht eine Lizenzaktivierung in der Datenbank.

Parameter

$license_activation_id (int) Die Lizenzaktkvierungs ID

elm_find_license_activation_by()

/**
 * Finds a license activation in the database
 *
 * @param array $where
 * @param array|null $order_by
 *
 * @return bool|ELM_Data_Store_License_Activation_Model
 */
function elm_find_license_activation_by( array $where, array $order_by = null );

Beschreibung

Diese Funktion sucht eine Lizenzaktivierung in der Datenbank.

Parameter

$where (array) Die Lizenzaktivierungslokalisierungsdaten (muss mit den Spalten der Lizenzaktivierungstabelle übereinstimmen)

$order_by (array) Die Daten zur Sortierung

elm_delete_license_activation()

/**
 * Deletes a license activation from the database
 *
 * @param ELM_Data_Store_License_Activation_Model $license_activation
 *
 * @return bool
 */
function elm_delete_license_activation( ELM_Data_Store_License_Activation_Model $license_activation ): bool;

Beschreibung

Diese Funktion löscht eine Lizenzaktivierung aus der Datenbank.

Parameter

$license_activation (ELM_Data_Store_License_Activation_Model) Das Lizenzaktivierungsobjekt

elm_delete_license_activation_by()

/**
 * Deletes a license activation from the database
 *
 * @param array $where
 *
 * @return bool
 */
function elm_delete_license_activation_by( array $where ): bool;

Beschreibung

Diese Funktion löscht eine Lizenzaktivierung aus der Datenbank.

Parameter

$where (array) Die Lizenzaktivierungslokalisierungsdaten (muss mit den Spalten der Lizenzaktivierungstabelle übereinstimmen)

Generator

Im Folgenden findest du alle Funktionen, um Generatoren beeinflussen zu können.

elm_create_generator()

/**
 * Creates a new generator in the database
 *
 * @param array $generator_data
 *
 * @return ELM_Data_Store_Generator_Model|false
 */
function elm_create_generator( array $generator_data );

Beschreibung

Diese Funktion erstellt einen neuen Generator in der Datenbank.

Parameter

$generator_data (array) Die Generatordaten (muss mit den Spalten der Generatorentabelle übereinstimmen)

elm_update_generator()

/**
 * Updates a generator in the database
 *
 * @param array $generator_update_data
 * @param ELM_Data_Store_Generator_Model $generator
 *
 * @return ELM_Data_Store_Generator_Model|false
 */
function elm_update_generator( array $generator_update_data, ELM_Data_Store_Generator_Model $generator );

Beschreibung

Diese Funktion aktualisiert einen Generator in der Datenbank.

Parameter

$generator_update_data (array) Die Generatoraktualisierungsdaten (muss mit den Spalten der Generatorentabelle übereinstimmen)

$generator (ELM_Data_Store_Generator_Model) Das Generatorobjekt

elm_find_generator()

/**
 * Finds a generator in the database
 *
 * @param int $generator_id
 *
 * @return ELM_Data_Store_Generator_Model|false
 */
function elm_find_generator( int $generator_id );

Beschreibung

Diese Funktion sucht einen Generator in der Datenbank.

Parameter

$generator_id (int) Die Generator ID

elm_delete_generator()

/**
 * Deletes a generator from the database
 *
 * @param ELM_Data_Store_Generator_Model $generator
 *
 * @return bool
 */
function elm_delete_generator( ELM_Data_Store_Generator_Model $generator ): bool;

Beschreibung

Diese Funktion löscht einen Generator aus der Datenbank.

Parameter

$generator (ELM_Data_Store_Generator_Model) Das Generatorobjekt

elm_generate_license_keys()

/**
 * Generates license keys using a generator
 *
 * @param ELM_Data_Store_Generator_Model $generator
 * @param int $amount
 *
 * @return array|WP_Error
 */
function elm_generate_license_keys( ELM_Data_Store_Generator_Model $generator, int $amount = 1 );

Beschreibung

Diese Funktion generiert neue Lizenzschlüssel unter der Verwendung eines Generators.

Parameter

$generator (ELM_Data_Store_Generator_Model) Das Generatorobjekt

$amount (int) Die zu generierende Anzahl

Vertriebspartner (Pro)

Im Folgenden findest du alle Funktionen, um Vertriebspartner beeinflussen zu können.

elmp_create_distributor()

/**
 * Creates a new distributor in the database
 *
 * @param array $distributor_data
 *
 * @return ELMP_Data_Store_Distributor_Model|false
 */
function elmp_create_distributor( array $distributor_data );

Beschreibung

Diese Funktion erstellt einen neuen Vertriebspartner in der Datenbank.

Parameter

$distributor_data (array) Die Vertriebspartnerdaten (muss mit den Spalten der Vertriebspartnertabelle übereinstimmen)

elmp_update_distributor()

/**
 * Updates a distributor in the database
 *
 * @param array $distributor_update_data
 * @param ELMP_Data_Store_Distributor_Model $distributor
 *
 * @return ELMP_Data_Store_Distributor_Model|false
 */
function elmp_update_distributor( array $distributor_update_data, ELMP_Data_Store_Distributor_Model $distributor );

Beschreibung

Diese Funktion aktualisiert einen Vertriebspartner in der Datenbank.

Parameter

$distributor_update_data (array) Die Vertriebspartneraktualisierungsdaten (muss mit den Spalten der Vertriebspartnertabelle übereinstimmen)

$distributor (ELMP_Data_Store_Distributor_Model) Das Vertriebspartnerobjekt

elmp_find_distributor()

/**
 * Finds a distributor in the database
 *
 * @param int $distributor_id
 *
 * @return bool|ELMP_Data_Store_Distributor_Model
 */
function elmp_find_distributor( int $distributor_id );

Beschreibung

Diese Funktion sucht einen Vertriebspartner in der Datenbank.

Parameter

$distributor_id (int) Die Vertriebspartner ID

elmp_lock_distributor()

/**
 * Locks a distributor in the database
 *
 * @param ELMP_Data_Store_Distributor_Model $distributor
 *
 * @return bool|ELMP_Data_Store_Distributor_Model
 */
function elmp_lock_distributor( ELMP_Data_Store_Distributor_Model $distributor );

Beschreibung

Diese Funktion sperrt einen Vertriebspartner in der Datenbank.

Parameter

$distributor (ELMP_Data_Store_Distributor_Model) Das Vertriebspartnerobjekt

elmp_unlock_distributor()

/**
 * Unlocks a distributor in the database
 *
 * @param ELMP_Data_Store_Distributor_Model $distributor
 *
 * @return bool|ELMP_Data_Store_Distributor_Model
 */
function elmp_unlock_distributor( ELMP_Data_Store_Distributor_Model $distributor );

Beschreibung

Diese Funktion entsperrt einen Vertriebspartner in der Datenbank.

Parameter

$distributor (ELMP_Data_Store_Distributor_Model) Das Vertriebspartnerobjekt

elmp_delete_distributor()

/**
 * Deletes a distributor from the database
 *
 * @param ELMP_Data_Store_Distributor_Model $distributor
 *
 * @return bool
 */
function elmp_delete_distributor( ELMP_Data_Store_Distributor_Model $distributor ): bool;

Beschreibung

Diese Funktion löscht einen Vertriebspartner aus der Datenbank.

Parameter

$distributor (ELMP_Data_Store_Distributor_Model) Das Vertriebspartnerobjekt

Vertriebspartnercode (Pro)

Im Folgenden findest du alle Funktionen, um Vertriebspartnercodes beeinflussen zu können.

elmp_create_distributor_code()

/**
 * Creates a new distributor code in the database
 *
 * @param array $distributor_code_data
 *
 * @return ELMP_Data_Store_Distributor_Code_Model|false
 */
function elmp_create_distributor_code( array $distributor_code_data );

Beschreibung

Diese Funktion erstellt einen neuen Vertriebspartnercode in der Datenbank.

Parameter

$distributor_code_data (array) Die Vertriebspartnercodedaten (muss mit den Spalten der Vertriebspartnercodetabelle übereinstimmen)

elmp_update_distributor_code()

/**
 * Updates a distributor code in the database
 *
 * @param array $distributor_code_update_data
 * @param ELMP_Data_Store_Distributor_Code_Model $distributor_code
 *
 * @return ELMP_Data_Store_Distributor_Code_Model|false
 */
function elmp_update_distributor_code( array $distributor_code_update_data, ELMP_Data_Store_Distributor_Code_Model $distributor_code );

Beschreibung

Diese Funktion aktualisiert einen Vertriebspartnercode in der Datenbank.

Parameter

$distributor_code_update_data (array) Die Vertriebspartnercodeaktualisierungsdaten (muss mit den Spalten der Vertriebspartnercodetabelle übereinstimmen)

$distributor_code (ELMP_Data_Store_Distributor_Code_Model) Das Vertriebspartnercodeobjekt

elmp_find_distributor_code()

/**
 * Finds a distributor code in the database
 *
 * @param int $distributor_code_id
 *
 * @return bool|ELMP_Data_Store_Distributor_Code_Model
 */
function elmp_find_distributor_code( int $distributor_code_id );

Beschreibung

Diese Funktion sucht einen Vertriebspartnercode in der Datenbank.

Parameter

$distributor_code_id (int) Die Vertriebspartnercode ID

elmp_find_distributor_code_by()

/**
 * Finds a distributor code in the database
 *
 * @param array $where
 * @param array|null $order_by
 *
 * @return bool|ELMP_Data_Store_Distributor_Code_Model
 */
function elmp_find_distributor_code_by( array $where, array $order_by = null );

Beschreibung

Diese Funktion sucht einen Vertriebspartnercode in der Datenbank.

Parameter

$where (array) Die Vertriebspartnercodelokalisierungsdaten (muss mit den Spalten der Vertriebspartnercodetabelle übereinstimmen)

$order_by (array) Die Daten zur Sortierung

elmp_change_distributor_code_status()

/**
 * Changes a distributor code status
 *
 * @param ELMP_Data_Store_Distributor_Code_Model $distributor_code
 * @param bool $redeemed
 *
 * @return bool|ELMP_Data_Store_Distributor_Code_Model
 */
function elmp_change_distributor_code_status( ELMP_Data_Store_Distributor_Code_Model $distributor_code, bool $redeemed );

Beschreibung

Diese Funktion ändert den Status eines Vertriebspartnercodes in der Datenbank.

Parameter

$distributor_code (ELMP_Data_Store_Distributor_Code_Model) Das Vertriebspartnercodeobjekt

$redeemed (bool) Ob eingelöst oder nicht

elmp_delete_distributor_code()

/**
 * Deletes a distributor code from the database
 *
 * @param ELMP_Data_Store_Distributor_Code_Model $distributor_code
 *
 * @return bool
 */
function elmp_delete_distributor_code( ELMP_Data_Store_Distributor_Code_Model $distributor_code ): bool;

Beschreibung

Diese Funktion löscht einen Vertriebspartnercode aus der Datenbank.

Parameter

$distributor_code (ELMP_Data_Store_Distributor_Code_Model) Das Vertriebspartnercodeobjekt

elmp_generate_distributor_codes()

/**
 * Generates distributor codes
 *
 * @param int $amount
 * @param string $prefix
 * @param string $suffix
 *
 * @return array
 */
function elmp_generate_distributor_codes( int $amount, string $prefix, string $suffix ): array;

Beschreibung

Diese Funktion generiert neue Vertriebspartnercodes.

Parameter

$amount (int) Die zu generierende Anzahl

$prefix (string) Fügt einen Prefix hinzu

$suffix (string) Fügt einen Suffix hinzu

Release (Pro)

Im Folgenden findest du alle Funktionen, um Releases beeinflussen zu können.

elmp_create_release()

/**
 * Creates a new release in the database
 *
 * @param array $release_data
 *
 * @return ELMP_Data_Store_Release_Model|false
 */
function elmp_create_release( array $release_data );

Beschreibung

Diese Funktion erstellt ein neues Release in der Datenbank.

Parameter

$release_data (array) Die Releasedaten (muss mit den Spalten der Releasetabelle übereinstimmen)

elmp_update_release()

/**
 * Updates a release in the database
 *
 * @param array $release_update_data
 * @param ELMP_Data_Store_Release_Model $release
 *
 * @return ELMP_Data_Store_Release_Model|false
 */
function elmp_update_release( array $release_update_data, ELMP_Data_Store_Release_Model $release );

Beschreibung

Diese Funktion aktualisiert ein Release in der Datenbank.

Parameter

$release_update_data (array) Die Releaseaktualisierungsdaten (muss mit den Spalten der Releasetabelle übereinstimmen)

$release (ELMP_Data_Store_Release_Model) Das Releaseobjekt

elmp_find_release()

/**
 * Finds a release in the database
 *
 * @param int $release_id
 *
 * @return bool|ELMP_Data_Store_Release_Model
 */
function elmp_find_release( int $release_id );

Beschreibung

Diese Funktion sucht ein Release in der Datenbank.

Parameter

$release_id (int) Die Release ID

elmp_delete_release()

/**
 * Deletes a release from the database
 *
 * @param ELMP_Data_Store_Release_Model $release
 *
 * @return bool
 */
function elmp_delete_release( ELMP_Data_Store_Release_Model $release ): bool;

Beschreibung

Diese Funktion löscht ein Release aus der Datenbank.

Parameter

$release (ELMP_Data_Store_Release_Model) Das Releaseobjekt