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

  • EmailColumn
  • IsActivatedColumn
  • LoggedAtColumn
  • RolesColumn
  • UserColumn
  • UsernameColumn

Class UserColumn

Representation of a _user_ column.

This column can be used to represent the users associated to records.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by Icybee\ManageBlock\Column
Extended by Icybee\Modules\Users\ManageBlock\UserColumn
Namespace: Icybee\Modules\Users\ManageBlock
Located at vendor/icanboogie-modules/users/lib/blocks/manage.php

Methods summary

public
# __construct( Icybee\ManageBlock $manager, mixed $id, array $options = [] )

Initializes the $resolved_user_names property.

Initializes the $resolved_user_names property.

Overrides

Icybee\ManageBlock\Column::__construct
public ICanBoogie\ActiveRecord\Query
# alter_query_with_filter( ICanBoogie\ActiveRecord\Query $query, mixed $filter_value )

Alters the query according to the filter value specified.

Alters the query according to the filter value specified.

The method does a simple {$this->id} = {$filter_value}, subclasses might want to override the method according to the kind of filter they provide.

Parameters

$query
ICanBoogie\ActiveRecord\Query
$query
$filter_value
mixed
$filter_value

Returns

ICanBoogie\ActiveRecord\Query

Overrides

Icybee\ManageBlock\Column::alter_query_with_filter
public ICanBoogie\ActiveRecord\Query
# alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, integer $order_direction )

Alters the ORDER clause of the query according to the column identifier and the order direction.

Alters the ORDER clause of the query according to the column identifier and the order direction.

The implementation of the method is simple, subclasses might want to override the method to support complexer ordering.

Parameters

$query
ICanBoogie\ActiveRecord\Query
$query
$order_direction
integer
$order_direction

Returns

ICanBoogie\ActiveRecord\Query

Overrides

Icybee\ManageBlock\Column::alter_query_with_order
public array[]ActiveRecord
# alter_records( array $records )

Includes the users associated with the records.

Includes the users associated with the records.

Parameters

$records
array
$records

Returns

array[]ActiveRecord

Overrides

Icybee\ManageBlock\Column::alter_records
public array|null
# get_options( )

Returns the options available for the filter.

Returns the options available for the filter.

Returns

array|null

Overrides

Icybee\ManageBlock\Column::get_options
public string
# render_cell( mixed $record )

Renders a column cell.

Renders a column cell.

Parameters

$record
mixed
$record

Returns

string

Overrides

Icybee\ManageBlock\Column::render_cell

Methods inherited from Icybee\ManageBlock\Column

add_assets(), alter_filters(), get_filter_value(), get_is_filtering(), get_label(), modify_options(), render_header(), render_options(), resolve_default_values(), set_filtering(), set_label(), t()

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\Column

ORDER_ASC, ORDER_DESC

Properties summary

Properties inherited from Icybee\ManageBlock\Column

$cell_renderer, $class, $default_order, $discreet, $filters, $header_renderer, $id, $manager, $order, $orderable, $reset, $title

Magic properties inherited from Icybee\ManageBlock\Column

$filter_value, $is_filtering

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0