Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Orders
    • Serializers
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Interfaces
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AdminHttpViewController
  • AdminLayoutHttpControllerResponse
  • HttpContextReader
  • HttpDispatcher
  • HttpResponseProcessor
  • HttpService
  • HttpViewController
  • HttpViewControllerRegistry

Class AdminLayoutHttpControllerResponse

Class AdminLayoutHttpControllerResponse

This class will be used for rendering the new Admin pages which must be explicitly written in templates. These templates can extend any of the existing admin layouts by themselves.

Child controllers can you the "init" method to initialize their dependencies

HttpControllerResponse implements HttpControllerResponseInterface
Extended by AdminLayoutHttpControllerResponse
Package: Http
Category: System
Extends: HttpControllerResponse
Located at Services/System/Http/AdminLayoutHttpControllerResponse.inc.php

Methods summary

public
# __construct( NonEmptyStringType $title, ExistingFile $template, KeyValueCollection $data = null, AssetCollectionInterface $assets = null, ContentNavigationCollectionInterface $contentNavigation = null, ContentView $contentView = null )

AdminLayoutHttpViewController constructor.

AdminLayoutHttpViewController constructor.

Parameters

$title
Page title.
$template
Template absolute path.
$data

A key-value collection containing the data to be used by the template.

$assets
Page assets (js, css, translations etc).
$contentNavigation

Sub content navigation (key-value collection).

$contentView

Provide a custom content view class if needed.

Overrides

HttpControllerResponse::__construct
protected
# _render( )

Render the provided template.

Render the provided template.

Hint: Override this method to change the rendering algorithm.

Throws

InvalidArgumentException
UnexpectedValueException
protected array
# _getTranslations( )

Get the default and assets translations.

Get the default and assets translations.

Hint: Override this method to fetch different default translations.

Returns

array
protected
# _setInitialMessages( )

Set initial messages for new admin layout.

Set initial messages for new admin layout.

Methods inherited from HttpControllerResponse

getBody(), getHeaders()

Properties summary

protected string $title

Page Title

Page Title

#
protected string $template

Template Path

Template Path

#
protected KeyValueCollection $data

Template data.

Template data.

#
protected AssetCollectionInterface $assets

Page Assets

Page Assets

Provide paths or filenames to JavaScript, CSS or PHP Translation files.

#
protected ContentNavigationCollectionInterface $contentNavigation

Content Sub Navigation

Content Sub Navigation

The sub navigation will be displayed under the header and can redirect to similar pages.

#
protected ContentView $contentView

ContentView instance.

ContentView instance.

Used for parsing the Smarty templates.

#

Properties inherited from HttpControllerResponse

$httpBody, $httpHeadersArray

API documentation generated by ApiGen