File View/ArticleView.php | Alpha Framework 3.0.0 API Documentation

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290

<?php

namespace Alpha\View;

use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Extension\MarkdownFacade;
use Alpha\Util\Security\SecurityUtils;
use Alpha\View\Widget\Button;
use Alpha\Controller\Front\FrontController;

/**
 * The rendering class for the Article class.
 *
 * @since 1.0
 *
 * @author John Collins <dev@alphaframework.org>
 * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
 * @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
 * All rights reserved.
 *
 * <pre>
 * 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.
 * </pre>
 */
class ArticleView extends View
{
    /**
     * Method to generate the markdown HTML render of the article content.
     *
     * @param array $fields Hash array of HTML fields to pass to the template.
     *
     * @since 1.0
     *
     * @return string
     */
    public function markdownView($fields = array())
    {
        $markdown = new MarkdownFacade($this->record);

        $fields['markdownContent'] = $markdown->getContent();

        return $this->loadTemplate($this->record, 'markdown', $fields);
    }

    /**
     * Adds a note to the create article screen.
     *
     * @return string
     *
     * @since 1.0
     */
    protected function after_createView_callback()
    {
        return '<p><strong>Please note</strong> that you will only be able to attach files to the article once it has been created.</p><br>';
    }

    /**
     * Renders the list view (adds the dateAdded field for the list template).
     *
     * @param array $fields hash array of HTML fields to pass to the template
     *
     * @since 1.0
     *
     * @return string
     */
    public function listView($fields = array())
    {
        $fields['dateAdded'] = $this->record->getCreateTS()->getDate();
        $fields['editButtonURL'] = FrontController::generateSecureURL('act=Alpha\Controller\ArticleController&ActiveRecordType='.get_class($this->record).'&ActiveRecordID='.$this->record->getID().'&view=edit');

        return parent::listView($fields);
    }

    /**
     * Renders the admin view for the Article, with create button pointed to the ArticleController.
     *
     * @param array $fields Hash array of fields to pass to the template
     *
     * @return string
     *
     * @since 2.0.1
     */
    public function adminView($fields = array())
    {
        $fields['createButtonURL'] = FrontController::generateSecureURL('act=Alpha\Controller\ArticleController&ActiveRecordType='.get_class($this->record).'&view=create');

        return parent::adminView($fields);
    }

    /**
     * Renders the detail view for the Article, with edit button pointed to the ArticleController.
     *
     * @param array $fields Hash array of fields to pass to the template
     *
     * @return string
     *
     * @since 2.0.1
     */
    public function detailedView($fields = array())
    {
        $fields['editButtonURL'] = FrontController::generateSecureURL('act=Alpha\Controller\ArticleController&ActiveRecordType='.get_class($this->record).'&ActiveRecordID='.$this->record->getID().'&view=edit');

        return parent::detailedView($fields);
    }

    /**
     * Renders a form to enable article editing with attachments options.
     *
     * @param array $fields hash array of HTML fields to pass to the template
     *
     * @since 1.0
     *
     * @return string
     */
    public function editView($fields = array())
    {
        if (method_exists($this, 'before_editView_callback')) {
            $this->{'before_editView_callback'}();
        }

        $config = ConfigProvider::getInstance();

        // the form action
        if (isset($fields['URI'])) {
            $fields['formAction'] = $fields['URI'];
        }

        // the form ID
        $fields['formID'] = stripslashes(get_class($this->record)).'_'.$this->record->getID();

        // buffer form fields to $formFields
        $fields['formFields'] = $this->renderAllFields('edit');

        // buffer HTML output for Create and Cancel buttons
        $button = new Button('submit', 'Save', 'saveBut');
        $fields['saveButton'] = $button->render();

        $formFieldId = ($config->get('security.encrypt.http.fieldnames') ? base64_encode(SecurityUtils::encrypt('ActiveRecordID')) : 'ActiveRecordID');
            
        $js = View::loadTemplateFragment('html', 'bootstrapconfirmokay.phtml', array('prompt' => 'Are you sure you wish to delete this item?', 'formFieldId' => $formFieldId, 'formFieldValue' => $this->record->getID(), 'formId' => 'deleteForm'));

        $button = new Button($js, 'Delete', 'deleteBut');
        $fields['deleteButton'] = $button->render();

        $button = new Button("document.location = '".FrontController::generateSecureURL('act=Alpha\Controller\ActiveRecordController&ActiveRecordType='.get_class($this->record).'&start=0&limit='.$config->get('app.list.page.amount'))."'", 'Back to List', 'cancelBut');
        $fields['cancelButton'] = $button->render();

        $tags = array();

        if (is_object($this->record->getPropObject('tags'))) {
            $tags = $this->record->getPropObject('tags')->getRelated();
        }

        if (count($tags) > 0) {
            $button = new Button("document.location = '".FrontController::generateSecureURL('act=Alpha\Controller\TagController&ActiveRecordType='.get_class($this->record).'&ActiveRecordID='.$this->record->getID())."'", 'Edit Tags', 'tagsBut');
            $fields['tagsButton'] = $button->render();
        }

        // buffer security fields to $formSecurityFields variable
        $fields['formSecurityFields'] = $this->renderSecurityFields();

        // ID will need to be posted for optimistic lock checking
        $fields['version_num'] = $this->record->getVersionNumber();

        // file attachments section
        $fields['fileAttachments'] = $this->renderFileUploadSection();

        if (method_exists($this, 'after_editView_callback')) {
            $this->{'after_editView_callback'}();
        }

        return $this->loadTemplate($this->record, 'edit', $fields);
    }

