Methods summary
public
|
#
__construct( )
Builds a Contribution object.
Builds a Contribution object.
Overrides
|
public
|
#
build( integer $id, string $entitled, string $description, string $fixing_url, integer $module, Date $status, Date $creation_date, mixed[] $fixing_date, integer $auth, integer $poster_id, integer $fixer_id, string $id_in_module, string $identifier, string $type, string $poster_login = '', $fixer_login = '', $poster_level = '', $fixer_level = '', $poster_groups = '', $fixer_groups = '' )
Builds a contribution object from its whole parameters.
Builds a contribution object from its whole parameters.
Parameters
- $id
- Contribution id.
- $entitled
- Contribution entitled.
- $description
- $fixing_url URL associated to the event.
- $fixing_url
- $module Module identifier at which the contribution is attached.
- $module
- Contribution status.
- $status
- $creation_date Contribution creation date.
- $creation_date
- $fixing_date Contribution fixing date.
- $fixing_date
- $auth Auth array determining the people who can treat the contribution.
- $auth
- $poster_id Contribution creator id.
- $poster_id
- $fixer_id Contribution fixer id.
- $fixer_id
- $id_in_module Id of the element associated to the contribution.
- $id_in_module
- $identifier Contribution identifier.
- $identifier
- $type Contribution type.
- $type
- $poster_login Login of the poster of the contribution.
- $poster_login
- $fixer_login Login of the fixer of the contribution.
- $fixer_login
- $poster_level
- $fixer_level
- $poster_groups
- $fixer_groups
|
public
|
#
set_module( string $module )
Sets the module in which the contribution is used.
Sets the module in which the contribution is used.
Parameters
- $module
- Module identifier (for example the name of the module folder).
|
public
|
|
public
|
#
set_status( integer $new_current_status )
Set the status of the contribution.
Set the status of the contribution.
Parameters
- $new_current_status
One of those elements:
- Event::EVENT_STATUS_UNREAD if it's not read.
- Event::EVENT_STATUS_BEING_PROCESSED if the event is beeing processed
- Event::EVENT_STATUS_PROCESSED if the event is processed.
Overrides
|
public
|
#
set_auth( mixed[] $auth )
Sets the authorization of the contribution. It will determine who will be able to treat the contribution.
Sets the authorization of the contribution. It will determine who will be able to treat the contribution.
Parameters
|
public
|
#
set_poster_id( integer $poster_id )
Sets the id of the poster.
Sets the id of the poster.
Parameters
|
public
|
#
set_fixer_id( integer $fixer_id )
Sets the id of the fixer.
Sets the id of the fixer.
Parameters
|
public
|
#
set_description( string $description )
Sets the description of the contribution.
Sets the description of the contribution.
Parameters
- $description
- Description (can be some HTML content).
|
public
string
|
#
get_description( )
Gets the description of the contribution.
Gets the description of the contribution.
Returns
string the description
|
public
string
|
#
get_module( )
Gets the module in which the contribution is used.
Gets the module in which the contribution is used.
Returns
string The module identifier (for example the name of its folder).
|
public
The
|
#
get_fixing_date( )
Gets the contribution fixing date.
Gets the contribution fixing date.
Returns
The date at which the contribution has been treated.
|
public
mixed[]
|
#
get_auth( )
Gets the authorization of treatment of this contribution.
Gets the authorization of treatment of this contribution.
Returns
mixed[] The authorization array.
|
public
integer
|
#
get_poster_id( )
Gets the identifier of the poster.
Gets the identifier of the poster.
Returns
integer Its id.
|
public
integer
|
#
get_fixer_id( )
Gets the identifier of the fixer.
Gets the identifier of the fixer.
Returns
integer Its id.
|
public
string
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
string
|
#
get_status_name( )
Gets the contribution status name. It's automatically translated in the user language, ready to be displayed.
Gets the contribution status name. It's automatically translated in the user language, ready to be displayed.
Returns
string The status name.
Overrides
|
public
string
|
#
get_module_name( )
Gets the name of the module in which the contribution is used.
Gets the name of the module in which the contribution is used.
Returns
string The module name.
|