9 => 'Nine',
);
+ /**
+ * Constructor for the basic form page
+ *
+ * We should not use QuickForm directly. This class provides a lot
+ * of default convenient functions, rules and buttons
+ *
+ * @param object $state State associated with this form
+ * @param \const|\enum $action The mode the form is operating in (None/Create/View/Update/Delete)
+ * @param string $method The type of http method used (GET/POST)
+ * @param string $name The name of the form if different from class name
+ *
+ * @return \CRM_Core_Form
+ @access public
+ */
+ /**
+ * @param null|object $state
+ * @param const|enum|int $action
+ * @param string $method
+ * @param null|string $name
+ */
function __construct($state = NULL,
$action = CRM_Core_Action::NONE,
$method = 'post',
parent::__construct($state, $action, $method, $name);
}
+ /**
+ * @param $version
+ *
+ * @return mixed
+ */
static function &incrementalPhpObject($version) {
static $incrementalPhpObject = array();
return $incrementalPhpObject[$versionName];
}
+ /**
+ * @param $version
+ * @param $release
+ *
+ * @return bool
+ */
function checkVersionRelease($version, $release) {
$versionParts = explode('.', $version);
if ($versionParts[2] == $release) {
return FALSE;
}
+ /**
+ * @param $constraints
+ *
+ * @return array
+ */
function checkSQLConstraints(&$constraints) {
$pass = $fail = 0;
foreach ($constraints as $constraint) {
}
}
+ /**
+ * @param $constraint
+ *
+ * @return bool
+ */
function checkSQLConstraint($constraint) {
// check constraint here
return TRUE;
}
+ /**
+ * @param $fileName
+ * @param bool $isQueryString
+ */
function source($fileName, $isQueryString = FALSE) {
CRM_Utils_File::sourceSQLFile($this->_config->dsn,
);
}
+ /**
+ * getter function for title. Should be over-ridden by derived class
+ *
+ * @return string
+ * @access public
+ */
+ /**
+ * @return string
+ */
function getTitle() {
return ts('Title not Set');
}
+ /**
+ * @return string
+ */
function getFieldsetTitle() {
return ts('');
}
+ /**
+ * @return string
+ */
function getButtonTitle() {
return ts('Continue');
}
+ /**
+ * Use the form name to create the tpl file name
+ *
+ * @return string
+ * @access public
+ */
+ /**
+ * @return string
+ */
function getTemplateFileName() {
$this->assign('title',
$this->getFieldsetTitle()
}
}
+ /**
+ * @param $query
+ *
+ * @return Object
+ */
function runQuery($query) {
return CRM_Core_DAO::executeQuery($query,
CRM_Core_DAO::$_nullArray
);
}
+ /**
+ * @param $version
+ *
+ * @return Object
+ */
function setVersion($version) {
$this->logVersion($version);
return $this->runQuery($query);
}
+ /**
+ * @param $newVersion
+ *
+ * @return bool
+ */
function logVersion($newVersion) {
if ($newVersion) {
$oldVersion = CRM_Core_BAO_Domain::version();
return FALSE;
}
+ /**
+ * @param $version
+ *
+ * @return bool
+ */
function checkVersion($version) {
$domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain',
$version, 'id',
return $domainID ? TRUE : FALSE;
}
+ /**
+ * @return array
+ * @throws Exception
+ */
function getRevisionSequence() {
$revList = array();
$sqlDir = implode(DIRECTORY_SEPARATOR,
return $revList;
}
+ /**
+ * @param $rev
+ * @param int $index
+ *
+ * @return null
+ */
static function getRevisionPart($rev, $index = 1) {
$revPattern = '/^((\d{1,2})\.\d{1,2})\.(\d{1,2}|\w{4,7})?$/i';
preg_match($revPattern, $rev, $matches);
return array_key_exists($index, $matches) ? $matches[$index] : NULL;
}
+ /**
+ * @param $tplFile
+ * @param $rev
+ *
+ * @return bool
+ */
function processLocales($tplFile, $rev) {
$smarty = CRM_Core_Smarty::singleton();
$smarty->assign('domainID', CRM_Core_Config::domainID());
return $this->multilingual;
}
+ /**
+ * @param $rev
+ */
function setSchemaStructureTables($rev) {
if ($this->multilingual) {
CRM_Core_I18n_Schema::schemaStructureTables($rev, TRUE);
}
}
+ /**
+ * @param $rev
+ *
+ * @throws Exception
+ */
function processSQL($rev) {
$sqlFile = implode(DIRECTORY_SEPARATOR,
array(
/**
* Determine if $currentVer can be upgraded to $latestVer
*
+ * @param $currentVer
+ * @param $latestVer
+ *
* @return mixed, a string error message or boolean 'false' if OK
*/
function checkUpgradeableVersion($currentVer, $latestVer) {
/**
* Determine if $currentver already matches $latestVer
*
+ * @param $currentVer
+ * @param $latestVer
+ *
* @return mixed, a string error message or boolean 'false' if OK
*/
function checkCurrentVersion($currentVer, $latestVer) {
/**
* Perform an incremental version update
*
+ * @param CRM_Queue_TaskContext $ctx
* @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
- * @param $currentVer string, the original revision
- * @param $latestVer string, the target (final) revision
- * @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ *
+ * @return bool
+ * @internal param string $currentVer , the original revision
+ * @internal param string $latestVer , the target (final) revision
+ * @internal param string $postUpgradeMessageFile , path of a modifiable file which lists the post-upgrade messages
*/
static function doIncrementalUpgradeStart(CRM_Queue_TaskContext $ctx, $rev) {
$upgrade = new CRM_Upgrade_Form();
/**
* Perform an incremental version update
*
+ * @param CRM_Queue_TaskContext $ctx
* @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
* @param $currentVer string, the original revision
* @param $latestVer string, the target (final) revision
* @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ *
+ * @return bool
*/
static function doIncrementalUpgradeStep(CRM_Queue_TaskContext$ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) {
$upgrade = new CRM_Upgrade_Form();
/**
* Perform an incremental version update
*
+ * @param CRM_Queue_TaskContext $ctx
* @param $rev string, the target (intermediate) revision e.g '3.2.alpha1'
* @param $currentVer string, the original revision
* @param $latestVer string, the target (final) revision
* @param $postUpgradeMessageFile string, path of a modifiable file which lists the post-upgrade messages
+ *
+ * @return bool
*/
static function doIncrementalUpgradeFinish(CRM_Queue_TaskContext $ctx, $rev, $currentVer, $latestVer, $postUpgradeMessageFile) {
$upgrade = new CRM_Upgrade_Form();
* object.
*
* @param $preUpgradeMessage string, alterable
+ * @param $currentVer
+ * @param $latestVer
*/
function setPreUpgradeMessage(&$preUpgradeMessage, $currentVer, $latestVer) {
CRM_Upgrade_Incremental_Legacy::setPreUpgradeMessage($preUpgradeMessage, $currentVer, $latestVer);
projects / civicrm-core.git / blobdiff