CoreFiles by mySites.guru
BeforePublishEvent.php109 lines, 3,094 bytes, from Joomla_4.2.7-Stable-Full_Package.zip
Raw History Compare with 4.2.6
md5
4a8932c3d25da0254adf95a01901bc81
sha1
9883c01ab029bf749328131cc8613c72c41c2617
sha256
6b63efa1a773da23f1880c30836f8a3c8ad5362d40e537a214609f915e8aa4fe
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2016 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\CMS\Event\Table;

use BadMethodCallException;

// phpcs:disable PSR1.Files.SideEffects
\defined('JPATH_PLATFORM') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Event class for JTable's onBeforePublish event
 *
 * @since  4.0.0
 */
class BeforePublishEvent extends AbstractEvent
{
    /**
     * Constructor.
     *
     * Mandatory arguments:
     * subject      JTableInterface The table we are operating on
     * pks          mixed           An optional array of primary key values to update.
     * state        int             The publishing state. eg. [0 = unpublished, 1 = published]
     * userId       int             The user id of the user performing the operation.
     *
     * @param   string  $name       The event name.
     * @param   array   $arguments  The event arguments.
     *
     * @throws  BadMethodCallException
     */
    public function __construct($name, array $arguments = [])
    {
        if (!\array_key_exists('pks', $arguments)) {
            throw new BadMethodCallException("Argument 'pks' is required for event $name");
        }

        if (!\array_key_exists('state', $arguments)) {
            throw new BadMethodCallException("Argument 'state' is required for event $name");
        }

        if (!\array_key_exists('userId', $arguments)) {
            throw new BadMethodCallException("Argument 'userId' is required for event $name");
        }

        parent::__construct($name, $arguments);
    }

    /**
     * Setter for the pks argument
     *
     * @param   array|null  $value  The value to set
     *
     * @return  mixed
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setQuery($value)
    {
        if (!empty($value) && !\is_array($value)) {
            throw new BadMethodCallException("Argument 'pks' of event {$this->name} must be empty or an array");
        }

        return $value;
    }

    /**
     * Setter for the state argument
     *
     * @param   int  $value  The value to set
     *
     * @return  integer
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setState($value)
    {
        if (!is_numeric($value)) {
            throw new BadMethodCallException("Argument 'state' of event {$this->name} must be an integer");
        }

        return (int) $value;
    }

    /**
     * Setter for the userId argument
     *
     * @param   int  $value  The value to set
     *
     * @return  integer
     *
     * @throws  BadMethodCallException  if the argument is not of the expected type
     */
    protected function setUserId($value)
    {
        if (!is_numeric($value)) {
            throw new BadMethodCallException("Argument 'userId' of event {$this->name} must be an integer");
        }

        return (int) $value;
    }
}

The same content is in 16 releases, Joomla 4.2.7-rc1 to 4.3.1. See them all, or every version of this file.