Class lispa\amos\core\components\AmosView
| Inheritance | lispa\amos\core\components\AmosView » yii\web\View » yii\base\View » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\base\Configurable |
Class AmosView
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $assetBundles | yii\web\AssetBundle[] | List of the registered asset bundles. | yii\web\View |
| $assetManager | yii\web\AssetManager | The asset manager. | yii\web\View |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $blocks | array | A list of named output blocks. | yii\base\View |
| $cacheStack | array | A list of currently active fragment cache widgets. | yii\base\View |
| $context | yii\base\ViewContextInterface | The context under which the renderFile() method is being invoked. | yii\base\View |
| $css | array | The registered CSS code blocks. | yii\web\View |
| $cssFiles | array | The registered CSS files. | yii\web\View |
| $defaultExtension | string | The default view file extension. | yii\base\View |
| $dynamicPlaceholders | array | A list of placeholders for embedding dynamic contents. | yii\base\View |
| $js | array | The registered JS code blocks | yii\web\View |
| $jsFiles | array | The registered JS files. | yii\web\View |
| $linkTags | array | The registered link tags. | yii\web\View |
| $metaTags | array | The registered meta tags. | yii\web\View |
| $params | mixed | Custom parameters that are shared among view templates. | yii\base\View |
| $renderers | array | A list of available renderers indexed by their corresponding supported file extensions. | yii\base\View |
| $theme | yii\base\Theme|array|string | The theme object or the configuration for creating the theme object. | yii\base\View |
| $title | string | The page title | yii\web\View |
| $viewFile | string|boolean | The view file currently being rendered. | yii\base\View |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\Object |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| addDynamicPlaceholder() | Adds a placeholder for dynamic content. | yii\base\View |
| afterRender() | This method is invoked right after renderFile() renders a view file. | yii\base\View |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRender() | This method is invoked right before renderFile() renders a view file. | yii\base\View |
| beginBlock() | Begins recording a block. | yii\base\View |
| beginBody() | Marks the beginning of an HTML body section. | yii\web\View |
| beginCache() | Begins fragment caching. | yii\base\View |
| beginContent() | Begins the rendering of content that is to be decorated by the specified view. | yii\base\View |
| beginPage() | Marks the beginning of a page. | yii\base\View |
| beginViewContent() | Marks the beginning of the HTML content section. | lispa\amos\core\components\AmosView |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| clear() | Clears up the registered meta tags, link tags, css/js scripts and files. | yii\web\View |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| endBlock() | Ends recording a block. | yii\base\View |
| endBody() | Marks the ending of an HTML body section. | yii\web\View |
| endCache() | Ends fragment caching. | yii\base\View |
| endContent() | Ends the rendering of content. | yii\base\View |
| endPage() | Marks the ending of an HTML page. | yii\web\View |
| endViewContent() | Marks the ending of the HTML content section. | lispa\amos\core\components\AmosView |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| evaluateDynamicContent() | Evaluates the given PHP statements. | yii\base\View |
| getAssetManager() | Registers the asset manager being used by this view object. | yii\web\View |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getViewFile() | yii\base\View | |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| head() | Marks the position of an HTML head section. | yii\web\View |
| init() | Initializes the view component. | yii\base\View |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| registerAssetBundle() | Registers the named asset bundle. | yii\web\View |
| registerCss() | Registers a CSS code block. | yii\web\View |
| registerCssFile() | Registers a CSS file. | yii\web\View |
| registerJs() | Registers a JS code block. | yii\web\View |
| registerJsFile() | Registers a JS file. | yii\web\View |
| registerLinkTag() | Registers a link tag. | yii\web\View |
| registerMetaTag() | Registers a meta tag. | yii\web\View |
| render() | Renders a view. | yii\base\View |
| renderAjax() | Renders a view in response to an AJAX request. | yii\web\View |
| renderDynamic() | Renders dynamic content returned by the given PHP statements. | yii\base\View |
| renderFile() | Renders a view file. | yii\base\View |
| renderPhpFile() | Renders a view file as a PHP script. | yii\base\View |
| setAssetManager() | Sets the asset manager. | yii\web\View |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| findViewFile() | Finds the view file based on the given view name. | yii\base\View |
| registerAssetFiles() | Registers all files provided by an asset bundle including depending bundles files. | yii\web\View |
| renderBodyBeginHtml() | Renders the content to be inserted at the beginning of the body section. | yii\web\View |
| renderBodyEndHtml() | Renders the content to be inserted at the end of the body section. | yii\web\View |
| renderHeadHtml() | Renders the content to be inserted in the head section. | yii\web\View |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| AFTER_RENDER_CONTENT | \lispa\amos\core\components\Event | An event that is triggered by endViewContent(). | lispa\amos\core\components\AmosView |
| BEFORE_RENDER_CONTENT | \lispa\amos\core\components\Event | An event that is triggered by beginViewContent(). | lispa\amos\core\components\AmosView |
| EVENT_AFTER_RENDER | yii\base\ViewEvent | An event that is triggered by renderFile() right after it renders a view file. | yii\base\View |
| EVENT_BEFORE_RENDER | yii\base\ViewEvent | An event that is triggered by renderFile() right before it renders a view file. | yii\base\View |
| EVENT_BEGIN_BODY | \yii\web\Event | An event that is triggered by beginBody(). | yii\web\View |
| EVENT_BEGIN_PAGE | yii\base\Event | An event that is triggered by beginPage(). | yii\base\View |
| EVENT_END_BODY | \yii\web\Event | An event that is triggered by endBody(). | yii\web\View |
| EVENT_END_PAGE | yii\base\Event | An event that is triggered by endPage(). | yii\base\View |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| PH_BODY_BEGIN | '' | This is internally used as the placeholder for receiving the content registered for the beginning of the body section. | yii\web\View |
| PH_BODY_END | '' | This is internally used as the placeholder for receiving the content registered for the end of the body section. | yii\web\View |
| PH_HEAD | ' ' | This is internally used as the placeholder for receiving the content registered for the head section. | yii\web\View |
| POS_BEGIN | 2 | The location of registered JavaScript code block or files. This means the location is at the beginning of the body section. | yii\web\View |
| POS_END | 3 | The location of registered JavaScript code block or files. This means the location is at the end of the body section. | yii\web\View |
| POS_HEAD | 1 | The location of registered JavaScript code block or files. This means the location is in the head section. | yii\web\View |
| POS_LOAD | 5 | The location of registered JavaScript code block.
This means the JavaScript code block will be enclosed within jQuery(window).load(). |
yii\web\View |
| POS_READY | 4 | The location of registered JavaScript code block.
This means the JavaScript code block will be enclosed within jQuery(document).ready(). |
yii\web\View |
Method Details
Marks the beginning of the HTML content section.
| public void beginViewContent ( ) |
Marks the ending of the HTML content section.
| public void endViewContent ( ) |
Event Details
An event that is triggered by endViewContent().
An event that is triggered by beginViewContent().