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 Module

Extends the Module class with the following features:

  • Special handling for the 'edit', 'new' and 'configure' blocks.
  • Inter-users edit lock on records.
ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by ICanBoogie\Module
Extended by Icybee\Module

Direct known subclasses

ICanBoogie\Modules\Taxonomy\Support\Module, Icybee\Modules\Cache\Module, Icybee\Modules\Sites\Module, Icybee\Modules\Taxonomy\Terms\Module, Icybee\Modules\Taxonomy\Vocabulary\Module, Icybee\Modules\Users\Module, Icybee\Modules\Users\Roles\Module, Icybee\Modules\Views\Module, Icybee\Modules\Comments\Module, Icybee\Modules\Dashboard\Module, Icybee\Modules\Editor\Module, Icybee\Modules\I18n\Module, Icybee\Modules\Modules\Module, Icybee\Modules\Nodes\Module, Icybee\Modules\Search\Module, Icybee\Modules\Seo\Module

Indirect known subclasses

Icybee\Modules\Articles\Module, Icybee\Modules\Contents\Module, Icybee\Modules\Files\Module, Icybee\Modules\Forms\Module, Icybee\Modules\Images\Module, Icybee\Modules\Members\Module, Icybee\Modules\Pages\Module

Namespace: Icybee
Located at vendor/icybee/core/lib/module/module.php

Methods summary

protected array[string]array
# lazy_get_views( )

Returns the views defined by the module.

Returns the views defined by the module.

Each _key/value_ pair defines a view, _key_ is its type, _value_ its definition:

  • (string) title: Title of the view. The title of the view is localized use the

"<module_flat_id>.view" scope.

Returns

array[string]array
public mixed
# getBlock( string $name )

Get a block.

Get a block.

Parameters

$name
string
$name The name of the block to get.

Returns

mixed
Depends on the implementation. Should return a string or object that can be stringified.

Throws

Exception
if the block is not defined.

Overrides

ICanBoogie\Module::getBlock
protected
# resolve_block_class( mixed $name )
public array|false
# lock_entry( integer $key, mixed & $lock = null )

Locks an activerecord.

Locks an activerecord.

Parameters

$key
integer
$key
$lock

Returns

array|false

Throws

Exception
public
# unlock_entry( mixed $key )

Methods inherited from ICanBoogie\Module

__construct(), __toString(), get_descriptor(), get_flat_id(), get_id(), get_model(), get_parent(), get_path(), get_title(), install(), is_installed(), model(), resolve_model_tags(), uninstall()

Methods inherited from ICanBoogie\Object

from(), resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Constants summary

string OPERATION_CONFIG 'config'
#

Constants inherited from ICanBoogie\Module

OPERATION_DELETE, OPERATION_SAVE, PERMISSION_ACCESS, PERMISSION_ADMINISTER, PERMISSION_CREATE, PERMISSION_MAINTAIN, PERMISSION_MANAGE, PERMISSION_NONE, T_CATEGORY, T_CLASS, T_DESCRIPTION, T_DISABLED, T_EXTENDS, T_ID, T_MODELS, T_NAMESPACE, T_PATH, T_PERMISSION, T_PERMISSIONS, T_REQUIRED, T_REQUIRES, T_TITLE, T_VERSION, T_WEIGHT

Properties summary

Properties inherited from ICanBoogie\Module

$descriptor, $models

Magic properties inherited from ICanBoogie\Module

$description, $flat_id, $id, $model, $parent, $path, $title

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0