composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-22 10:08:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°729 Update DBObject::Prefill* methods PHPDoc

Browse Source
This commit is contained in:
Pierre Goiffon
2019-10-04 11:09:16 +02:00
parent 23a9bae391
commit f271606e5e
1 changed files with 43 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
core/dbobject.class.php
View File

@@ -5328,10 +5328,18 @@ abstract class DBObject implements iDisplay
/**
* Complete a new object with data from context
*
* @internal
*
* @param array $aContextParam Context used for creation form prefilling
* @overwritable-hook You can extend this method in order to provide your own logic.
*
* @see https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Aform_prefill wiki tutorial
*
* @param array $aContextParam Context used for creation form prefilling. Contains those keys :
* <ul>
* <li>string 'dest_class'
* <li>string 'origin' either console or portal
* <li>DBObject 'source_obj' fixed only when creating an external key object
* </ul>
*
* @since 2.5.0 N°729
*/
public function PrefillCreationForm(&$aContextParam)
{
@@ -5339,24 +5347,40 @@ abstract class DBObject implements iDisplay
/**
* Complete an object after a state transition with data from context
*
* @internal
*
* @param array $aContextParam Context used for creation form prefilling
*
* @overwritable-hook You can extend this method in order to provide your own logic.
*
* @see https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Aform_prefill wiki tutorial
*
* @param array $aContextParam Context used for creation form prefilling. Contains those keys :
* <ul>
* <li>array 'expected_attributes' provides display flags on attributes in the form
* <li>string 'origin' either console or portal
* <li>string 'stimulus' provide the applied stimulus
* </ul>
*
* @since 2.5.0 N°729
*/
public function PrefillTransitionForm(&$aContextParam)
{
}
/**
* Complete a filter ($aContextParam['filter']) data from context
* (Called on source object)
*
* @internal
*
* @param array $aContextParam Context used for creation form prefilling
* Complete a filter data from context (Called on source object)
*
* @overwritable-hook You can extend this method in order to provide your own logic.
*
* @see https://www.itophub.io/wiki/page?id=latest%3Acustomization%3Aform_prefill wiki tutorial
*
* @param array $aContextParam Context used for creation form prefilling. Contains :
* <ul>
* <li>string 'dest_class'
* <li>DBObjectSearch 'filter'
* <li>string 'user' login string of the connected user
* <li>string 'origin' either 'console' or 'portal'
* </ul>
*
* @since 2.5.0 N°729
*/
public function PrefillSearchForm(&$aContextParam)
{
@@ -5364,12 +5388,14 @@ abstract class DBObject implements iDisplay
/**
* Prefill a creation / stimulus change / search form according to context, current state of an object, stimulus.. $sOperation
*
* @internal
*
* @param string $sOperation Operation identifier
*
* @internal
*
* @param array $aContextParam Context used for creation form prefilling
*
* @param string $sOperation Operation identifier
*
* @since 2.5.0 N°729
*/
public function PrefillForm($sOperation, &$aContextParam)
{