DBObject

Apply a stimulus (workflow)

public ApplyStimulus($sStimulusCode, $bDoNotWrite = false)

check attributes together

public CheckConsistency()

final public CheckToWrite()

Check if the given (or current) value is suitable for the attribute

public CheckValue($sAttCode, $value = null)

Helper to copy the value of an attribute to another oneSuitable for use as a lifecycle action

public Copy($sDestAttCode, $sSourceAttCode)

Delete an object

First, checks if the object can be deleted regarding database integrity. If the answer is yes, it performs any required cleanup (delete other objects or reset external keys) in addition to the object deletion.

public DBDelete($oDeletionPlan = null)

Persist an object to the DB, for the first time

public DBInsert()

Update an object in DB

public DBUpdate()

Make the current changes persistent - clever wrapper for Insert or Update

public DBWrite()

Check integrity rules (before inserting or updating the object)

This method is not meant to be called directly, use DBObject::CheckToWrite()! Errors should be inserted in $m_aCheckIssues and $m_aCheckWarnings arrays

public DoCheckToWrite()

Getter : get a value from the current object of from a related object

Get the value of the attribute $sAttCode This call may involve an object reload if the object was not completely loaded (lazy loading)

public Get($sAttCode)

Get $sAttCode formatted as CSV

public GetAsCSV($sAttCode, $sSeparator = ',', $sTextQualifier = '"', $bLocalize = true, $bConvertToPlainText = false)

public GetAsHTML($sAttCode, $bLocalize = true)

Get $sAttCode formatted as XML

The returned value is a text that is suitable for insertion into an XML node. Depending on the type of attribute, the returned text is either:

• A literal, with XML entities already escaped,
• XML

public GetAsXML($sAttCode, $bLocalize = true)

Get the flags for the given state

public GetAttributeFlags($sAttCode, $aReasons = array(), $sTargetState = '')

Get the label of a class

Returns the label as defined in the dictionary for the language of the current user

public static GetClassName($sClass)

Return an hyperlink pointing to the current DBObject

public GetHyperlink($sUrlMakerClass = null, $bWithNavigationContext = true, $sLabel = null)

Get the icon representing this object

public GetIcon($bImgTag = true)

public GetInitialStateAttributeFlags($sAttCode, $aReasons = array())

Primary key Getter

Get the id

public GetKey()

Get the label of an attribute.

Shortcut to the field's AttributeDefinition->GetLabel()

public GetLabel($sAttCode)

Helper to get the friendly name in a safe manner for displaying inside a web page

public GetName()

Helper to get the friendly name

This is not safe for displaying inside a web page since the " < > characters are not escaped. In example, the name may contain some XSS script instructions. Use this function only for internal computations or for an output to a non-HTML destination

public GetRawName()

Helper to get the state

public GetState()

Get the description of the state

public GetStateDescription()

Get the label of the current state

public GetStateLabel()

Is the object archived

public IsArchived($sKeyAttCode = null)

Whether or not an object was modified since last read from the DB(ie: does it differ from the DB ?)

public IsModified()

Whether the object is already persisted in DB or not.

public IsNew()

public ListChanges()

public ListPreviousValuesForUpdatedAttributes()

Complete a new object with data from context

public PrefillCreationForm($aContextParam)

Complete a filter data from context (Called on source object)

public PrefillSearchForm($aContextParam)

Complete an object after a state transition with data from context

public PrefillTransitionForm($aContextParam)

Helper to recover the default value (aka when an object is being created)Suitable for use as a lifecycle action

public Reset($sAttCode)

Helper to reset a stop-watchSuitable for use as a lifecycle action

public ResetStopWatch($sAttCode)

Attributes setter

Set $sAttCode to $value. The value must be valid according to the type of attribute. The value will not be recorded into the DB until DBObject::DBWrite() is called.

public Set($sAttCode, $value)

Helper to set the current date/time for the given attributeSuitable for use as a lifecycle action

public SetCurrentDate($sAttCode)

Helper to set the current logged in CONTACT for the given attributeSuitable for use as a lifecycle action

public SetCurrentPerson($sAttCode)

Helper to set the current logged in user for the given attributeSuitable for use as a lifecycle action

public SetCurrentUser($sAttCode)

Helper to set the time elapsed since a reference pointSuitable for use as a lifecycle action

public SetElapsedTime($sAttCode, $sRefAttCode, $sWorkingTimeComputer = null)

Helper to set a value only if it is currently undefined

Call Set() only of the internal representation of the attribute is null.

public SetIfNull($sAttCode, $value)

Helper to set a value that fits the attribute max size

compare $sValue against the field's max size in the database, and truncate it's ending in order to make it fit. If $sValue is short enough, nothing is done.

public SetTrim($sAttCode, $sValue)

this method is called after the object is deleted into DB.

protected AfterDelete()

this method is called after the object is inserted into DB.

protected AfterInsert()

protected AfterUpdate()

this method is called before the object is deleted into DB.

protected OnDelete()

this method is called before the object is inserted into DB.

protected OnInsert()

Used only by insert, Meant to be overloaded

protected OnObjectKeyReady()

this method is called before the object is updated into DB.

protected OnUpdate()