Overview

Packages

  • blesta
    • app
      • controllers
      • models
    • components
      • auth
        • ldap
        • motp
        • oath
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • events
      • exchange
        • rates
          • currency
            • layer
          • fixer
          • open
            • exchange
              • rates
          • x
            • rates
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
          • perforated
            • invoice
          • quickbooks
            • invoice
          • templates
            • default
      • modules
      • net
        • amazon
          • s3
        • http
        • net
          • geo
            • ip
      • plugins
      • reports
        • aging
          • invoices
        • client
          • data
            • portability
        • custom
          • report
        • invoice
          • creation
        • package
          • revenue
        • tax
          • liability
        • transactions
          • applied
          • received
      • security
      • session
        • cart
      • settingscollection
      • upgrades
        • tasks
      • upload
      • vcard
    • core
      • Automation
        • Tasks
          • Common
          • Task
        • Type
          • Common
          • Cron
      • Pricing
        • ItemComparator
        • MetaItem
        • Modifier
          • Type
            • Description
              • Type
                • Discount
                • Option
                • Service
                • Tax
            • Discount
            • Price
            • Proration
        • Presenter
          • Build
            • Invoice
            • InvoiceData
            • Options
            • Service
            • ServiceChange
            • ServiceData
          • Collection
          • Format
            • Fields
            • Type
              • Discount
              • Item
              • Option
              • Options
              • Package
              • Pricing
              • Service
              • Tax
          • Items
            • Invoice
            • Service
          • Type
      • ServiceProviders
      • Util
        • Captcha
          • Captchas
          • Common
        • Common
          • Traits
        • Events
          • Common
          • Handlers
          • Observers
        • Filters
          • Common
        • GeoIp
        • Input
          • Fields
            • Common
        • Tax
        • Widgets
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
      • widget
        • client
  • minPHP
    • helpers
      • color
      • data
        • structure
  • None
  • PHP

Classes

  • WidgetClient
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class WidgetClient

Simplifies the creation of widgets for the client interface

Html
Extended by Blesta\Core\Util\Widgets\AbstractWidget
Extended by WidgetClient
Package: blesta\helpers\widget\client
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at helpers/widget_client/widget_client.php
Methods summary
public
# __construct( )

Initializes the client widget helper

Initializes the client widget helper

public
# clear( )

Clear this widget, making it ready to produce the next widget

Clear this widget, making it ready to produce the next widget

public
# autoStartBody( boolean $auto_start )

Sets whether or not the body panel should start when WidgetClient::create() is called

Sets whether or not the body panel should start when WidgetClient::create() is called

Parameters

$auto_start
True to auto begin the widget body when WidgetClient::create() is called
public mixed
# create( string $title = null, array $attributes = null, string $render = null )

Creates the widget with the given title and attributes

Creates the widget with the given title and attributes

Parameters

$title
The title to display for this widget
$attributes
An list of attributes to set for this widget's primary container
$render

How to render the widget. Options include:

  • full The entire widget (default)
  • inner_content (everything but the title)

Returns

mixed
An HTML string containing the widget, void if the string is output automatically
public mixed
# end( )

End the widget, closing an loose ends

End the widget, closing an loose ends

Returns

mixed
An HTML string ending the widget, void if the string is output automatically
public mixed
# startBody( boolean $output = true )

Start the widget body

Start the widget body

Parameters

$output
True to output the body, false to return it

Returns

mixed
An HTML string beginning the widget body, void if the string is output automatically
public mixed
# endBody( boolean $output = true )

End the widget body

End the widget body

Parameters

$output
True to output the body, false to return it

Returns

mixed
An HTML string ending the widget body, void if the string is output automatically
public mixed
# startFooter( boolean $output = true )

Start the widget footer

Start the widget footer

Parameters

$output
True to output the footer, false to return it

Returns

mixed
An HTML string beginning the widget footer, void if the string is output automatically
public mixed
# endFooter( boolean $output = true )

End the widget footer

End the widget footer

Parameters

$output
True to output the footer, false to return it

Returns

mixed
An HTML string ending the widget footer, void if the string is output automatically
public string
# buildFilters( boolean $output = true )

Builds the filter form for this widget

Builds the filter form for this widget

Parameters

$output
True to output the body, false to return it

Returns

string
Html for the widget filtering form
Methods inherited from Blesta\Core\Util\Widgets\AbstractWidget
output(), setAjaxFiltering(), setFilterHtml(), setFilterLink(), setFilters(), setHeaderLink(), setLinkButtons(), setLinks(), setOutput(), setStyleSheet(), setWidgetButton()
Properties inherited from Blesta\Core\Util\Widgets\AbstractWidget
$ajax_filtering, $eol, $filter_html, $filter_uri, $filters, $header_link, $link_buttons, $nav, $nav_type, $render, $return_output, $show_filters, $style_sheets, $widget_buttons
Blesta API documentation generated by ApiGen