Hawk - PHP documentation
  • Namespace
  • Class
  • Tree

Namespaces

  • Hawk
    • View
      • Plugins

Classes

  • App
  • ButtonInput
  • Cache
  • CheckboxInput
  • ColorInput
  • Conf
  • Controller
  • Crypto
  • DatabaseSessionHandler
  • DatetimeInput
  • DB
  • DBExample
  • DeleteInput
  • Dialogbox
  • EmailInput
  • ErrorHandler
  • Event
  • FileInput
  • FileSystem
  • FloatInput
  • Form
  • FormFieldset
  • FormInput
  • GenericModel
  • GifImage
  • HawkApi
  • HawkUpdater
  • HiddenInput
  • HtmlInput
  • HTTPRequest
  • Icon
  • Image
  • IntegerInput
  • ItemList
  • ItemListField
  • JpegImage
  • Lang
  • Language
  • LeftSidebarTab
  • Less
  • Logger
  • Mail
  • MenuItem
  • Model
  • NoSidebarTab
  • NumberInput
  • ObjectInput
  • Option
  • Panel
  • PasswordInput
  • Permission
  • Plugin
  • PluginInstaller
  • PngImage
  • ProfileQuestion
  • ProfileQuestionValue
  • RadioInput
  • Request
  • Response
  • RightSidebarTab
  • Role
  • RolePermission
  • Route
  • Router
  • SelectInput
  • Session
  • Singleton
  • SubmitInput
  • Tabs
  • TextareaInput
  • TextInput
  • Theme
  • TimeInput
  • Upload
  • User
  • View
  • ViewPlugin
  • Widget
  • WysiwygInput

Traits

  • Utils

Exceptions

  • AppStopException
  • DBExampleException
  • DBException
  • FileSystemException
  • HawkApiException
  • ImageException
  • MailException
  • UploadException
  • ViewException

Class ViewPlugin

This abstract class defines the view plugins. It must be inherited by any class that defines any view plugin. This class is called when, in a view, you write something like that : {pluginName param="value1" param2="{$variable}" }

Hawk\ViewPlugin uses Hawk\Utils

Direct known subclasses

Hawk\View\Plugins\Accordion, Hawk\View\Plugins\Button, Hawk\View\Plugins\Form, Hawk\View\Plugins\Icon, Hawk\View\Plugins\Import, Hawk\View\Plugins\Panel, Hawk\View\Plugins\Tabs, Hawk\View\Plugins\Text, Hawk\View\Plugins\Uri, Hawk\View\Plugins\Widget

Abstract
Namespace: Hawk
Package: View\Plugins
Located at ViewPlugin.php

Methods summary

public
# __construct( string $viewFile, array $viewData = array(), array $params = array() )

Contructor

Contructor

Parameters

$viewFile
The view file that instances this plugin
$viewData
The data injected in the view
$params
The instance parameters
abstract public string
# display( )

Display the plugin. This abstract method must be overriden in each inherited class and return the HTML content corresponding to the instance

Display the plugin. This abstract method must be overriden in each inherited class and return the HTML content corresponding to the instance

Returns

string
The HTML result to display
public string
# __toString( )

Display the plugin. This abstract method must be overriden in each inherited class and return the HTML content corresponding to the instance

Display the plugin. This abstract method must be overriden in each inherited class and return the HTML content corresponding to the instance

Returns

string
The HTML result to display

Methods used from Hawk\Utils

debug(), getSerializedVersion(), map()

Properties summary

protected string $viewFile

The filename of the view that calls the plugin

The filename of the view that calls the plugin

#
protected array $viewData

The data in the parent view that calls the plugin

The data in the parent view that calls the plugin

#
protected array $params

The plugin instance parameters

The plugin instance parameters

#
Hawk - PHP documentation API documentation generated by ApiGen