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 BlockController

Returns a decorated block.

The decorate_flags param is used to specify how the block is to be decorated. The following flags are defined:

  • Icybee\BlockController::DECORATE_WITH_BLOCK: Decorate the component with a Icybee\BlockDecorator instance.
  • Icybee\BlockController::DECORATE_WITH_ADMIN: Decorate the component with a Icybee\AdminDecorator instance.
  • Icybee\BlockController::DECORATE_WITH_DOCUMENT Decorate the component with a Icybee\DocumentDecorator instance.
ICanBoogie\Routing\Controller
Extended by Icybee\BlockController

Direct known subclasses

Icybee\DeleteController, Icybee\EditController, Icybee\Modules\Dashboard\BlockController, Icybee\Modules\Images\GalleryController, Icybee\Modules\Modules\ManageController, Icybee\Modules\Users\ProfileController

Namespace: Icybee
Located at vendor/icybee/icybee/lib/controllers/block.php

Methods summary

public
# __construct( ICanBoogie\Route $route )

Initializes the ICanBoogie\Routing\Controller::$route property.

Initializes the ICanBoogie\Routing\Controller::$route property.

Parameters

$route
ICanBoogie\Route
$route The route to control.

Overrides

ICanBoogie\Routing\Controller::__construct
public ICanBoogie\HTTP\Response
# __invoke( ICanBoogie\HTTP\Request $request )

If the decorate_flags param is defined the Icybee\BlockController::$decorate_flags property is updated.

If the decorate_flags param is defined the Icybee\BlockController::$decorate_flags property is updated.

Parameters

$request
ICanBoogie\HTTP\Request
$request

Returns

ICanBoogie\HTTP\Response
protected
# control( )

Controls the user access to the block.

Controls the user access to the block.

Throws

ICanBoogie\PermissionRequired
if the user doesn't have at least the ICanBoogie\Module::PERMISSION_ACCESS permission.
protected
# control_permission( mixed $permission )
protected mixed
# get_component( )

Returns the component.

Returns the component.

The getBlock() method of the target module is used to retrieve the component.

Returns

mixed
protected mixed
# decorate( mixed $component, integer $flags )

Decorates the component.

Decorates the component.

Parameters

$component
mixed
$component The component to decorate.
$flags
integer
$flags The flags describing how the component is to be decorated.

Returns

mixed
protected Icybee\BlockDecorator
# decorate_with_block( mixed $component )

Decorate a component with an instance of Icybee\BlockDecorator.

Decorate a component with an instance of Icybee\BlockDecorator.

Parameters

$component
mixed
$component

Returns

Icybee\BlockDecorator
protected Icybee\AdminDecorator
# decorate_with_admin( mixed $component )

Decorate a component with an instance of Icybee\AdminDecorator.

Decorate a component with an instance of Icybee\AdminDecorator.

Parameters

$component
mixed
$component

Returns

Icybee\AdminDecorator
protected Icybee\DocumentDecorator
# decorate_with_document( mixed $component )

Decorates a component with an instance of Icybee\DocumentDecorator.

Decorates a component with an instance of Icybee\DocumentDecorator.

Parameters

$component
mixed
$component

Returns

Icybee\DocumentDecorator

Magic methods summary

Constants summary

integer DECORATE_WITH_BLOCK 1
#
integer DECORATE_WITH_ADMIN 2
#
integer DECORATE_WITH_DOCUMENT 4
#

Properties summary

protected mixed $decorate_flags
#
protected mixed $request
#
protected mixed $block_name
#

Properties inherited from ICanBoogie\Routing\Controller

$route

Autodoc API documentation generated by ApiGen 2.8.0