    /**
     * Renders the HTML for the file upload section.
     *
     * @return string
     *
     * @since 1.0
     */
    protected function renderFileUploadSection()
    {
        $config = ConfigProvider::getInstance();

        $html = '<div class="form-group">';
        $html .= '  <h3>File Attachments:</h3>';

        if (is_dir($this->record->getAttachmentsLocation())) {
            $handle = opendir($this->record->getAttachmentsLocation());

            $fileCount = 0;

            $html .= '<table class="table table-bordered">';

            // loop over the attachments directory
            while (false !== ($file = readdir($handle))) {
                if ($file != '.' && $file != '..') {
                    ++$fileCount;

                    $html .= '<tr>';

                    $html .= '<td>'.$file.' <em>('.number_format(filesize($this->record->getAttachmentsLocation().'/'.$file)/1024).' KB)</em></td>';

                    $js = "if(window.jQuery) {
                            BootstrapDialog.show({
                                title: 'Confirmation',
                                message: 'Are you sure you wish to delete this item?',
                                buttons: [
                                    {
                                        icon: 'glyphicon glyphicon-remove',
                                        label: 'Cancel',
                                        cssClass: 'btn btn-default btn-xs',
                                        action: function(dialogItself){
                                            dialogItself.close();
                                        }
                                    },
                                    {
                                        icon: 'glyphicon glyphicon-ok',
                                        label: 'Okay',
                                        cssClass: 'btn btn-default btn-xs',
                                        action: function(dialogItself) {
                                            $('[id=\"".($config->get('security.encrypt.http.fieldnames') ? base64_encode(SecurityUtils::encrypt('deletefile')) : 'deletefile')."\"]').attr('value', '".$file."');
                                            $('[id=\"".stripslashes(get_class($this->record)).'_'.$this->record->getID()."\"]').submit();
                                            dialogItself.close();
                                        }
                                    }
                                ]
                            });
                        }";
                    $button = new Button($js, 'Delete', 'delete'.$fileCount.'But');
                    $html .= '<td>'.$button->render().'</td>';
                    $html .= '</tr>';
                }
            }

            $html .= '</table>';
        } else {
            // we will take this opportunity to create the attachments folder is it does
            // not already exist.
            $this->record->createAttachmentsFolder();
        }

        $html .= '<span class="btn btn-default btn-file">';
        $html .= '<input name="userfile" type="file" value="Browse..."/>';
        $html .= '</span>';

        $temp = new Button('submit', 'Upload', 'uploadBut');
        $html .= $temp->render();

        $fieldname = ($config->get('security.encrypt.http.fieldnames') ? base64_encode(SecurityUtils::encrypt('deletefile')) : 'deletefile');
        $html .= '<input type="hidden" name="'.$fieldname.'" id="'.$fieldname.'" value=""/>';

        $fieldname = ($config->get('security.encrypt.http.fieldnames') ? base64_encode(SecurityUtils::encrypt('articleID')) : 'articleID');
        $html .= '<input type="hidden" name="'.$fieldname.'" id="'.$fieldname.'" value="'.$this->record->getID().'"/>';

        $html .= '</div>';

        return $html;
    }
}

Namespaces

Classes

Interfaces

Exceptions