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

  • AdjustImage
  • AdjustThumbnail
  • EditBlock
  • GalleryBlock
  • GalleryController
  • Hooks
  • Image
  • ImageUpload
  • ManageBlock
  • Model
  • Module
  • NodeRelation
  • PopImage
  • PopOrUploadImage
  • SaveOperation
  • Thumbnail
  • ThumbnailDecorator
  • ThumbnailOperation
  • UploadImage
  • UploadOperation

Class Hooks

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

Methods summary

public static
# on_contents_provider_alter_result( Icybee\Modules\Views\ActiveRecordProvider\AlterResultEvent $event, Icybee\Modules\Contents\ViewProvider $provider )

Finds the images associated with the records provided to the view.

Finds the images associated with the records provided to the view.

In order to avoid each record of the view to load its own image during rendering, we load them all and update the records.

The method is canceled if there is only 3 records because bunch loading takes 3 database requests.

TODO-20120713: Use an event to load images when the first image property is accessed.

Parameters

$event
Icybee\Modules\Views\ActiveRecordProvider\AlterResultEvent
$event
$provider
Icybee\Modules\Contents\ViewProvider
$provider
public static
# on_contents_editblock_alter_children( ICanBoogie\Event $event, Icybee\Modules\Nodes\EditBlock $block )

Adds control for the image associated with the content.

Adds control for the image associated with the content.

Parameters

$event
ICanBoogie\Event
$event
$block
Icybee\Modules\Nodes\EditBlock
$block
public static
# on_contents_configblock_alter_children( ICanBoogie\Event $event, Icybee\Modules\Contents\ConfigBlock $block )

Alters the config block of contents modules with controls for the associated image.

Alters the config block of contents modules with controls for the associated image.

Parameters

$event
ICanBoogie\Event
$event
$block
Icybee\Modules\Contents\ConfigBlock
$block
public static
# on_nodes_save( ICanBoogie\Event $event, Icybee\Modules\Nodes\SaveOperation $operation )
public static
# before_contents_config( ICanBoogie\Event $event, Icybee\Modules\Contents\ConfigOperation $operation )
public static
# textmark_images_reference( array $args, Textmark_Parser $textmark, array $matches )
public static
# on_page_controller_render( Icybee\Modules\Pages\PageController\RenderEvent $event, Icybee\Modules\Pages\PageController $target )

Adds assets to support lightbox links.

Adds assets to support lightbox links.

This function is a callback for the Icybee\Modules\Pages\PageController::render event.

Parameters

$event
ICanBoogie\Event
$event
$target
public static
# on_alter_css_class_names( Brickrouge\AlterCSSClassNamesEvent $event, Icybee\Modules\Nodes\Node $node )
public static
# on_manageblock_alter_rendered_cells( Icybee\ManageBlock\AlterRenderedCellsEvent $event, Icybee\Modules\Contents\ManageBlock $target )

Decorates title cell of the record with an associated image with an icon.

Decorates title cell of the record with an associated image with an icon.

Parameters

$event
Icybee\ManageBlock\AlterRenderedCellsEvent
$event
$target
Icybee\Modules\Contents\ManageBlock
$target
public static Icybee\Modules\Images\Image|null
# prototype_get_image( Icybee\Modules\Nodes\Node $node )

Returns the image associated with the node.

Returns the image associated with the node.

Parameters

$node
Icybee\Modules\Nodes\Node
$node

Returns

Icybee\Modules\Images\Image|null
public static string
# prototype_thumbnail( Icybee\Modules\Images\Image $record, string $version, mixed $additionnal_options = null )

Callback for the thumbnail() method added to the active records of the "images" module.

Callback for the thumbnail() method added to the active records of the "images" module.

Parameters

$record
Icybee\Modules\Images\Image
$ar An active record of the "images" module.
$version
string
$version The version used to create the thumbnail, or a number of options defined as CSS properties. e.g. 'w:300;h=200'.
$additionnal_options

Returns

string
The URL of the thumbnail.
public static string
# prototype_get_thumbnail( Icybee\Modules\Images\Image $record )

Callback for the thumbnail getter added to the active records of the "images" module.

Callback for the thumbnail getter added to the active records of the "images" module.

The thumbnail is created using options of the 'primary' version.

Parameters

$record
Icybee\Modules\Images\Image
$ar An active record of the "images" module.

Returns

string
The URL of the thumbnail.

Magic methods summary

Autodoc API documentation generated by ApiGen 2.8.0