BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException
  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 
<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

/**
 * Url helper class
 *
 * @version         $Revision$
 * @modifiedby      $LastChangedBy$
 * @lastmodified    $LastChangedDate$
 * 
 * $Id$
 */
class BeurlHelper extends AppHelper {
    /**
     * Included helpers.
     *
     * @var array
     */
    var $helpers = array('Html','Javascript','Tr');
        
    /**
    * get current page url
    * 
    * @return string url
    */
    public function here() {
        $newUrl = str_replace($this->Html->base, "", $this->Html->here) ;
        if($newUrl != "/") {
            $pos = strpos($newUrl,"/");
            if(!$pos || $pos > 0) 
                $newUrl = "/" . $newUrl;
        }
        return $newUrl;
    }

    /**
     * get url to here
     * 
     * @param mixed string|array $cleanFromFields, field or array of fields passed by name that you want to clean in url
     * @return string url
     */
    public function getUrl($cleanFromFields = null) {
        $paramsNamed = $this->params["named"];
        if (!empty($cleanFromFields)) {
            $paramsNamed = $this->cleanPassedArgs($cleanFromFields);
        }
        $pass = $this->params["pass"];
        $action = $this->params["action"];
        if(isset($pass[1]) && $pass[1] === $action) {
            unset($pass[1]);        
        }
        $controller = $this->params["controller"];
        if(isset($pass[0]) && $pass[0] === $controller) {
            unset($pass[0]);
        }
        $pass["action"] = $action;
        $pass["controller"] = $controller;
        if (!empty($this->params['plugin']) && $this->params['plugin'] == $this->params['controller']) {
            // #447 - Force 'plugin' parameter to be ignored by Router::url()
            $pass['plugin'] = '';
        }
        $data = array_merge($pass, $paramsNamed);
        $url = Router::url($data);
        return $this->output($url);
    }
    
    /**
     * add css and js scripts for modules
     * 
     * @return string html
     */
    public function addModuleScripts() {
        $view = ClassRegistry::getObject('view');
        $moduleName = $view->getVar("moduleName");
        $conf = Configure::getInstance();
        $scriptsBasePath = APP . "webroot";
        $plugin = false;
        $output = "";
        if (!empty($conf->plugged["modules"])) {
            $modeRewrite = $conf->App['baseUrl'];
            foreach ($conf->plugged["modules"] as $name => $m) {
                $cssBase = "module_color";
                $webrootPath = $m["pluginPath"] . DS . "webroot";
                $name_ok = $name;
                if(!empty($modeRewrite)) {
                    $name_ok = "index.php/" . $name;
                }
                if (file_exists($webrootPath . DS . "css" . DS . $cssBase . ".css")) {
                    $output .= $this->Html->css("/" . $name_ok . "/css/" . $cssBase) . "\n";
                }
                if ($name == $moduleName) {
                    $cssPath = $webrootPath . DS . "css" . DS . "module.css";
                    $cssLink = "/" . $name_ok . "/css/module";
                    $jsPath = $webrootPath . DS . "js" . DS . "module.js";
                    $jsLink = "/" . $name_ok . "/js/module";
                    $plugin = true;
                }
            }
        }
        if (!$plugin) {
            $cssPath = $scriptsBasePath . DS . "css" . DS . "module." . $moduleName . ".css";
            $cssLink = "module." . $moduleName;
            $jsPath = $scriptsBasePath . DS . "js" . DS . "module." . $moduleName . ".js";
            $jsLink = "module." . $moduleName;
        }
        
        if (file_exists($cssPath)) {
            $output .= $this->Html->css($cssLink) . "\n";
        }
        if (file_exists($jsPath)) {
            $output .= $this->Javascript->link($jsLink) . "\n";
        }
        
        return $this->output($output);
    }
    
    
    /**
     * return array without params passed to the method
     * 
     * @param array $cleanFromFields
     * @return array of params cleaned
     */
    private function cleanPassedArgs($cleanFromFields) {
        $paramsNamed = $this->params["named"];
        if (!is_array($cleanFromFields)) {
            if (isset($paramsNamed[$cleanFromFields])) {
                unset($paramsNamed[$cleanFromFields]);
            }
        } else {
            foreach ($cleanFromFields as $field) {
                if (isset($paramsNamed[$field])) {
                    unset($paramsNamed[$field]);
                }
            }
        }
        return $paramsNamed;
    }

    /**
     * build backend page title following this schema:
     *
     *      1. dashboard => project-name | BEdita
     *      2. module index => module-name | project-name | BEdita
     *      3. module object detail (view* action) => object-title (or new item) | module-name | project-name | BEdita
     *      4. other module pages => controller-action | module-name | project-name | BEdita
     *
     * Publications module (areas) is an exception and also in index action it behaves as in view* action
     *
     * @return string
     */
    public function pageTitle() {
        $title = "";
        $view = ClassRegistry::getObject('view');
        $object = $view->getVar("object");
        $currentModule = $view->getVar("currentModule");
        $projectName = Configure::read("projectName");
        
        if (!empty($currentModule)) {
            // if it's in object details (view* action) or current module is area, add title object or "new item"
            if (strpos($view->action, "view") !== false || $currentModule["name"] == "areas") {
                if ($currentModule["name"] == "users") {
                    $title .= " Detail | ";
                } else if (!empty($object["title"])) {
                    $title .= $object["title"] . " | ";
                } else {
                    $title .= $this->Tr->t("New item", true) . " | ";
                }
            } elseif ($view->action != "index") {
                $title .= $view->action . " | ";
            }
            $title .= ucfirst($this->Tr->t($currentModule["label"], true)) . " | ";
        }
        $title .= $projectName . " | BEdita";
        return h($title);
    }

}

?>
BEdita API doc | 4-cactus API documentation generated by ApiGen