3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Soap specific stuff goes here
39 class CRM_Utils_System_Soap
extends CRM_Utils_System_Base
{
42 * UF container variables
45 static $ufClass = NULL;
48 * Sets the title of the page
50 * @param string $title title for page
53 * @paqram string $pageTitle
58 function setTitle($title, $pageTitle) {
63 * Given a permission string, check for access requirements
65 * @param string $str the permission to check
67 * @return boolean true if yes, else false
71 function checkPermission($str) {
76 * Append an additional breadcrumb tag to the existing breadcrumb
78 * @param string $title
84 function appendBreadCrumb($title, $url) {
89 * Append a string to the head of the html file
91 * @param string $head the new string to be appended
96 function addHTMLHead($head) {
101 * Generate an internal CiviCRM URL
103 * @param $path string The path being linked to, such as "civicrm/add"
104 * @param $query string A query string to append to the link.
105 * @param $absolute boolean Whether to force the output to be an absolute link (beginning with http:).
106 * Useful for links that will be displayed outside the site, such as in an
108 * @param $fragment string A fragment identifier (named anchor) to append to the link.
110 * @return string an HTML string containing a link to the given path.
114 function url($path = NULL, $query = NULL, $absolute = TRUE, $fragment = NULL) {
115 if (isset(self
::$ufClass)) {
116 $className = self
::$ufClass;
117 $url = $className::url($path, $query, $absolute, $fragment);
126 * Figure out the post url for the form
128 * @param the default action if one is pre-specified
130 * @return string the url to post the form
133 function postURL($action) {
138 * Set the email address of the user
140 * @param object $user handle to the user object
145 function setEmail(&$user) {}
148 * Authenticate a user against the real UF
150 * @param string $name Login name
151 * @param string $pass Login password
153 * @return array Result array
156 function &authenticate($name, $pass) {
157 if (isset(self
::$ufClass)) {
158 $className = self
::$ufClass;
159 $result =& $className::authenticate($name, $pass);
168 * Swap the current UF for soap
172 public function swapUF() {
173 $config = CRM_Core_Config
::singleton();
175 self
::$uf = $config->userFramework
;
176 $config->userFramework
= 'Soap';
178 self
::$ufClass = $config->userFrameworkClass
;
179 $config->userFrameworkClass
= 'CRM_Utils_System_Soap';
183 * Get the locale set in the hosting CMS
185 * @return null as the language is set elsewhere
187 function getUFLocale() {
192 * Get user login URL for hosting CMS (method declared in each CMS system class)
194 * @param string $destination - if present, add destination to querystring (works for Drupal only)
197 * @return string - loginURL for the current CMS
200 public function getLoginURL($destination = '') {
201 throw new Exception("Method not implemented: getLoginURL");