3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
54 * @paqram string $pageTitle
58 public function setTitle($title, $pageTitle) {
63 * Given a permission string, check for access requirements
66 * The permission to check.
69 * true if yes, else false
72 public function checkPermission($str) {
77 * Append an additional breadcrumb tag to the existing breadcrumb
79 * @param string $title
84 public function appendBreadCrumb($title, $url) {
89 * Append a string to the head of the html file
92 * The new string to be appended.
96 public function addHTMLHead($head) {
101 * Generate an internal CiviCRM URL
103 * @param string $path
104 * The path being linked to, such as "civicrm/add".
105 * @param string $query
106 * A query string to append to the link.
107 * @param bool $absolute
108 * Whether to force the output to be an absolute link (beginning with http:).
109 * Useful for links that will be displayed outside the site, such as in an
111 * @param string $fragment
112 * A fragment identifier (named anchor) to append to the link.
115 * an HTML string containing a link to the given path.
117 public function url($path = NULL, $query = NULL, $absolute = TRUE, $fragment = NULL) {
118 if (isset(self
::$ufClass)) {
119 $className = self
::$ufClass;
120 $url = $className::url($path, $query, $absolute, $fragment);
129 * Figure out the post url for the form
131 * @param the default action if one is pre-specified
134 * the url to post the form
136 public function postURL($action) {
141 * Set the email address of the user
143 * @param object $user
144 * Handle to the user object.
148 public function setEmail(&$user) {
152 * Authenticate a user against the real UF
154 * @param string $name
156 * @param string $pass
162 public function &authenticate($name, $pass) {
163 if (isset(self
::$ufClass)) {
164 $className = self
::$ufClass;
165 $result =& $className::authenticate($name, $pass);
174 * Swap the current UF for soap
176 public function swapUF() {
177 $config = CRM_Core_Config
::singleton();
179 self
::$uf = $config->userFramework
;
180 $config->userFramework
= 'Soap';
182 self
::$ufClass = $config->userFrameworkClass
;
183 $config->userFrameworkClass
= 'CRM_Utils_System_Soap';
187 * Get the locale set in the hosting CMS
190 * as the language is set elsewhere
192 public function getUFLocale() {
197 * Get user login URL for hosting CMS (method declared in each CMS system class)
199 * @param string $destination
200 * If present, add destination to querystring (works for Drupal only).
204 * loginURL for the current CMS
207 public function getLoginURL($destination = '') {
208 throw new Exception("Method not implemented: getLoginURL");