Oroboros Core
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • None
  • oroboros
    • core
      • abstracts
        • adapters
        • bootstrap
        • controllers
        • libraries
          • auth
          • bootstrap
          • cache
          • codex
          • config
          • container
          • data
          • database
          • dns
          • entity
          • enum
          • error
          • event
          • extension
          • file
          • flags
          • hooks
          • job
          • logger
          • manager
          • message
          • prototype
          • request
          • response
          • routine
          • shell
          • startup
          • stream
          • template
          • uri
          • utility
          • validation
            • workers
          • worker
        • models
        • patterns
          • behavioral
          • creational
        • utilities
          • exception
            • cache
            • container
          • http
        • views
      • interfaces
        • adapters
          • interpreters
          • sdk
        • api
          • adapters
          • bootstrap
          • controllers
          • psr
        • contract
          • adapters
          • bootstrap
          • codex
          • components
          • controllers
          • data
          • entities
          • errors
          • events
          • extensions
          • jobs
          • libraries
            • auth
            • cache
            • config
            • container
            • enum
            • file
            • flags
            • hooks
            • module
            • promise
            • record
            • request
            • response
            • server
            • shutdown
            • site
            • stream
            • template
            • theme
            • uri
          • models
          • patterns
            • behavioral
            • concurrency
            • creational
            • structural
          • routes
          • routines
            • bootload
            • declarative
            • procedural
            • subsystem
          • services
            • consumer
              • cgi
              • rest
                • local
                • remote
                  • authenticated
                  • unauthenticated
            • provider
              • cgi
              • rest
                • local
                • remote
                  • authenticated
                  • unauthenticated
          • utilities
            • datetime
            • exception
              • cache
              • container
            • filebase
            • http
            • math
            • parser
            • regex
            • session
          • views
        • enumerated
          • environment
          • flags
          • http
          • views
        • libraries
          • manager
          • worker
      • libraries
        • api
        • codex
        • container
        • enum
          • http
        • file
        • hooks
        • logger
        • math
        • psr4
        • request
        • response
        • stream
        • uri
      • patterns
        • creational
      • traits
        • adapters
        • bootstrap
        • codex
        • components
        • controllers
        • data
        • entities
        • events
        • extensions
        • jobs
        • libraries
          • container
          • file
          • request
          • response
          • stream
          • uri
        • models
        • modules
        • patterns
          • behavioral
          • concurrency
          • creational
          • structural
        • routes
        • services
        • utilities
          • core
            • api
            • config
            • contract
              • contract
            • enum
            • environment
            • routines
          • datetime
          • error
          • exception
          • filebase
          • hooks
          • html
          • http
          • logic
          • math
          • parsers
          • regex
          • session
        • views
      • utilities
        • exception
          • cache
          • container
        • http
      • views
    • tests
      • patterns
        • creational
      • psr
        • psr7
      • utilities
        • exception
  • PasswordCompat
    • binary
  • PHP

Interfaces

  • AdapterApi
  • AuthApi
  • BaseApi
  • BehavioralPatternApi
  • BootstrapApi
  • CacheApi
  • ClassScopeApi
  • ClassTypeApi
  • CodexApi
  • CollectionApi
  • ConcurrencyPatternApi
  • ContainerApi
  • ControllerApi
  • CoreApi
  • CreationalPatternApi
  • DatabaseApi
  • DataObjectApi
  • DataObjectCollectionApi
  • DefaultApi
  • EntityApi
  • EntityCollectionApi
  • EnumApi
  • EnvironmentApi
  • EventApi
  • ExceptionApi
  • ExceptionCodeApi
  • ExceptionMessageApi
  • ExtensionrApi
  • FlagApi
  • HtmlTemplateApi
  • JobApi
  • JobCollectionApi
  • LibraryApi
  • LoggerApi
  • LogLevelApi
  • MathApi
  • ModelApi
  • ModuleApi
  • OroborosApi
  • ParserApi
  • PatternApi
  • RecordApi
  • RecordCollectionApi
  • RegexApi
  • RequestApi
  • ResponseApi
  • RouteApi
  • RouterApi
  • RoutineApi
  • ServerApi
  • ServiceApi
  • ServiceCollectionApi
  • ShellApi
  • StreamApi
  • StructuralPatternApi
  • TemplateApi
  • UtilityApi
  • ViewApi

Interface HtmlTemplateApi

Provides the standard methods for interacting with html templates.

oroboros\core\interfaces\api\HtmlTemplateApi implements oroboros\core\interfaces\api\TemplateApi
Namespace: oroboros\core\interfaces\api
Author: Brian Dayhoff brian@mopsyd.me
Since: 0.0.2a
Located at core/interfaces/api/HtmlTemplateApi.php

Methods summary

public
# author( )

The following methods can be used in template sections to retrieve supplied page information individually.

The following methods can be used in template sections to retrieve supplied page information individually.

public
# description( )
public
# title( )
public
# lang( )
public
# meta( )
public
# pagename( )
public
# favicon( )
public
# fonts( )
public
# scripts( )
public
# css( )
public
# heading( )
public
# metadata( )
public
# content( $key )

The following methods can be used by a View to set page information individually.

The following methods can be used by a View to set page information individually.

public
# setAuthor( $author )
public
# setDescription( $description )
public
# setTitle( $title )
public
# setLang( $lang )
public
# setMeta( $name, $meta )
public
# setPagename( $id )
public
# setFavicon( $name, $favicon )
public
# setFont( $name, $font )
public
# setScript( $name, $script )
public
# setCss( $name, $stylesheet )
public
# setHeading( $heading )
public
# setMetadata( $name, $metadata )
public
# setContent( $name, $content )
public
# resetContent( )

The following methods can be used by a View to reset page information individually.

The following methods can be used by a View to reset page information individually.

public
# resetMetadata( )
public
# resetHeading( )
public
# resetCss( )
public
# resetScripts( )
public
# resetFonts( )
public
# resetFavicon( )
public
# resetPagename( )
public
# resetMeta( )
public
# resetLang( )
public
# resetTitle( )
public
# resetAuthor( )
public
# resetDescription( )

Methods inherited from oroboros\core\interfaces\api\TemplateApi

__construct(), initialize(), part(), queue(), render(), reset()

Constants summary

string FLAG_SHORT_TAG
# "::short-tag::"
string FLAG_INLINE_TAG

When passed to the tag generator, will prevent entering a line break at the end of the tag. This prevents the inline-block render bug that adds the line break as a space in markup, and tends to break responsive layouts.

When passed to the tag generator, will prevent entering a line break at the end of the tag. This prevents the inline-block render bug that adds the line break as a space in markup, and tends to break responsive layouts.

Since

0.0.2a
# "::inline-tag::"

Constants inherited from oroboros\core\interfaces\api\TemplateApi

CLASS_TYPE

Constants inherited from oroboros\OroborosInterface

OROBOROS_VENDOR_NAMESPACE, OROBOROS_VERSION

Oroboros Core API documentation generated by ApiGen