Kirby CMS Website Source

Kirby is not free software. While the source code is publicly available, using Kirby in a production environment (a Public Site) requires a paid license.

Key concepts of the licensing model:

• Per-Project Licensing: Each unique Website (defined by its domain name and root directory) requires its own license.
• Website Definition: A Website is a single Kirby project. Subdomains or different root directories count as separate Websites.
  • Exception: If using the cross-domain multi-language feature with the same content folder, these domains count as the same Website.
  • Headless/SSG: If used as a headless backend or static site generator, the Website is defined by the domain/root of the visitor-facing frontend.
• Included Updates Period: A license includes all Kirby releases (including Major Releases) published within three (3) years of the Activation Date.
• Upgrading: To use Major Generations released after the three-year period, you must perform a paid license upgrade. Upgrading extends the update timeframe for another three years.
• License Transfer/Reassignment: You can transfer a license to another person or reassign it to a different project for the same client, subject to verification and contact with support.

The Types namespace provides objects to represent and render PHP types in documentation.

• Type: A simple type. Use $type->toString() for text or $type->toHtml() to wrap it in a <code> tag with the appropriate CSS selector. Use Type::factory() to instantiate.
• Identifier: An extension of Type for classes. ::toHtml() can optionally link to the corresponding Reference page. This is used by Marsdown for inline code linking.
• Chain: An extension of Type representing a chained method call (e.g., $page->content()->title()). It resolves the chain, provides links, and handles special short handles like $page.
• Types: A collection of Type objects. It normalizes reflection data by:
  • Replacing self or static with full class names.
  • Removing duplicate types.
  • Including |null for nullable types. Use $types->toString() or $types->toHtml() for template rendering.

The Kirby\Reference system uses PHP reflection to automatically generate documentation. It is built around the Reflectable abstraction.

Reflectable Classes

Various classes implement Reflectable to expose metadata about Kirby core components. Common classes include:

• ReflectableFieldMethod (for field methods)
• ReflectableKirbytag (for KirbyTags)
• ReflectableClass and ReflectableClassMethod (for classes and methods)
• ReflectableHelperFunction (for helper functions)
• ReflectableCoreComponent (for core components)
• ReflectableValidator (for validators)

All Reflectable classes share a common set of methods to retrieve DocBlock information:

• $reflectable->summary(): Short description from DocBlock.
• $reflectable->examples(): Code examples from DocBlock.
• $reflectable->isDeprecated(): Boolean indicating deprecation.
• $reflectable->isInternal(): Boolean indicating if the part is internal.
• $reflectable->since(): The @since tag information.
• $reflectable->source(): URL to the GitHub source.
• $reflectable->throws(): The @throws tag information.

The plugin extends Kirby's snippet system by allowing you to store full HTML layouts in /site/layouts.

Layouts and Slots

Layouts use slots to define where content from a template should be injected.

• The Default Slot: Represented by the variable $slot. If you do not specify a name for a slot in your template, the content is passed to this default slot.
• Named Slots: You can define multiple unique named slots in a layout. These allow you to inject content into specific parts of the layout (e.g., a sidebar or a header) from your template.
• Default Content: Slots in layouts can define default content that renders if the template does not provide content for that specific slot.

Implementation Example

1. Define the layout in /site/layouts/default.php:

<html
	<head>
		<title><?= $page->title() ?></title>
	</head>
	<body>
		<?= $slot ?>
	</body>
</html>

2. Use the layout in /site/templates/my-template.php:

<?php layout() ?>

<h1 >Hello world</h1>
<p>This will end up in the default slot</p>

<!-- /site/layouts/default.php -->
<html
	<head>
		<title><?= $page->title() ?></title>
	</head>
	<body>
		<?= $slot ?>
	</body>
</html>

<!-- /site/templates/my-template.php -->
<?php layout() ?>

<h1 >Hello world</h1>
<p>This will end up in the default slot</p>