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

  • ActiveRecord
  • Cache
  • Configs
  • Core
  • DateTime
  • Debug
  • DeleteOperation
  • Errors
  • Event
  • EventHook
  • Events
  • FileCache
  • FormattedString
  • Helpers
  • I18n
  • Image
  • Inflections
  • Inflector
  • Models
  • Module
  • Modules
  • Object
  • Operation
  • PingOperation
  • Prototype
  • Route
  • Routes
  • SaveOperation
  • Session
  • TimeZone
  • TimeZoneLocation
  • Uploaded
  • Vars
  • VarsIterator

Interfaces

  • StorageInterface
  • ToArray
  • ToArrayRecursive

Traits

  • PrototypeTrait
  • ToArrayRecursiveTrait

Exceptions

  • AlreadyAuthenticated
  • AuthenticationRequired
  • Exception
  • ModuleConstructorMissing
  • ModuleIsDisabled
  • ModuleNotDefined
  • OffsetError
  • OffsetNotDefined
  • OffsetNotReadable
  • OffsetNotWritable
  • PermissionRequired
  • PropertyError
  • PropertyIsReserved
  • PropertyNotDefined
  • PropertyNotReadable
  • PropertyNotWritable
  • RouteNotDefined
  • SecurityException

Constants

  • TOKEN_ALPHA
  • TOKEN_ALPHA_UPCASE
  • TOKEN_NUMERIC
  • TOKEN_SYMBOL
  • TOKEN_SYMBOL_WIDE

Functions

  • array_flatten
  • array_insert
  • array_merge_recursive
  • camelize
  • capitalize
  • downcase
  • dump
  • escape
  • escape_all
  • exact_array_merge_recursive
  • excerpt
  • format
  • generate_token
  • generate_token_wide
  • generate_v4_uuid
  • get_autoconfig
  • humanize
  • hyphenate
  • log
  • log_error
  • log_info
  • log_success
  • log_time
  • normalize
  • normalize_namespace_part
  • normalize_url_path
  • pbkdf2
  • pluralize
  • remove_accents
  • shorten
  • singularize
  • sort_by_weight
  • stable_sort
  • strip_root
  • titleize
  • unaccent_compare
  • unaccent_compare_ci
  • underscore
  • upcase

Class Prototype

Subclasses of the ICanBoogie\Object class are associated with a prototype, which can be used to add methods as well as getters and setters to classes.

When using the ICanBoogie framework, methods can be defined using the "hooks" config and the "prototypes" namespace:

<?php

return [

    'prototypes' => [

        'Icybee\Modules\Pages\Page::my_additional_method' => 'MyHookClass::my_additional_method',
        'Icybee\Modules\Pages\Page::lazy_get_my_property' => 'MyHookClass::lazy_get_my_property'

    ]
];
ICanBoogie\Prototype implements ArrayAccess, IteratorAggregate
Namespace: ICanBoogie
Located at vendor/icanboogie/prototype/lib/prototype.php

Methods summary

public static ICanBoogie\Prototype
# from( string|object $class )

Returns the prototype associated with the specified class or object.

Returns the prototype associated with the specified class or object.

Parameters

$class
string|object
$class Class name or instance.

Returns

ICanBoogie\Prototype
public static
# configure( array $config )
protected
# __construct( string $class )

Creates a prototype for the specified class.

Creates a prototype for the specified class.

Parameters

$class
string
$class
protected array[string]callable
# get_consolidated_methods( )

Consolidate the methods of the prototype.

Consolidate the methods of the prototype.

The method creates a single array from the prototype methods and those of its parents.

Returns

array[string]callable
protected
# revoke_consolidated_methods( )

Revokes the consolidated methods of the prototype.

Revokes the consolidated methods of the prototype.

The method must be invoked when prototype methods are modified.

public
# offsetSet( string $method, callable $callback )

Adds or replaces the specified method of the prototype.

Adds or replaces the specified method of the prototype.

Parameters

$method
string
$method The name of the method.
$callback
callable
$callback

Implementation of

ArrayAccess::offsetSet()
public
# offsetUnset( string $method )

Removed the specified method from the prototype.

Removed the specified method from the prototype.

Parameters

$method
string
$method The name of the method.

Implementation of

ArrayAccess::offsetUnset()
public boolean
# offsetExists( string $method )

Checks if the prototype defines the specified method.

Checks if the prototype defines the specified method.

Parameters

$method
string
$method The name of the method.

Returns

boolean

Implementation of

ArrayAccess::offsetExists()
public callable
# offsetGet( string $method )

Returns the callback associated with the specified method.

Returns the callback associated with the specified method.

Parameters

$method
string
$method The name of the method.

Returns

callable

Throws

ICanBoogie\Prototype\MethodNotDefined
if the method is not defined.

Implementation of

ArrayAccess::offsetGet()
public
# getIterator( )

Returns an iterator for the prototype methods.

Returns an iterator for the prototype methods.

See

IteratorAggregate::getIterator()

Implementation of

IteratorAggregate::getIterator()

Magic methods summary

Properties summary

protected static array[string]Prototype $prototypes
#

Prototypes built per class.

Prototypes built per class.

protected static array[string]callable $pool
#

Pool of prototype methods per class.

Pool of prototype methods per class.

protected string $class
#

Class associated with the prototype.

Class associated with the prototype.

protected ICanBoogie\Prototype $parent
#

Parent prototype.

Parent prototype.

protected array[string]callable $methods
#

Methods defined by the prototype.

Methods defined by the prototype.

protected array[string]callable $consolidated_methods
#

Methods defined by the prototypes chain.

Methods defined by the prototypes chain.

Autodoc API documentation generated by ApiGen 2.8.0