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

  • ContactForm
  • DefaultsOperation
  • EditBlock
  • EmailComposer
  • Form
  • FormEditor
  • FormEditorElement
  • Hooks
  • ManageBlock
  • Model
  • Module
  • NotifyParams
  • PopForm
  • PostOperation
  • PressContactForm
  • QuickContactForm

Interfaces

  • AlterNotify

Class Hooks

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

Methods summary

public static
# markup_form( array $args, Patron\Engine $patron, mixed $template )
public static
# on_operation_get_form( ICanBoogie\Operation\GetFormEvent $event, ICanBoogie\Operation $operation )

Tries to load the form associated with the operation.

Tries to load the form associated with the operation.

This function is a callback for the ICanBoogie\Operation::get_form event.

The OPERATION_POST_ID parameter provides the key of the form active record to load.

If the form is successfully retrieved a callback is added to the "<operation_class>::process" event, it is used to send a notify message with the parameters provided by the form active record. The callback also provides further processing.

At the very end of the process, the Icybee\Modules\Forms\Form::sent event is fired.

Notifying

If defined, the alter_notify method of the form is invoked to alter the notify options. The method is wrapped with the Icybee\Modules\Forms\Form::alter_notify:before and Icybee\Modules\Forms\Form::alter_notify events.

If the is_notify property of the record is true a notify message is sent with the notify options.

Result tracking

The result of the operation using the form is stored in the session under [modules][forms][rc][<record_nid>]. This stored value is used when the form is rendered to choose what to render. For example, if the value is empty, the form is rendered with the before and after messages, otherwise only the complete message is rendered.

Parameters

$event
ICanBoogie\Operation\GetFormEvent
$event
$operation
ICanBoogie\Operation
$operation

Magic methods summary

Autodoc API documentation generated by ApiGen 2.8.0