StockMvtReason.php

<?php
/*
* 2007-2012 PrestaShop
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to http://www.prestashop.com for more information.
*
*  @author PrestaShop SA <contact@prestashop.com>
*  @copyright  2007-2012 PrestaShop SA
*  @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
*  International Registered Trademark & Property of PrestaShop SA
*/

class StockMvtReasonCore extends ObjectModel
{
	/** @var int identifier of the movement reason */
	public $id;

	/** @var string the name of the movement reason */
	public $name;

	/** @var int detrmine if the movement reason correspond to a positive or negative operation */
	public $sign;

	/** @var string the creation date of the movement reason */
	public $date_add;

	/** @var string the last update date of the movement reason */
	public $date_upd;

	/** @var boolean True if the movement reason has been deleted (staying in database as deleted) */
	public $deleted = 0;

	/**
	 * @since 1.5.0
	 * @see ObjectModel::$definition
	 */
	public static $definition = array(
		'table' => 'stock_mvt_reason',
		'primary' => 'id_stock_mvt_reason',
		'multilang' => true,
		'fields' => array(
			'sign' => 		array('type' => self::TYPE_INT),
			'deleted' => 	array('type' => self::TYPE_BOOL),
			'date_add' => 	array('type' => self::TYPE_DATE, 'validate' => 'isDate'),
			'date_upd' => 	array('type' => self::TYPE_DATE, 'validate' => 'isDate'),
			'name' => 		array('type' => self::TYPE_STRING, 'lang' => true, 'validate' => 'isGenericName', 'required' => true, 'size' => 255),
		),
	);

	/**
	 * @see ObjectModel::$webserviceParameters
	 */
	protected $webserviceParameters = array(
		'objectsNodeName' => 'stock_movement_reasons',
		'objectNodeName' => 'stock_movement_reason',
		'fields' => array(
			'sign' => array(),
		),
	);

	/**
	 * Gets Stock Mvt Reasons
	 *
	 * @param int $id_lang
	 * @param int $sign Optionnal
	 * @return array
	 */
	public static function getStockMvtReasons($id_lang, $sign = null)
	{
		$query = new DbQuery();
		$query->select('smrl.name, smr.id_stock_mvt_reason, smr.sign');
		$query->from('stock_mvt_reason', 'smr');
		$query->leftjoin('stock_mvt_reason_lang', 'smrl', 'smr.id_stock_mvt_reason = smrl.id_stock_mvt_reason AND smrl.id_lang='.(int)$id_lang);
		$query->where('smr.deleted = 0');

		if ($sign != null)
			$query->where('smr.sign = '.(int)$sign);

		return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($query);
	}

	/**
	 * Same as StockMvtReason::getStockMvtReasons(), ignoring a specific lists of ids
	 *
	 * @since 1.5.0
	 * @param int $id_lang
	 * @param array $ids_ignore
	 * @param int $sign optional
	 */
	public static function getStockMvtReasonsWithFilter($id_lang, $ids_ignore, $sign = null)
	{
		$query = new DbQuery();
		$query->select('smrl.name, smr.id_stock_mvt_reason, smr.sign');
		$query->from('stock_mvt_reason', 'smr');
		$query->leftjoin('stock_mvt_reason_lang', 'smrl', 'smr.id_stock_mvt_reason = smrl.id_stock_mvt_reason AND smrl.id_lang='.(int)$id_lang);
		$query->where('smr.deleted = 0');

		if ($sign != null)
			$query->where('smr.sign = '.(int)$sign);

		if (count($ids_ignore))
		{
			$ids_ignore = array_map('intval', $ids_ignore);
			$query->where('smr.id_stock_mvt_reason NOT IN('.implode(', ', $ids_ignore).')');
		}

		return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($query);
	}

	/**
	 * For a given id_stock_mvt_reason, tells if it exists
	 *
	 * @since 1.5.0
	 * @param int $id_stock_mvt_reason
	 * @return bool
	 */
	public static function exists($id_stock_mvt_reason)
	{
		$query = new DbQuery();
		$query->select('smr.id_stock_mvt_reason');
		$query->from('stock_mvt_reason', 'smr');
		$query->where('smr.id_stock_mvt_reason = '.(int)$id_stock_mvt_reason);
		$query->where('smr.deleted = 0');

		return Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue($query);
	}
}