Create New Module

<?php

if (!defined('IN_SCRIPT') && !defined('IN_ADMIN')) {
	exit;
}

require_once dirname(__DIR__, 2) . '/core/ModuleBase.php';

class MyModuleModule extends ModuleBase
{
	// ── Identity (REQUIRED) ───────────────────────────────
	public string $name = 'my-module';        // must match folder name
	public string $title = 'My Module';
	public string $version = '1.0.0';
	public string $description = 'Short description';
	public string $author = 'FriSay';

	// ── Display hooks ─────────────────────────────────────
	public array $displayHooks = [
		'footer' => 'Adds HTML to the footer area',
	];
	public array $defaultDisplayHooks = ['footer'];

	// ── CSS/JS (empty array = load all files in assets/css or assets/js) ─
	public array $frontStylesheets = ['front.css'];
	public array $frontScripts = [];
	public array $adminStylesheets = ['admin.css'];
	public array $adminScripts = [];

	// ── API endpoints ─────────────────────────────────────
	public array $apiActions = [
		'save' => 'api/save.php',
	];

	// ── Custom store routes: site.com/{slug} ────────────
	public array $routes = [
		// 'my-page' => 'front/page.php',
	];

	// ── REQUIRED: install / uninstall ─────────────────────
	public function install(): bool
	{
		return $this->runSqlFile('install.sql');
		// No database table: return true;
	}

	public function uninstall(): bool
	{
		return $this->runSqlFile('uninstall.sql');
	}

	// ── Optional: runs when module is loaded ──────────────
	public function boot(): void
	{
		Module::registerHook('order.placed', function (array $order): void {
			// Run after order is created
		});
	}

	// ── Admin configure page (/admin/module-my-module) ────
	public function adminPage(): void
	{
		global $smarty, $adminToken;

		$flash = '';

		if (Tools::isSubmit('saveMyModule')) {
			$postToken = (string) Tools::getValue('token');

			if (hash_equals($adminToken, $postToken)) {
				Settings::set('MY_MODULE_SETTING', trim((string) Tools::getValue('setting')));
				$flash = 'Saved';
			} else {
				$flash = 'Invalid request';
			}
		}

		$smarty->assign([
			'setting' => Settings::get('MY_MODULE_SETTING'),
			'flash'   => $flash,
		]);
	}

	// ── Storefront hook output ────────────────────────────
	public function renderDisplayHook(string $hook, array $context = []): ?string
	{
		if ($hook !== 'footer') {
			return null;
		}

		$html = $this->renderFrontTemplate('footer', [
			'message' => Settings::get('MY_MODULE_SETTING'),
		]);

		return $html !== '' ? $html : null;
	}
}

{* assets/templates/admin/admin.tpl *}

{if $flash}
<div class="alert alert-info">{$flash|escape}</div>
{/if}

<form method="post" class="admin-panel p-3" style="max-width:400px">
	<input type="hidden" name="saveMyModule" value="1">
	<input type="hidden" name="token" value="{$adminToken}">

	<label class="form-label">Setting value</label>
	<input type="text" name="setting" class="form-control" value="{$setting|escape}">

	<button type="submit" class="btn btn-dark mt-3">Save</button>
</form>

<?php

if (!defined('IN_SCRIPT')) {
	exit;
}

header('Content-Type: application/json; charset=utf-8');

if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
	http_response_code(405);
	echo json_encode(['success' => false, 'message' => 'Method not allowed']);
	exit;
}

// Store CSRF — use global csrfToken in JS, NOT admin/cron tokens
$token = Tools::getValue('token') ?: ($_SERVER['HTTP_X_CSRF_TOKEN'] ?? '');

if (!hash_equals($_SESSION['csrf_token'] ?? '', (string) $token)) {
	http_response_code(403);
	echo json_encode(['success' => false, 'message' => 'Invalid request']);
	exit;
}

$result = MyModuleModule::doSomething((string) Tools::getValue('field'));
echo json_encode($result);

// csrfToken is defined in header.tpl — do not hardcode tokens in templates
$(document).on('submit', '.my-module-form', function (e) {
	e.preventDefault();
	var $form = $(this);
	$.ajax({
		url: $form.data('api-url'),
		method: 'POST',
		dataType: 'json',
		data: {
			token: typeof csrfToken !== 'undefined' ? csrfToken : '',
			field: $.trim($form.find('[name="field"]').val())
		}
	});
});

<?php

public bool $isPayment = true;
public string $paymentMethodId = 'bank_transfer';
public string $paymentMethodLabel = 'Bank Transfer';
public bool $paysBeforeOrder = false;

// order_payment.tpl — radio value must match $paymentMethodId
public function processPayment(array $order): array
{
	return [
		'success'  => true,
		'redirect' => '',
		'message'  => '',
	];
}

FriSay e-commerce project — write a module.

Rules: follow ALL rules in MODULE_DEVELOPER_GUIDE.md
PHP 7.4 compatible. Extend ModuleBase. Do NOT modify theme or core files.

Module info:
- name (slug): {my-module}
- title: {Display Name}
- description: {what it does}

Features:
- Display hooks: {footer, product_tab, ...}
- API actions: {action => description}
- Payment module: {yes/no}
- Database tables: {schema if any}
- Admin settings: {Settings keys or table fields}

Files to generate:
1. modules/{name}/{name}.php
2. install.sql / uninstall.sql (if needed)
3. assets/templates/admin/admin.tpl
4. assets/templates/front/{hook}.tpl (one per hook)
5. assets/css/, assets/js/ (if needed)
6. api/{action}.php (if needed)
7. front/{page}.php (if route needed)

Reference modules: whatsapp, newsletter, reviews, question, bankwire, sanalpos

<?php

// Settings (use UPPERCASE keys with module prefix)
Settings::get('DOMAIN');          // site URL — NOT 'domain'
Settings::get('SITE_NAME');
Settings::set('MY_MODULE_KEY', 'value');

// Database
DB::getRowSafe('table', 'id = ?', [$id]);
DB::insert('table', ['col' => 'value']);
DB::update('table', ['col' => 'v'], 'id = :where_id', ['where_id' => $id]);
DB::execute('DELETE FROM table WHERE id = ?', [$id]);

// Store data
$product = Product::getById($idProduct);   // includes 'url' field
$images  = Product::getImages($idProduct);
$cart    = Cart::getSummary();
$isFav   = Favorite::isFavorite($idProduct);

// Customer
Customer::isLoggedIn();
Customer::getId();
Customer::getCurrent();

// Tools
Tools::displayPrice(99.90);       // ₺99,90
Tools::createSlug('ana sayfa');   // ana-sayfa
Tools::maskName('John Smith');    // J** S****

// Admin URL
Admin::url('module-my-module');   // https://site.com/admin/module-my-module

// Pagination
$pagination = Pagination::build($total, $page, 30, Admin::url('module-my-module'));

// Mail
Mail::send($to, $subject, $bodyHtml);