composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-23 18:48:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Some PHPDoc

Browse Source 
SVN:trunk[5229]
This commit is contained in:
Pierre Goiffon
2018-01-10 14:08:36 +00:00
parent cc08613304
commit 94ba32af57
3 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core/attributedef.class.inc.php
View File

@@ -270,8 +270,10 @@ abstract class AttributeDefinition
*/ */
static public function IsExternalField() {return false;} 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 * @return bool
* @see \DBObject::IsAttributeReadOnlyForCurrentState() for a specific object instance (depending on its workflow)
*/ */
public function IsWritable() {return false;} public function IsWritable() {return false;}
/** /**

17
core/dbobject.class.php
View File

@@ -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 string $sAttCode $sAttCode The code of the attribute
* @param $sAttCode string $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 $aReasons array 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
* @param $sTargetState string The target state in which to evalutate the flags, if empty the current state will be used * used
* @return integer Flags: the binary combination of the flags applicable to this attribute *
*/ * @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 = '') public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '')
{ {
$iFlags = 0; // By default (if no life cycle) no flag at all $iFlags = 0; // By default (if no life cycle) no flag at all

11
core/metamodel.class.php
View File

@@ -1641,6 +1641,17 @@ abstract class MetaModel
return array(); 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) public static function GetAttributeFlags($sClass, $sState, $sAttCode)
{ {
$iFlags = 0; // By default (if no life cycle) no flag at all $iFlags = 0; // By default (if no life cycle) no flag at all