| alpha--view

# Class: ArticleView Source Location: /view/ArticleView.inc ## Class ArticleView Class Overview
The rendering class for the ArticleObject class Located in /view/ArticleView.inc [line 52]
    AlphaView
       |
       --ArticleView
Author(s): John Collins <dev@alphaframework.org> Information Tags:
Version: | $Id: ArticleView.inc 1341 2011-03-17 15:02:02Z johnc $
Copyright: | Copyright (c) 2011, 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.
Since: | 1.0
License: | The BSD License
| Methods after_createView_callback editView listView markdownView renderFileUploadSection
[ Top ] Inherited Properties, Constants, and Methods
Inherited Properties | Inherited Methods | Inherited Constants
--- | --- | ---
Inherited From AlphaView AlphaView::$BO | Inherited From AlphaView AlphaView::__construct() Constructor for the AlphaView. As this is protected, use the AlphaView::getInstance method from a public scope. AlphaView::adminView() Renders the admin view for the business object screen to standard output AlphaView::createView() Renders the default create view to standard output AlphaView::detailedView() Displays a detailed view of the object (read-only) to standard output AlphaView::displayErrorMessage() Renders the HTML for an error (e.g. save failed) message AlphaView::displayPageFoot() Method to render the page footer HTML AlphaView::displayPageHead() Method to render the page header HTML content AlphaView::displayUpdateMessage() Renders the HTML for an update (e.g. successful save) message AlphaView::editView() Renders a form to enable object editing to standard output AlphaView::getBO() Gets the BO attached to this view (if any) AlphaView::getInstance() Static method which returns a AlphaView object or a custom child view for the BO specified if one exists AlphaView::listView() Renders the list view to standard output AlphaView::loadTemplate() Loads a .phtml template for the BO specified if one exists. Lower level custom templates take precedence. AlphaView::renderAllFields() Renders all fields for the current BO in edit/create/view mode AlphaView::renderBooleanField() Method to render the default Boolean HTML AlphaView::renderDefaultField() Method to render the default field HTML when type is not known AlphaView::renderDeleteForm() Method to render a hidden form for posting the OID of an object to be deleted AlphaView::renderDEnumField() Method to render the default DEnum HTML AlphaView::renderDoubleField() Method to render the default Double HTML AlphaView::renderEnumField() Method to render the default Enum HTML AlphaView::renderErrorPage() Renders a HTML error page with the supplied error code (typlically a HTTP code) and a message AlphaView::renderIntegerField() Method to render the default Integer HTML AlphaView::renderRelationField() render the default Relation HTML AlphaView::renderSecurityFields() Method to render a HTML form with two hidden, hashed (MD5) form fields to be used as a check to ensure that a post to the controller is being sent from the same server as hosting it. AlphaView::renderTextField() render the default Text HTML AlphaView::setBO() Simple setter for the view business object |
[ Top ] Method Summary
void | after_createView_callback() | Adds a note to the create article screen
void | editView() | Renders a form to enable article editing with attachments options
void | listView() | Renders the list view (adds the dateAdded field for the list template)
void | markdownView() | Method to generate the markdown HTML render of the article content
string | renderFileUploadSection() | Renders the HTML for the file upload section
[ Top ] Properties Methods after_createView_callback [line 74]
`void after_createView_callback( )`
Adds a note to the create article screen API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] editView [line 95]
`void editView( [array $fields = array()] )`
Renders a form to enable article editing with attachments options Parameters:
array | $fields: | hash array of HTML fields to pass to the template
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Redefinition of: AlphaView::editView() Renders a form to enable object editing to standard output [ Top ] listView [line 84]
`void listView( [array $fields = array()] )`
Renders the list view (adds the dateAdded field for the list template) Parameters:
array | $fields: | hash array of HTML fields to pass to the template
API Tags:
Access: | public
Information Tags:
Since: | 1.0
Redefinition of: AlphaView::listView() Renders the list view to standard output [ Top ] markdownView [line 59]
`void markdownView( [array $fields = array()] )`
Method to generate the markdown HTML render of the article content Parameters:
array | $fields: | Hash array of HTML fields to pass to the template.
API Tags:
Access: | public
Information Tags:
Since: | 1.0
[ Top ] renderFileUploadSection [line 162]
`string renderFileUploadSection( )`
Renders the HTML for the file upload section API Tags:
Access: | protected
Information Tags:
Since: | 1.0
[ Top ] Documentation generated on Thu, 17 Mar 2011 16:43:52 +0000 by phpDocumentor 1.4.3