Plugins Hilfsklasse für dein Projekt

• Schneller Einstieg

  • Was ist webpackages ?
  • Installation
  • Hello World

• Grundlagen

  • Modul View Controller (MVC)
  • load_functions Klasse
  • Hilfsklassen

• Hilfsklassen

  • Benchmark Klasse
  • Cache Klasse
  • Captcha Klasse
  • cURL Klasse
  • Database Klasse
  • Date Klasse
  • Errors Klasse
  • FileSystem Klasse
  • FTP Klasse
  • Images Klasse
  • Language Klasse
  • Logger Klasse
  • Number Klasse
  • PayPal Klasse
  • PHPMailer Klasse
  • Plugins Klasse
  • RestClient Klasse
  • Security Klasse
  • Template Klasse
  • Text Klasse
  • URL Klasse
  • XML Klasse
  • ZIP Klasse

Plugins Klasse

In den folgenden Abschnitten werden die einzelnen Methoden der Klasse erklärt.

hooks

public static mixed hooks( string $position, string $classes, string $methode, array $args = array())

Ruft die Methode hookShow und hookCall auf.

Parameterliste

position

Ist für die eindeutige Identifizierung in einer Methode gedacht. Wo wird das Plugin eingebunden. Hierbei stehen 2 Klassen Konstanten zur Verfügung die gesetzt werden können.

• BEFORE - Anfang
• AFTER - Ende

classes

In welcher Klasse wird das Plugin aufgerufen. Hier reicht es aus den Klassennamen ohne Namespace anzugeben.

methode

In welcher Methode in der Klasse wird das Plugin aufgerufen. Hierbei nur den Methodennamen angeben ohne Parameter.

args

Die Parameter die an die Plugin Funktion übermittelt werden soll. Dabei ist wichtig das sich hierbei um ein assoziatives Array handelt.

Ein Beispiel könnte wie folgt aussehen:

<?php
class testClass
{
	public function testMethode($testArgs)
	{
		\package\core\plugins::hooks(\package\core\plugins::BEFORE, 'testClass', 'testMethode', $testArgs);

		//My PHP Code

		\package\core\plugins::hooks(\package\core\plugins::AFTER, 'testClass', 'testMethode', $testArgs);

		return $result;
	}
}
?>

Das Plugin würde dann wie folgt aussehen:

<?php
class myPlugin
{
	public function before_testClass_testMethode_show($testArgs)
	{
		//No return
	}

	public function before_testClass_testMethode_call($testArgs)
	{
		return $return;
	}

	public function after_testClass_testMethode_show($testArgs)
	{
		//No return
	}

	public function after_testClass_testMethode_call($testArgs)
	{
		return $return;
	}
}
?>

hookShow

public static void hookShow( string $position, string $classes, string $methode, array $args = array())

Ruft ein Plugin auf und übermittelt Daten. Das Plugin darf keinen Rückgabewert haben. Falls es doch einen besitzen sollte, wird dieser ignoriert.

Parameterliste

position

An welcher Position der Methode findet der hook Aufruf statt. BEFORE und AFTER sind erlaubt.

classes

Der Name der Klasse wo der hook aufgerufen wird. Ohne Namespace.

methode

Die Methode wo der hook aufgerufen wird. Ohne Parameter.

args

Ein assoziatives Array an Daten als Parameter für das aufzurufende Plugin.

hookCall

public static mixed hookCall( string $position, string $classes, string $methode, array $args = array())

Ruft einen hook auf und gibt das Resultat zurück. Das Resultat darf nicht null sein. Ansonsten wird es als fehlgeschlagener Aufruf gewertet.

Parameterliste

position

Der Positionsaufruf des hooks in der Klasse. Erlaubt sind BEFORE und AFTER

classes

Der Klassenname wo der hook in der Methode aufgerufen wird. Ohne Namespace.

methode

Der Methodenname wo der hook aufgerufen wird. Ohne Parameter.

args

Die Parameter die an den hook übermittelt werden sollen. Dies sollte ein assoziatives Array sein.

hookTemplate

public static mixed hookTemplate( string $template, string $position, array $args = array())

Ein Hook für die Template Ausgabe. Hierbei unterscheiden sich die Parameter zu den anderen Methoden nur geringfügig.

Parameterliste

template

Das Name des Template in dem der Hook aufgerufen wird.

position

Die Position des Templates. Hier sind keine festen Begrifflichkeiten vordefiniert.

args

Parameter die an den hook übermittelt werden. Dies sollte ein assoziatives Array sein.