Autodoc
  • Namespace
  • Class
  • Tree

Namespaces

  • BlueTihi
    • Context
  • Brickrouge
    • Element
      • Nodes
    • Renderer
    • Widget
  • ICanBoogie
    • ActiveRecord
    • AutoConfig
    • CLDR
    • Composer
    • Core
    • Event
    • Exception
    • HTTP
      • Dispatcher
      • Request
    • I18n
      • Translator
    • Mailer
    • Modules
      • Taxonomy
        • Support
      • Thumbnailer
        • Versions
    • Object
    • Operation
      • Dispatcher
    • Prototype
    • Routes
    • Routing
      • Dispatcher
    • Session
  • Icybee
    • ActiveRecord
      • Model
    • ConfigOperation
    • Document
    • EditBlock
    • Element
      • ActionbarContextual
      • ActionbarSearch
      • ActionbarToolbar
    • FormBlock
    • Installer
    • ManageBlock
    • Modules
      • Articles
      • Cache
        • Collection
        • ManageBlock
      • Comments
        • ManageBlock
      • Contents
        • ManageBlock
      • Dashboard
      • Editor
        • Collection
      • Files
        • File
        • ManageBlock
      • Forms
        • Form
        • ManageBlock
      • I18n
      • Images
        • ManageBlock
      • Members
      • Modules
        • ManageBlock
      • Nodes
        • ManageBlock
        • Module
      • Pages
        • BreadcrumbElement
        • LanguagesElement
        • ManageBlock
        • NavigationBranchElement
        • NavigationElement
        • Page
        • PageController
      • Registry
      • Search
      • Seo
      • Sites
        • ManageBlock
      • Taxonomy
        • Terms
          • ManageBlock
        • Vocabulary
          • ManageBlock
      • Users
        • ManageBlock
        • NonceLogin
        • Roles
      • Views
        • ActiveRecordProvider
        • Collection
        • View
    • Operation
      • ActiveRecord
      • Constructor
      • Module
      • Widget
    • Rendering
  • None
  • Patron
  • PHP

Classes

  • AdminDecorator
  • AdminIndexController
  • BlockController
  • BlockDecorator
  • ConfigBlock
  • ConfigController
  • ConfigOperation
  • Core
  • DeleteBlock
  • DeleteController
  • Document
  • DocumentDecorator
  • EditBlock
  • EditController
  • FormBlock
  • Hooks
  • InterlockBlock
  • Kses
  • ManageBlock
  • Module
  • Modules
  • StatsDecorator

Constants

  • OPERATION_SAVE_MODE
  • OPERATION_SAVE_MODE_CONTINUE
  • OPERATION_SAVE_MODE_DISPLAY
  • OPERATION_SAVE_MODE_LIST
  • OPERATION_SAVE_MODE_NEW

Functions

  • slugize
  • start
  • strip_stopwords

Class Hooks

Namespace: Icybee
Located at vendor/icybee/icybee/lib/hooks.php

Methods summary

public static
# on_http_dispatcher_alter( ICanBoogie\HTTP\Dispatcher\AlterEvent $event, ICanBoogie\HTTP\Dispatcher $dispatcher )
public static
# before_routes_collect( ICanBoogie\Routes\BeforeCollectEvent $event, ICanBoogie\Routes $target )
public static ICanBoogie\Operation
# dispatch_query_operation( ICanBoogie\HTTP\Request $request )

This is the dispatcher for the QueryOperation operation.

This is the dispatcher for the QueryOperation operation.

Parameters

$request
array
$params

Returns

ICanBoogie\Operation
public static
# before_user_logout( ICanBoogie\Event $event )

This callback is used to delete all the locks set by the user while editing records.

This callback is used to delete all the locks set by the user while editing records.

Parameters

$event
ICanBoogie\Event
$event
public static
# before_save_operation_control( ICanBoogie\Operation\BeforeControlEvent $event, ICanBoogie\SaveOperation $target )

Alters the response location according to the _operation save mode_.

Alters the response location according to the _operation save mode_.

The following modes are supported:

  • Icybee\OPERATION_SAVE_MODE_LIST: Location is the module's index.
  • Icybee\OPERATION_SAVE_MODE_CONTINUE: Location is the edit URL of the record.
  • Icybee\OPERATION_SAVE_MODE_NEW: Location is a blank edit form.
  • Icybee\OPERATION_SAVE_MODE_DISPLAY: Location is the URL of the record.

The _operation save mode_ is saved in the session per module:
$core->session[operation_save_mode][<module_id>]

Parameters

$event
ICanBoogie\Operation\BeforeControlEvent
$event
$target
ICanBoogie\SaveOperation
$target
public static
# before_page_controller_render( )

Attaches a hook to the BlueTihi\Context::loaded_nodes event to provide data for the admin menu. The data is consumed by Icybee\Hooks::on_page_controller_render().

Attaches a hook to the BlueTihi\Context::loaded_nodes event to provide data for the admin menu. The data is consumed by Icybee\Hooks::on_page_controller_render().

public static
# on_page_controller_render( Icybee\Modules\Pages\PageController\RenderEvent $event, Icybee\Modules\Pages\PageController $target )

Adds the AdminMenu to pages rendered by the page controller.

Adds the AdminMenu to pages rendered by the page controller.

Parameters

$event
Icybee\Modules\Pages\PageController\RenderEvent
$event
$target
Icybee\Modules\Pages\PageController
$target
public static
# get_cldr( )
public static string
# markup_alerts( array $args, mixed $engine, mixed $template )

Displays the alerts issued during request processing.

Displays the alerts issued during request processing.

<p:alerts>
    <!-- Content: template? -->
</p:alerts>

A marker is placed in the rendered HTML that will later be replaced by the actual alerts.

The following alerts are displayed: success, info and error. debug alert and displayed if the debug mode is Icybee\Debug::MODE_DEV.

Parameters

$args
array
$args
$engine
mixed
$engine
$template
mixed
$template

Returns

string
public static string
# markup_body( array $args, mixed $engine, mixed $template )

The BODY element.

The BODY element.

<p:body
    class = string>
    <!-- Content: with-param*, template? -->
</p:body>

The class attribute of the element can be specified with the class param. It is extended with the class of the Icybee\Document instance.

Parameters

$args
array
$args
$engine
mixed
$engine
$template
mixed
$template

Returns

string

Magic methods summary

Autodoc API documentation generated by ApiGen 2.8.0