-
+ *
- key: sourceId + *
- value : array of source, attributes, replica + *
\n"; return $sRet; } - // Restore initial values... mmmm, to be discussed + /** + * Alias of DBObject::Reload() + * + * Restore initial values + * + * @see Reload() + * + * @throws CoreException + */ public function DBRevert() { $this->Reload(); } + /** + * Is the current instance fully or partially loaded. + * + * This method compute the state in realtime. + * In almost every case it is preferable to use DBObject::m_bFullyLoaded. + * + * @internal + * @see m_bFullyLoaded + * + * @return bool + * @throws CoreException + */ protected function IsFullyLoaded() { foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode=>$oAttDef) @@ -234,10 +331,14 @@ abstract class DBObject implements iDisplay } /** - * @param bool $bAllowAllData DEPRECATED: the reload must never fail! + * Reload the object from the DB. + * + * This is mostly used after a lazy load (automatically performed by the framework) + * This will erase any pending changes. + * + * @param bool $bAllowAllData @deprecated This parameter is ignored!! * * @throws CoreException - * @internal */ public function Reload($bAllowAllData = false) { @@ -265,6 +366,20 @@ abstract class DBObject implements iDisplay $this->m_aModifiedAtt = array(); } + /** + * Initialize the instance against a given structured array + * + * @internal + * @see GetExtendedData() extended data + * + * @param array $aRow an array under the form: `
- * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php) + * @return integer the binary combination of flags for the given attribute in the given state of the object. + * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php) + * * @throws \CoreException * - * @api - * * @see GetInitialStateAttributeFlags for creation */ public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '') @@ -1232,12 +1702,18 @@ abstract class DBObject implements iDisplay return $iFlags | $iSynchroFlags; // Combine both sets of flags } - /** - * @param string $sAttCode - * @param array $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas) - * - * @throws \CoreException - */ + /** + * Whether the attribute is read-only + * + * @internal + * + * @param string $sAttCode + * @param array $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas) + * + * @return int Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php) + * + * @throws \CoreException + */ public function IsAttributeReadOnlyForCurrentState($sAttCode, &$aReasons = array()) { $iAttFlags = $this->GetAttributeFlags($sAttCode, $aReasons); @@ -1248,11 +1724,17 @@ abstract class DBObject implements iDisplay /** * Returns the set of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...) * for the given attribute in a transition - * @param $sAttCode string $sAttCode The code of the attribute - * @param $sStimulus string The stimulus code to apply - * @param $aReasons array To store the reasons why the attribute is read-only (info about the synchro replicas) - * @param $sOriginState string The state from which to apply $sStimulus, if empty current state will be used + * + * @internal + * + * @param string $sAttCode $sAttCode The code of the attribute + * @param string $sStimulus The stimulus code to apply + * @param array|null $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas) + * @param string $sOriginState The state from which to apply $sStimulus, if empty current state will be used + * * @return integer Flags: the binary combination of the flags applicable to this attribute + * @throws ArchivedObjectException + * @throws CoreException */ public function GetTransitionFlags($sAttCode, $sStimulus, &$aReasons = array(), $sOriginState = '') { @@ -1287,9 +1769,13 @@ abstract class DBObject implements iDisplay * Returns an array of attribute codes (with their flags) when $sStimulus is applied on the object in the $sOriginState state. * Note: Attributes (and flags) from the target state and the transition are combined. * - * @param $sStimulus string - * @param $sOriginState string Default is current state + * @internal + * + * @param string $sStimulus + * @param string $sOriginState Default is current state + * * @return array + * @throws CoreException */ public function GetTransitionAttributes($sStimulus, $sOriginState = null) { @@ -1310,13 +1796,13 @@ abstract class DBObject implements iDisplay * @param string $sAttCode The code of the attribute * @param array $aReasons * - * @return integer The binary combination of the flags for the given attribute for the current state of the object - * considered as an INITIAL state.
- * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php) + * @overwritable-hook You can extend this method in order to provide your own logic + * + * @return integer The binary combination of the flags for the given attribute for the current state of the object considered as an INITIAL state. + * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php) + * * @throws \CoreException * - * @api - * * @see GetAttributeFlags when modifying the object */ public function GetInitialStateAttributeFlags($sAttCode, &$aReasons = array()) @@ -1333,15 +1819,17 @@ abstract class DBObject implements iDisplay /** * Check if the given (or current) value is suitable for the attribute * - * @param $sAttCode - * @param boolean|string $value true if successfull, the error desciption otherwise + * @api + * @api-advanced + * + * @param string $sAttCode + * @param boolean|string $value true if successful, the error description otherwise * * @return bool|string * @throws \ArchivedObjectException * @throws \CoreException * @throws \OQLException * - * @internal */ public function CheckValue($sAttCode, $value = null) { @@ -1476,8 +1964,9 @@ abstract class DBObject implements iDisplay /** * check attributes together * - * @return bool - * @api + * @overwritable-hook You can extend this method in order to provide your own logic. + * + * @return bool */ public function CheckConsistency() { @@ -1485,8 +1974,11 @@ abstract class DBObject implements iDisplay } /** + * @internal + * * @throws \CoreException * @throws \OQLException + * * @since 2.6 N°659 uniqueness constraint */ protected function DoCheckUniqueness() @@ -1524,11 +2016,13 @@ abstract class DBObject implements iDisplay } /** + * + * @internal + * * @param string $sUniquenessRuleId * - * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId - * if none then will use Core:UniquenessDefaultError - * Dictionary keys can contain "$this" placeholders + * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId if none then will use Core:UniquenessDefaultError + * Dictionary keys can contain "$this" placeholders * * @since 2.6 N°659 uniqueness constraint */ @@ -1551,6 +2045,9 @@ abstract class DBObject implements iDisplay } /** + * + * @internal + * * @param string $sUniquenessRuleId uniqueness rule ID * @param array $aUniquenessRuleProperties uniqueness rule properties * @@ -1571,6 +2068,8 @@ abstract class DBObject implements iDisplay } /** + * @internal + * * @param string $sUniquenessRuleId uniqueness rule ID * @param array $aUniquenessRuleProperties uniqueness rule properties * @@ -1613,13 +2112,18 @@ abstract class DBObject implements iDisplay /** * Check integrity rules (before inserting or updating the object) * - * Errors should be inserted in {@link $m_aCheckIssues} and {@link $m_aCheckWarnings} arrays - * + * **This method is not meant to be called directly, use DBObject::CheckToWrite()!** + * Errors should be inserted in $m_aCheckIssues and $m_aCheckWarnings arrays + * + * @overwritable-hook You can extend this method in order to provide your own logic. + * @see CheckToWrite() + * @see $m_aCheckIssues + * @see $m_aCheckWarnings + * * @throws \ArchivedObjectException * @throws \CoreException * @throws \OQLException * - * @api */ public function DoCheckToWrite() { @@ -1674,18 +2178,23 @@ abstract class DBObject implements iDisplay } /** + * + * @api + * @api-advanced + * * @return array containing : - *
-
- *
- {@link $m_bCheckStatus} - *
- {@link $m_aCheckIssues} - *
- {@link $m_bSecurityIssue} - *
+