awilum/craft-benchmark

Simple benchmark plugin with basic benchmark functionality for Craft CMS.

1.1.0 2022-12-12 11:26 UTC

Requires

• craftcms/cms: ^4.3.3

Requires (Dev)

• ext-iconv: *
• pestphp/pest: ^1.21.1
• phpstan/phpstan: ^1.8.0

MIT

• Sergey Romanenko

• twig
• profiler
• benchmark
• Craft
• craftcms
• craft-plugin
• twig profiler

README

Simple benchmark plugin with basic functionality for benchmarking.

Requirements

• Craft CMS: ^4.0
• PHP: ^8.0

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

   cd /path/to/project
   

2. In your terminal run composer require awilum/craft-benchmark.

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Benchmark.

Usage

{% do benchmarkStart('fetch_news') %}
    {% set entryQuery = craft.entries()
    .section('news')
    .orderBy('postDate DESC')
    .limit(10) %}
{% do benchmarkEnd('fetch_news') %}


Time elapsed: {{ benchmarkSummary()['fetch_news']['time']['elapsed_formated'] }}
Memory usage: {{ benchmarkSummary()['fetch_news']['memory']['usage_formated'] }}

//=> Time elapsed: 1ms
//=> Memory usage: 3.46KB

Functions

PHP function	Twig function	Description
Awilum\CraftBenchmark\benchmarkStart	benchmarkStart	Start benchmark prob.
Awilum\CraftBenchmark\benchmarkEnd	benchmarkEnd	End benchmark prob.
Awilum\CraftBenchmark\benchmarkDelete	benchmarkDelete	Delete benchmark prob.
Awilum\CraftBenchmark\benchmarkFlush	benchmarkFlush	Flush benchmark prob.
Awilum\CraftBenchmark\benchmarkSummary	benchmarkSummary	Get benchmark summary.

Tests

Run tests

./vendor/bin/pest

LICENSE

The MIT License (MIT) Copyright (c) Sergey Romanenko