// yes, set page title, depending on context
$context = civi_wp()->civicrm_context_get();
- switch ( $context ) {
+ switch ($context) {
case 'admin':
case 'shortcode':
$template = CRM_Core_Smarty::singleton();
$template->assign('pageTitle', $pageTitle);
}
- } elseif (civicrm_wp_in_civicrm()) {
+ }
+ elseif (civicrm_wp_in_civicrm()) {
// legacy pre-4.6 behaviour
global $civicrm_wp_title;
/**
* Append a string to the head of the html file
*
- * @param string $head the new string to be appended
+ * @param string $head
+ * The new string to be appended.
*
* @return void
* @static
* Add a script file
*
* @param $url: string, absolute path to file
- * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline script
*
* @param $code: string, javascript code
- * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add a css file
*
* @param $url: string, absolute path to file
- * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
* Add an inline style
*
* @param $code: string, css code
- * @param $region string, location within the document: 'html-header', 'page-header', 'page-footer'
+ * @param string $region
+ * location within the document: 'html-header', 'page-header', 'page-footer'.
*
* Note: This function is not to be called directly
* @see CRM_Core_Region::render()
/**
* Figure out the post url for the form
*
- * @param mix $action the default action if one is pre-specified
+ * @param mix $action
+ * The default action if one is pre-specified.
*
* @return string the url to post the form
* @static
/**
* Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
*
- * @param $path string The path being linked to, such as "civicrm/add"
- * @param $query string A query string to append to the link.
- * @param $absolute boolean Whether to force the output to be an absolute link (beginning with http:).
+ * @param string $path
+ * The path being linked to, such as "civicrm/add".
+ * @param string $query
+ * A query string to append to the link.
+ * @param bool $absolute
+ * Whether to force the output to be an absolute link (beginning with http:).
* Useful for links that will be displayed outside the site, such as in an
* RSS feed.
- * @param $fragment string A fragment identifier (named anchor) to append to the link.
- * @param $htmlize boolean whether to convert to html eqivalant
- * @param $frontend boolean a gross joomla hack
+ * @param string $fragment
+ * A fragment identifier (named anchor) to append to the link.
+ * @param bool $htmlize
+ * whether to convert to html eqivalant.
+ * @param bool $frontend
+ * a gross joomla hack.
*
* @param bool $forceBackend
*
// when shortcode is included in page
// also make sure we have valid query object
global $wp_query;
- if ( method_exists( $wp_query, 'get' ) ) {
+ if (method_exists($wp_query, 'get')) {
if (get_query_var('page_id')) {
$wpPageParam = "page_id=" . get_query_var('page_id');
}
/**
* Authenticate the user against the wordpress db
*
- * @param string $name the user name
- * @param string $password the password for the above user name
+ * @param string $name
+ * The user name.
+ * @param string $password
+ * The password for the above user name.
*
* @param bool $loadCMSBootstrap
* @param null $realPath
/**
* Set a message in the UF to display to a user
*
- * @param string $message the message to set
+ * @param string $message
+ * The message to set.
*
* @static
*/
*
* @return bool
*/
- public function loadUser( $user ) {
- return true;
+ public function loadUser($user) {
+ return TRUE;
}
public function permissionDenied() {
wp_redirect(wp_login_url());
}
- public function updateCategories() {}
+ public function updateCategories() {
+ }
/**
* Get the locale set in the hosting CMS
if (isset($language)) {
return CRM_Core_I18n_PseudoConstant::longForShort(substr($language, 0, 2));
- } else {
+ }
+ else {
return NULL;
}
}
/**
* Load wordpress bootstrap
*
- * @param $name string optional username for login
- * @param $pass string optional password for login
+ * @param string $name
+ * optional username for login.
+ * @param string $pass
+ * optional password for login.
*
* @return bool
*/
CRM_Core_Error::fatal("Could not find the install directory for WordPress");
}
- require_once ($cmsRootPath . DIRECTORY_SEPARATOR . 'wp-load.php');
+ require_once $cmsRootPath . DIRECTORY_SEPARATOR . 'wp-load.php';
$wpUserTimezone = get_option('timezone_string');
if ($wpUserTimezone) {
date_default_timezone_set($wpUserTimezone);
CRM_Core_Config::singleton()->userSystem->setMySQLTimeZone();
}
- require_once ($cmsRootPath . DIRECTORY_SEPARATOR . 'wp-includes/pluggable.php');
+ require_once $cmsRootPath . DIRECTORY_SEPARATOR . 'wp-includes/pluggable.php';
$uid = CRM_Utils_Array::value('uid', $name);
if ($uid) {
$account = wp_set_current_user($uid);
return TRUE;
}
}
- return true;
+ return TRUE;
}
/**
*/
public function validInstallDir($dir) {
$includePath = "$dir/wp-includes";
- if (
- @opendir($includePath) &&
- file_exists("$includePath/version.php")
- ) {
+ if (file_exists("$includePath/version.php")) {
return TRUE;
}
return FALSE;
/**
* Change user name in host CMS
*
- * @param integer $ufID User ID in CMS
- * @param string $ufName User name
+ * @param int $ufID
+ * User ID in CMS.
+ * @param string $ufName
+ * User name.
*/
public function updateCMSName($ufID, $ufName) {
// CRM-10620
$ufID = CRM_Utils_Type::escape($ufID, 'Integer');
$ufName = CRM_Utils_Type::escape($ufName, 'String');
- $values = array ('ID' => $ufID, 'user_email' => $ufName);
- if( $ufID ) {
- wp_update_user( $values ) ;
+ $values = array('ID' => $ufID, 'user_email' => $ufName);
+ if ($ufID) {
+ wp_update_user($values);
}
}
}
/**
* Get User ID from UserFramework system (Joomla)
- * @param object $user object as described by the CMS
+ * @param object $user
+ * Object as described by the CMS.
* @return mixed <NULL, number>
*/
public function getUserIDFromUserObject($user) {
/**
* Get Unique Identifier from UserFramework system (CMS)
- * @param object $user object as described by the User Framework
+ * @param object $user
+ * Object as described by the User Framework.
* @return mixed $uniqueIdentifer Unique identifier from the user Framework system
*
*/
/**
* Get user login URL for hosting CMS (method declared in each CMS system class)
*
- * @param string $destination - if present, add destination to querystring (works for Drupal only)
+ * @param string $destination
+ * If present, add destination to querystring (works for Drupal only).
*
* @return string - loginURL for the current CMS
*
/**
* Get Url to view user record
- * @param integer $contactID Contact ID
+ * @param int $contactID
+ * Contact ID.
*
* @return string
*/
}
}
}
-
projects / civicrm-core.git / blobdiff