Blesta
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • blesta
    • app
      • components
        • events
          • default
      • controllers
      • models
    • components
      • auth
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • exchange
        • rates
          • foxrate
          • google
            • finance
          • yahoo
            • finance
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
      • json
      • modules
      • net
        • http
        • net
          • amazon
            • s3
          • geo
            • ip
      • plugins
      • recaptcha
      • security
      • session
        • cart
      • settingscollection
      • upgrades
      • upload
      • vcard
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
  • com
    • tecnick
      • tcpdf
        • blesta
          • components
            • invoice
              • templates
                • quickbooks
                  • invoice
                • templates
                  • default
  • Crypt
    • AES
    • DES
    • Hash
    • Random
    • RC4
    • Rijndael
    • RSA
    • TerraDES
  • File
    • ANSI
    • ASN1
    • X509
  • Math
    • BigInteger
  • minPHP
    • components
      • input
      • record
    • helpers
      • color
      • data
        • structure
      • date
      • html
      • xml
    • lib
  • Net
    • SFTP
    • SSH1
    • SSH2
  • None
  • PHP
  • PHPMailer
  • Services
    • JSON
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • EventObject
  • Events

Class EventObject

Event Object

Holds event data regarding a single event, and is passed between the dispatcher and the listener

Package: blesta\app\components\events
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/events/event_object.php

Methods summary

public
# __construct( string $event_name, array $params = null )

Creates a new EventObject

Creates a new EventObject

Parameters

$event_name
string
$event_name The name of the event
$params
array
$params An array of parameters to be held by this event
public string
# getName( )

Returns the name of this event

Returns the name of this event

Returns

string
The name of the event
public array
# getParams( )

Returns the parameters set for this event

Returns the parameters set for this event

Returns

array
The parameters for the event
public mixed
# getReturnVal( )

Returns the return value set for this event

Returns the return value set for this event

Returns

mixed
The return value for the event
public
# setReturnVal( mixed $return_val )

Sets the return value for this event

Sets the return value for this event

Parameters

$return_val
mixed
$return_val The return value for the event

Magic methods summary

Properties summary

protected string $event_name
#

$event_name The name of the event

$event_name The name of the event

protected array $params
#

$params An array of parameters held by this event

$params An array of parameters held by this event

protected mixed $return_val
#

$return_val The return value (if any) from the event listener

$return_val The return value (if any) from the event listener

Blesta API documentation generated by ApiGen 2.8.0