Class Hooks

Namespace: Icybee\Modules\Pages
Located at vendor/icanboogie-modules/pages/lib/hooks.php

Methods summary

`public static`	# `on_http_dispatcher_alter( ICanBoogie\HTTP\Dispatcher\AlterEvent $event, ICanBoogie\HTTP\Dispatcher $target )` Adds the `pages` dispatcher, which serves pages managed by the module. Adds the `pages` dispatcher, which serves pages managed by the module. Parameters `$event` `ICanBoogie\HTTP\Dispatcher\AlterEvent` $event `$target` `ICanBoogie\HTTP\Dispatcher` $target
`public static`	# `on_file_move( Icybee\Modules\Files\File\MoveEvent $event, Icybee\Modules\Files\File $target )` The callback is called when the `Icybee\Modules\Files\File::move` event is triggered, allowing us to update content to the changed path of resource. The callback is called when the `Icybee\Modules\Files\File::move` event is triggered, allowing us to update content to the changed path of resource. Parameters `$event` `Icybee\Modules\Files\File\MoveEvent` $event `$target` `Icybee\Modules\Files\File` $target
`public static`	# `on_page_move( Icybee\Modules\Pages\Page\MoveEvent $event, Icybee\Modules\Pages\Page $target )` The callback is called when the `Icybee\Modules\Pages\Page::move` event is triggered, allowing us to update content to the changed url of the page. The callback is called when the `Icybee\Modules\Pages\Page::move` event is triggered, allowing us to update content to the changed url of the page. Note that only url within something that looks like a HTML attribute are updated, the matching pattern is ~="<url>("\|/)~ Parameters `$event` `Icybee\Modules\Pages\Page\MoveEvent` $event `$target` `Icybee\Modules\Pages\Page` $target
`public static`	# `invalidate_cache( )` An operation (save, delete, online, offline) has invalidated the cache, thus we have to reset it. An operation (save, delete, online, offline) has invalidated the cache, thus we have to reset it.
`public static Icybee\Modules\Pages\Page`	# `get_page( ICanBoogie\Core $core )` Returns the current page. Returns the current page. This getter is a shortcut for the `request->context->page` property. Parameters `$core` `ICanBoogie\Core` $core Returns `Icybee\Modules\Pages\Page`
`public static Icybee\Modules\Pages\Page\|null`	# `get_home( Icybee\Modules\Sites\Site $site )` Returns the home page of the target site. Returns the home page of the target site. Parameters `$site` `Icybee\Modules\Sites\Site` $site Returns `Icybee\Modules\Pages\Page\|null` The home page of the target site or `null` if there is none.
`public static`	# `before_document_render_title( Icybee\Document\BeforeRenderTitleEvent $event )`
`public static`	# `markup_page_region( array $args, Patron\Engine $patron, mixed $template )`
`public static`	# `markup_page_title( array $args, mixed $engine, mixed $template )`
`public static mixed`	# `markup_page_content( array $args, Patron\Engine $patron, mixed $template )` Defines an editable page content in a template. Defines an editable page content in a template. <p:page:content id = qname title = string editor = string inherit = boolean> <!-- Content: with-param*, template? --> </p:page:content> The `id` attribute specifies the identifier of the content, it is required and must be unique in the template. The `title` attribute specifies the label of the editor in the page editor, it is required. The `editor` attribute specifies the editor to use to edit the content, it is optional. The `inherit` attribute specifies that the content can be inherited. Example: <p:page:content id="body" title="Page body" /> <p:page:content id="picture" title="Decorating picture" editor="image" inherit="inherit"> <img src="#{@path}" alt="#{@alt}" /> </p> Parameters `$args` `array` $args `$patron` `Patron\Engine` $patron `$template` `mixed` $template Returns `mixed`
`protected static`	# `handle_external_anchors( string $html )` Adds a blank target to external href. Adds a blank target to external href. Parameters `$html` `string` $html

Magic methods summary