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

  • Blueprint
  • BlueprintNode
  • BreadcrumbElement
  • Content
  • ContentModel
  • CopyOperation
  • DeleteOperation
  • EditBlock
  • ExportBlock
  • ExportOperation
  • Hooks
  • ImportOperation
  • LanguagesElement
  • ListView
  • ManageBlock
  • Model
  • Module
  • NavigationBranchElement
  • NavigationElement
  • NavigationExcludeOperation
  • NavigationIncludeOperation
  • Page
  • PageController
  • PopPage
  • PopTemplate
  • QueryOperationOperation
  • SaveOperation
  • TemplateEditorsOperation
  • UpdateTreeOperation

Class ManageBlock

A block to manage nodes.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface
Extended by Icybee\ManageBlock
Extended by Icybee\Modules\Nodes\ManageBlock
Extended by Icybee\Modules\Pages\ManageBlock
Namespace: Icybee\Modules\Pages
Located at vendor/icanboogie-modules/pages/lib/blocks/manage.php

Methods summary

protected static
# add_assets( Brickrouge\Document $document )

Adds assets to the document.

Adds assets to the document.

Parameters

$document
Document
$document

Overrides

Icybee\Modules\Nodes\ManageBlock::add_assets
public
# __construct( Icybee\Modules\Pages\Module $module, array $attributes = array() )

Parameters

$module
string
$type Type of the element, it can be one of the custom types (TYPE_*) or any HTML type.
$attributes
array
$attributes HTML and custom attributes.

Overrides

Icybee\Modules\Nodes\ManageBlock::__construct
protected array[string]mixed
# get_available_columns( )

Adds the following columns:

Adds the following columns:

  • title: An instance of Icybee\Modules\Pages\ManageBlock\TitleColumn.
  • url: An instance of Icybee\Modules\Pages\ManageBlock\URLColumn.
  • is_navigation_excluded: An instance of Icybee\Modules\Pages\ManageBlock\IsNavigationExcluded.

Returns

array[string]mixed

Overrides

Icybee\Modules\Nodes\ManageBlock::get_available_columns
protected array[string]mixed
# get_available_jobs( )

Adds the following jobs:

Adds the following jobs:

  • copy: Copy the selected nodes.

Returns

array[string]mixed

Overrides

Icybee\Modules\Nodes\ManageBlock::get_available_jobs
protected Brickrouge\Element\null
# render_jobs( array $jobs )

Renders jobs as an HTML element.

Renders jobs as an HTML element.

Parameters

$jobs
array
$jobs

Returns

Brickrouge\Element\null

Overrides

Icybee\ManageBlock::render_jobs
protected
# get_mode( )
protected array
# update_options( Icybee\ManageBlock\Options $options, array $modifiers )

Overrides the method to add support for expanded tree nodes.

Overrides the method to add support for expanded tree nodes.

The methods adds the expanded option which is used to store expanded tree nodes. The option is initialized with first level pages.

Parameters

$options
array
$options Previous options.
$modifiers
array
$modifiers Options modifiers.

Returns

array
Updated options.

Overrides

Icybee\ManageBlock::update_options
protected
# fetch_records( ICanBoogie\ActiveRecord\Query $query )

Fetches the records according to the query and the display mode.

Fetches the records according to the query and the display mode.

The method is overrode if the dispay mode is tree in which case the records are fetched accroding to their relashion and the _expand_ state of their parent.

Parameters

$query
ICanBoogie\ActiveRecord\Query
$query

Overrides

Icybee\ManageBlock::fetch_records
protected string
# render_controls( )

Replaces the limiter by a simple count if the records are displayed as a tree.

Replaces the limiter by a simple count if the records are displayed as a tree.

Returns

string

Overrides

Icybee\ManageBlock::render_controls
protected array[]Element
# render_rows( array $rows )

Renders the specified rows.

Renders the specified rows.

The rows are rendered as an array of Element instances representing TR elements.

Parameters

$rows
array
$rows

Returns

array[]Element

Overrides

Icybee\ManageBlock::render_rows

Methods inherited from Icybee\Modules\Nodes\ManageBlock

__deprecated__render_cell_title(), alter_query()

Methods inherited from Icybee\ManageBlock

alter_query_with_range(), alter_query_with_search(), alter_records(), apply_discreet_filter(), columns_to_rows(), get_columns(), get_is_filtering(), get_jobs(), get_model(), get_options(), get_primary_key(), get_t(), is_filtering(), render(), render_body(), render_column(), render_columns_cells(), render_empty_body(), render_foot(), render_head(), render_inner_html(), render_outer_html(), render_search(), resolve_columns(), resolve_jobs(), resolve_options(), resolve_order(), resolve_query(), update_filters()

Methods inherited from Brickrouge\Element

__toString(), add_class(), adopt(), alter_attributes(), alter_class_names(), alter_dataset(), auto_element_id(), decorate(), decorate_with_description(), decorate_with_inline_help(), decorate_with_label(), decorate_with_legend(), getIterator(), get_attributes(), get_class(), get_dataset(), get_ordered_children(), handle_assets(), has_class(), lazy_get_id(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove_class(), render_attributes(), render_child(), render_children(), render_class(), render_dataset(), render_inner_html_for_checkbox_group(), render_inner_html_for_radio_group(), render_inner_html_for_select(), render_inner_html_for_textarea(), set_class(), set_dataset(), validate()

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

Constants inherited from Icybee\ManageBlock

DISCREET_PLACEHOLDER, ORDER_ASC, ORDER_DESC, T_BLOCK, T_COLUMNS_ORDER, T_ORDER_BY

Constants inherited from Brickrouge\Element

CHILDREN, DEFAULT_VALUE, DESCRIPTION, GROUP, GROUPS, INLINE_HELP, INNER_HTML, LABEL, LABEL_MISSING, LABEL_POSITION, LEGEND, OPTIONS, OPTIONS_DISABLED, REQUIRED, STATE, TYPE_CHECKBOX, TYPE_CHECKBOX_GROUP, TYPE_RADIO, TYPE_RADIO_GROUP, VALIDATOR, VALIDATOR_OPTIONS, WEIGHT, WIDGET_CONSTRUCTOR

Properties summary

protected string $mode
#
protected mixed $expand_highlight
#

Properties inherited from Icybee\ManageBlock

$browse, $columns, $count, $jobs, $model, $module, $options, $records, $t

Properties inherited from Brickrouge\Element

$auto_element_id, $children, $class_names, $inner_html, $tag_name, $tags, $type

Magic properties inherited from Icybee\ManageBlock

$is_filtering, $model, $options, $primary_key, $t

Magic properties inherited from Brickrouge\Element

$class, $dataset, $id

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0