diff --git a/core/attributedef.class.inc.php b/core/attributedef.class.inc.php index 53027c091..300e70a0c 100644 --- a/core/attributedef.class.inc.php +++ b/core/attributedef.class.inc.php @@ -270,8 +270,10 @@ abstract class AttributeDefinition */ static public function IsExternalField() {return false;} /** - * Returns true if the attribute can be written (by essence) + * Returns true if the attribute can be written (by essence : metamodel field option) + * * @return bool + * @see \DBObject::IsAttributeReadOnlyForCurrentState() for a specific object instance (depending on its workflow) */ public function IsWritable() {return false;} /** diff --git a/core/dbobject.class.php b/core/dbobject.class.php index d01f770e8..c5fefa728 100644 --- a/core/dbobject.class.php +++ b/core/dbobject.class.php @@ -1048,13 +1048,16 @@ abstract class DBObject implements iDisplay } /** - * Returns the set of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...) - * for the given attribute in the current state of the object - * @param $sAttCode string $sAttCode The code of the attribute - * @param $aReasons array To store the reasons why the attribute is read-only (info about the synchro replicas) - * @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used - * @return integer Flags: the binary combination of the flags applicable to this attribute - */ + * + * @param string $sAttCode $sAttCode The code of the attribute + * @param array $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas) + * @param string $sTargetState The target state in which to evalutate the flags, if empty the current state will be + * used + * + * @return integer the binary combination of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...) for the + * given attribute in the given state of the object + * @throws \CoreException + */ public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '') { $iFlags = 0; // By default (if no life cycle) no flag at all diff --git a/core/metamodel.class.php b/core/metamodel.class.php index d829cd663..a15cb6f74 100644 --- a/core/metamodel.class.php +++ b/core/metamodel.class.php @@ -1641,6 +1641,17 @@ abstract class MetaModel return array(); } + /** + * @param string $sClass + * @param string $sState + * @param string $sAttCode + * + * @return int the binary combination of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...) for the + * given attribute in the given state of the object + * @throws \CoreException + * + * @see \DBObject::GetAttributeFlags() + */ public static function GetAttributeFlags($sClass, $sState, $sAttCode) { $iFlags = 0; // By default (if no life cycle) no flag at all