Classes

File phpboost/event/Contribution.class.php

File phpboost/event/Contribution.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 
<?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.
 * @package     PHPBoost
 * @subpackage  Event
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html 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>
*/

class Contribution extends Event
{
    const CONTRIBUTION_AUTH_BIT = 1;

    /**
     * @var string Description of the contribution (for instance to justify a contribution).
     */
    private $description;

    /**
     * @var string String containing the identifier of the module corresponding to the contribution (ex: forum).
     */
    private $module = '';

    /**
     * @var Date Date at which the contribution has been processed (if it is obviously). Default value: date at which is created the contribution.
     */
    private $fixing_date;

    /**
     * @var array Authorization array containing the people who can treat the contribution.
     */
    private $auth = array();

    /**
     * @var int Identifier of the member who has posted the contribution.
     */
    private $poster_id = 0;

    /**
     * @var int Identifier of the member who has fixed the contribution.
     */
    private $fixer_id = 0;

    /**
     * @var string Login of the member who has posted the contribution.
     */
    private $poster_login = '';

    /**
     * @var string Login of the member who has fixed the contribution.
     */
    private $fixer_login = '';

    /**
     * @var string Level of the member who has posted the contribution.
     */
    private $poster_level = '';

    /**
     * @var string Level of the member who has fixed the contribution.
     */
    private $fixer_level = '';

    /**
     * @var string Groups of the member who has posted the contribution.
     */
    private $poster_groups = '';

    /**
     * @var string Groups of the member who has fixed the contribution.
     */
    private $fixer_groups = '';

    /**
     * Builds a Contribution object.
     */
    public function __construct()
    {
        parent::__construct();
        $this->current_status = Event::EVENT_STATUS_UNREAD;
        $this->creation_date = new Date();
        $this->fixing_date = new Date();
        $this->module = Environment::get_running_module_name();
    }

    /**
     * Builds a contribution object from its whole parameters.
     * @param int $id Contribution id.
     * @param string $entitled Contribution entitled.
     * @param string $fixing_url URL associated to the event.
     * @param string $module Module identifier at which the contribution is attached.
     * @param int status Contribution status.
     * @param Date $creation_date Contribution creation date.
     * @param Date $fixing_date Contribution fixing date.
     * @param mixed[] $auth Auth array determining the people who can treat the contribution.
     * @param int $poster_id Contribution creator id.
     * @param int $fixer_id Contribution fixer id.
     * @param int $id_in_module Id of the element associated to the contribution.
     * @param string $identifier Contribution identifier.
     * @param string $type Contribution type.
     * @param string $poster_login Login of the poster of the contribution.
     * @param string $fixer_login Login of the fixer of the contribution.
     */
    public function build($id, $entitled, $description, $fixing_url, $module, $status, $creation_date, $fixing_date, $auth, $poster_id, $fixer_id, $id_in_module, $identifier, $type, $poster_login = '', $fixer_login = '', $poster_level = '', $fixer_level = '', $poster_groups = '', $fixer_groups = '')
    {
        //Building parent class
        parent::build_event($id, $entitled, $fixing_url, $status, $creation_date, $id_in_module, $identifier, $type);

        //Setting its whole parameters
        $this->description  = $description;
        $this->module       = $module;
        $this->fixing_date  = $fixing_date;
        $this->auth         = $auth;
        $this->poster_id    = $poster_id;
        $this->fixer_id     = $fixer_id;
        $this->poster_login = $poster_login;
        $this->fixer_login  = $fixer_login;
        $this->poster_level = $poster_level;
        $this->fixer_level  = $fixer_level;
        $this->poster_groups = $poster_groups;
        $this->fixer_groups = $fixer_groups;

        //Setting the modification flag to false, it just comes to be loaded
        $this->must_regenerate_cache = false;
    }

    /**
     * Sets the module in which the contribution is used.
     * @param string $module Module identifier (for example the name of the module folder).
     */
    public function set_module($module)
    {
        $this->module = $module;
    }

    /**
     * Sets the fixing date.
     * @param Date $date Date
     */
    public function set_fixing_date($date)
    {
        if (is_object($date) && $date instanceof Date)
        {
            $this->fixing_date = $date;
        }
    }

