... element
public function pre(Element $pre): Element
{
$pre->properties->set('data-filename', 'example.php');
return $pre;
}
// Modify each line element
public function line(Element $span, array $tokens, int $index): Element
{
$span->properties->set('data-line', (string)($index + 1));
return $span;
}
// Modify individual token elements
public function token(Element $span, HighlightedToken $token, int $index, int $line): Element
{
if (str_contains($token->token->text, 'TODO')) {
$span->properties->get('class')->add('todo-highlight');
}
return $span;
}
// Modify final HTML output
public function postprocess(string $html): string
{
return "\n" . $html;
}
}
$phiki = new Phiki();
$html = $phiki
->codeToHtml('// TODO: fix this', Grammar::Php, Theme::GithubLight)
->transformer(new CustomTransformer())
->toString();
```
--------------------------------
### Register Custom Theme in Phiki 2.0
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/upgrade-2.0.mdx
Use the `Phiki::theme()` method to register custom themes, following the removal of custom environment support.
```php
$phiki = (new Phiki)
->theme('my-custom-theme', '/path/to/theme.json');
```
--------------------------------
### Diff Annotation (Insert/Remove)
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/commonmark.mdx
Employ `[code! insert]` or `[code! remove]` comments to denote line insertions or deletions. Shorthands `--` for insert and `++` for remove are available.
```php
$user = User::find(1); // [code! remove]
```
```php
$user = User::findOrFail(1); // [code! insert]
```
```php
$user = User::find(1); // [code! --]
```
```php
$user = User::findOrFail(1); // [code! ++]
```
--------------------------------
### Clear cache via Artisan
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/laravel.mdx
Manually clear the application cache using the artisan command.
```sh
php artisan cache:clear
```
--------------------------------
### Use Blade component for code highlighting
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/laravel.mdx
Highlight code directly in Blade views using the phiki::code component.
```blade
echo "Hello, world!";
```
```blade
echo "Hello, world!";
```
```blade
echo "Hello, world!";
```
--------------------------------
### Focus Line Annotation
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/commonmark.mdx
Use a trailing comment with `[code! focus]` to highlight a specific line. Shorthands `f` or `**` can also be used.
```php
echo "Hello, world!"; // [code! focus]
```
```php
echo "Hello, world!"; // [code! f]
```
```php
echo "Hello, world!"; // [code! **]
```
--------------------------------
### Register Custom Extension in Phiki 2.0
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/upgrade-2.0.mdx
Use the `Phiki::extend()` method to register custom extensions after custom environment support was removed.
```php
$phiki = (new Phiki)
->extend(new MyCustomExtension());
```
--------------------------------
### Laravel Facade Custom Extension Registration
Source: https://context7.com/phikiphp/phiki/llms.txt
Register custom grammars, themes, or extensions within a Laravel service provider using the Phiki facade. This allows for extended functionality and custom styling.
```php
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
public function boot(): void
{
// Register custom grammars
Phiki::grammar('my-grammar', resource_path('grammars/my-grammar.json'));
// Register custom themes
Phiki::theme('my-theme', resource_path('themes/my-theme.json'));
// Register custom extensions
Phiki::extend(new MyCustomExtension());
// Use a specific cache store (defaults to CACHE_STORE)
Phiki::cache(Cache::store('redis'));
}
}
```
--------------------------------
### Apply AddClassesTransformer to HTML
Source: https://github.com/phikiphp/phiki/blob/2.x/docs/add-classes-transformer.mdx
Use this transformer to automatically add scope-based CSS classes to HTML elements. Ensure Phiki and AddClassesTransformer are imported.
```php
use Phiki\Phiki;
use Phiki\Transformers\AddClassesTransformer;
$html = (new Phiki)
->codeToHtml("transformer(new AddClassesTransformer)
->toString();
```
--------------------------------
### Apply Custom CSS Classes with Decorations in PHP
Source: https://context7.com/phikiphp/phiki/llms.txt
Use Decorations like PreDecoration, CodeDecoration, LineDecoration, and GutterDecoration to apply custom CSS classes to specific elements. This is useful for targeted styling and highlighting.
```php
use Phiki\Phiki;
use Phiki\Grammar\Grammar;
use Phiki\Theme\Theme;
use Phiki\Transformers\Decorations\PreDecoration;
use Phiki\Transformers\Decorations\CodeDecoration;
use Phiki\Transformers\Decorations\LineDecoration;
use Phiki\Transformers\Decorations\GutterDecoration;
$phiki = new Phiki();
$code = <<<'PHP'
codeToHtml($code, Grammar::Php, Theme::GithubLight)
->withGutter()
->decoration(
PreDecoration::make()->class('code-block'),
CodeDecoration::make()->class('code-content'),
LineDecoration::forLine(1)->class('highlight'), // Highlight line 2 (0-indexed)
LineDecoration::forLine(2)->class('focus'), // Focus line 3
GutterDecoration::make()->class('line-numbers'),
)
->toString();
/*
.code-block { border: 1px solid #ccc; border-radius: 8px; }
.line.highlight { background-color: rgba(255, 255, 0, 0.2); }
.line.focus { background-color: rgba(0, 100, 255, 0.1); }
*/
```
--------------------------------
### Extracting raw tokens with codeToTokens
Source: https://context7.com/phikiphp/phiki/llms.txt
Provides access to raw tokenization data instead of generating HTML, useful for custom processing.
```php
use Phiki\Phiki;
use Phiki\Grammar\Grammar;
$phiki = new Phiki();
$code = 'codeToTokens($code, Grammar::Php);
// Each token contains: text, scopes
foreach ($tokens as $lineIndex => $lineTokens) {
echo "Line $lineIndex:\n";
foreach ($lineTokens as $token) {
echo " Text: '{$token->text}' | Scopes: " . implode(', ', $token->scopes) . "\n";
}
}
```