Alpha Framework 3.0.0 API Documentation
  • Namespace
  • Class

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
      • Service
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • ArticleCommentView
  • ArticleView
  • DEnumView
  • PersonView
  • SequenceView
  • View
  • ViewState

Class ArticleView

The rendering class for the Article class.

Alpha\View\View
Extended by Alpha\View\ArticleView
Namespace: Alpha\View
Copyright:

Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.
* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
  of its contributors may be used to endorse or promote
  products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at View/ArticleView.php

Methods summary

public string
# markdownView( array $fields = array() )

Method to generate the markdown HTML render of the article content.

Method to generate the markdown HTML render of the article content.

Parameters

$fields
Hash array of HTML fields to pass to the template.

Returns

string

Since

1.0
protected string
# after_createView_callback( )

Adds a note to the create article screen.

Adds a note to the create article screen.

Returns

string

Since

1.0
public string
# listView( array $fields = array() )

Renders the list view (adds the dateAdded field for the list template).

Renders the list view (adds the dateAdded field for the list template).

Parameters

$fields
hash array of HTML fields to pass to the template

Returns

string

Since

1.0

Overrides

Alpha\View\View::listView
public string
# adminView( array $fields = array() )

Renders the admin view for the Article, with create button pointed to the ArticleController.

Renders the admin view for the Article, with create button pointed to the ArticleController.

Parameters

$fields
Hash array of fields to pass to the template

Returns

string

Since

2.0.1

Overrides

Alpha\View\View::adminView
public string
# detailedView( array $fields = array() )

Renders the detail view for the Article, with edit button pointed to the ArticleController.

Renders the detail view for the Article, with edit button pointed to the ArticleController.

Parameters

$fields
Hash array of fields to pass to the template

Returns

string

Since

2.0.1

Overrides

Alpha\View\View::detailedView
public string
# editView( array $fields = array() )

Renders a form to enable article editing with attachments options.

Renders a form to enable article editing with attachments options.

Parameters

$fields
hash array of HTML fields to pass to the template

Returns

string

Since

1.0

Overrides

Alpha\View\View::editView
protected string
# renderFileUploadSection( )

Renders the HTML for the file upload section.

Renders the HTML for the file upload section.

Returns

string

Since

1.0

Methods inherited from Alpha\View\View

__construct(), createView(), displayErrorMessage(), displayPageFoot(), displayPageHead(), displayPageLinks(), displayUpdateMessage(), getInstance(), getProvider(), getRecord(), loadTemplate(), loadTemplateFragment(), renderAllFields(), renderBooleanField(), renderDEnumField(), renderDefaultField(), renderDeleteForm(), renderDoubleField(), renderEnumField(), renderErrorPage(), renderIntegerField(), renderRelationField(), renderSecurityFields(), renderTextField(), setProvider(), setRecord()

Properties summary

Properties inherited from Alpha\View\View

$record

Alpha Framework 3.0.0 API Documentation API documentation generated by ApiGen