autoloader.md

extends	docs
title	Autoloader
group	Architecture
prev	template
next	theme-service-container
order	4

The Tonik\Gin\Foundation\Autoloader class helps with autoloading theme components files.

Usage

Initializing autoloader

Autoloader class requires an instance of Tonik\Gin\Foundation\Config to be injected with setup paths, directories and autoload properties. The autoload option should include a list of components relative paths to the app/ directory paths.

use Tonik\Gin\Foundation\Config;
use Tonik\Gin\Foundation\Autoloader;

$config = new Config([
  'paths' => [
    'directory' => get_template_directory(),
  ],
  'directories' => [
    'app' => 'app',
  ],
  'autoload' => [
    'Http/assets.php',
  ]
]);

$autoloader = new Autoloader($config);

Requiring components listed to autoload

To autoload listed component simply call load method. This will require_once all listed files.

$autoloader->load();

Getting relative path of an autoloaded component

Gets relative path of a specified component to the project app directory.

$autoloader->getRelativePath('Http/assets.php');

// 'app/Http/assets.php'

Getting path of an autoloaded component

Gets full directory path to the component file on your server.

$autoloader->getPath('Http/assets.php');

// 'website/directory/app/Http/assets.php'

Actions

tonik/gin/autoloader/before_load

Fires before requiring listed files by autoloader.

add_action('tonik/gin/autoloader/before_load', function() {
  // logic
});

tonik/gin/autoloader/after_load

Fires after requiring listed files by autoloader.

add_action('tonik/gin/autoloader/after_load', function() {
  // logic
});