Class

Contribution

Package: PHPBoost\Event Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2016 10 24 Since: PHPBoost 2.0 - 2008 07 21 Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/event/Contribution.class.php

This class represents a contribution made by a user to complete the content of the website. All the contributions are managed in the contribution panel.

Event
Extended by Contribution
Methods summary
public
# __construct( )

Builds a Contribution object.

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.

public
# set_module( string $module )

Sets the module in which the contribution is used.

public
# set_fixing_date( Date $date )

Sets the fixing date.

public
# set_status( integer $new_current_status )

Set the status of the contribution.

public
# set_auth( mixed[] $auth )

Sets the authorization of the contribution. It will determine who will be able to treat the contribution.

public
# set_poster_id( integer $poster_id )

Sets the id of the poster.

public
# set_fixer_id( integer $fixer_id )

Sets the id of the fixer.

public
# set_description( string $description )

Sets the description of the contribution.

public string
# get_description( )

Gets the description of the contribution.

public string
# get_module( )

Gets the module in which the contribution is used.

public The
# get_fixing_date( )

Gets the contribution fixing date.

public mixed[]
# get_auth( )

Gets the authorization of treatment of this contribution.

public integer
# get_poster_id( )

Gets the identifier of the poster.

public integer
# get_fixer_id( )

Gets the identifier of the fixer.

public string
# get_poster_login( )

Gets the poster login.

public string
# get_fixer_login( )

Gets the fixer login.

public string
# get_poster_level( )

Gets the poster level.

public string
# get_fixer_level( )

Gets the fixer level.

public string
# get_poster_groups( )

Gets the poster groups.

public string
# get_fixer_groups( )

Gets the fixer groups.

public string
# get_status_name( )

Gets the contribution status name. It's automatically translated in the user language, ready to be displayed.

public string
# get_module_name( )

Gets the name of the module in which the contribution is used.

Constants summary
integer CONTRIBUTION_AUTH_BIT
# 1