    /**
     * Set the status of the contribution.
     * @param int $new_current_status One of those elements:
     * <ul>
     *  <li>Event::EVENT_STATUS_UNREAD if it's not read.</li>
     *  <li>Event::EVENT_STATUS_BEING_PROCESSED if the event is beeing processed</li>
     *  <li>Event::EVENT_STATUS_PROCESSED if the event is processed.
     * </ul>
     */
    public function set_status($new_current_status)
    {
        if (in_array($new_current_status, array(Event::EVENT_STATUS_UNREAD, Event::EVENT_STATUS_BEING_PROCESSED, Event::EVENT_STATUS_PROCESSED), TRUE))
        {
            //If it just comes to be processed, we automatically consider it as processed
            if ($this->current_status != Event::EVENT_STATUS_PROCESSED && $new_current_status == Event::EVENT_STATUS_PROCESSED)
            {
                $this->fixing_date = new Date();
                //If the fixer id is not defined, we define it
                if ($this->fixer_id == 0)
                {
                    $this->fixer_id = AppContext::get_current_user()->get_id();
                }
            }

            $this->current_status = $new_current_status;
        }
        //Default
        else
        {
            $this->current_status = Event::EVENT_STATUS_UNREAD;
        }

        $this->must_regenerate_cache = true;
    }

    /**
     * Sets the authorization of the contribution. It will determine who will be able to treat the contribution.
     * @param mixed[] $auth Auth array.
     */
    public function set_auth($auth)
    {
        if (is_array($auth))
        {
            $this->auth = $auth;
        }
    }

    /**
     * Sets the id of the poster.
     * @param int $poster_id Id.
     */
    public function set_poster_id($poster_id)
    {
        if ($poster_id  > 0)
        {
            $this->poster_id = $poster_id;
            //Assigning also the associated display_name
            $this->poster_login = PersistenceContext::get_querier()->get_column_value(DB_TABLE_MEMBER, 'display_name', 'WHERE user_id = :id', array('id' => $poster_id));
        }
    }

    /**
     * Sets the id of the fixer.
     * @param int $fixer_id Id.
     */
    public function set_fixer_id($fixer_id)
    {
        if ($fixer_id  > 0)
        {
            $this->fixer_id = $fixer_id;
            //Assigning also the associated login
            $this->fixer_login = PersistenceContext::get_querier()->get_column_value(DB_TABLE_MEMBER, 'display_name', 'WHERE user_id = :id', array('id' => $fixer_id));
        }
    }

    /**
     * Sets the description of the contribution.
     * @param string $description Description (can be some HTML content).
     */
    public function set_description($description)
    {
        if (is_string($description))
        {
            $this->description = $description;
        }
    }

    /**
     * Gets the description of the contribution.
     * @return string the description
     */
    public function get_description()
    {
        return $this->description;
    }

    /**
     * Gets the module in which the contribution is used.
     * @return string The module identifier (for example the name of its folder).
     */
    public function get_module()
    {
        return $this->module;
    }

    /**
     * Gets the contribution fixing date.
     * @return The date at which the contribution has been treated.
     */
    public function get_fixing_date()
    {
        return $this->fixing_date;
    }

    /**
     * Gets the authorization of treatment of this contribution.
     * @return mixed[] The authorization array.
     */
    public function get_auth()
    {
        return $this->auth;
    }

    /**
     * Gets the identifier of the poster.
     * @return int Its id.
     */
    public function get_poster_id()
    {
        return $this->poster_id;
    }

    /**
     * Gets the identifier of the fixer.
     * @return int Its id.
     */
    public function get_fixer_id()
    {
        return $this->fixer_id;
    }

    /**
     * Gets the poster login.
     * @return string The poster login.
     */
    public function get_poster_login()
    {
        return $this->poster_login;
    }

    /**
     * Gets the fixer login.
     * @return string The fixer login.
     */
    public function get_fixer_login()
    {
        return $this->fixer_login;
    }

    /**
     * Gets the poster level.
     * @return string The poster level.
     */
    public function get_poster_level()
    {
        return $this->poster_level;
    }

    /**
     * Gets the fixer level.
     * @return string The fixer level.
     */
    public function get_fixer_level()
    {
        return $this->fixer_level;
    }

    /**
     * Gets the poster groups.
     * @return string The poster groups.
     */
    public function get_poster_groups()
    {
        return $this->poster_groups;
    }

    /**
     * Gets the fixer groups.
     * @return string The fixer groups.
     */
    public function get_fixer_groups()
    {
        return $this->fixer_groups;
    }

    /**
     * Gets the contribution status name. It's automatically translated in the user language, ready to be displayed.
     * @return string The status name.
     */
    public function get_status_name()
    {
        switch ($this->current_status)
        {
            case Event::EVENT_STATUS_UNREAD:
                return LangLoader::get_message('contribution_status_unread', 'main');
            case Event::EVENT_STATUS_BEING_PROCESSED:
                return LangLoader::get_message('contribution_status_being_processed', 'main');
            case Event::EVENT_STATUS_PROCESSED:
                return LangLoader::get_message('contribution_status_processed', 'main');
        }
    }

    /**
     * Gets the name of the module in which the contribution is used.
     * @return string The module name.
     */
    public function get_module_name()
    {
        if (!empty($this->module))
        {
            $module = ModulesManager::get_module($this->module);

            return $module ? $module->get_configuration()->get_name() : '';
        }
        else
        {
            return '';
        }
    }
}
?>
Annonces