getID()); } /********************************************************************************* * Getters ********************************************************************************/ /** * Get the description * * @param boolean|int $bbcode_parse_level Should BBCode converted to HTML, before returning * @param int $short_output If this is bigger than 0, than the description will be shortened to this length. * @return string the description */ public function getDescription($bbcode_parse_level = 0/*BBCodeParsingLevel::PARSE*/, int $short_output = 0) : string { $val = htmlspecialchars($this->description); if ($short_output > 0 && \strlen($val) > $short_output) { $val = substr($val, 0, $short_output); $val .= '...'; $val = '' . $val . ''; } //TODO /** if ($bbcode_parse_level === BBCodeParsingLevel::PARSE) { $bbcode = new BBCodeParser(); $val = $bbcode->only('bold', 'italic', 'underline', 'linethrough')->parse($val); } elseif ($bbcode_parse_level === BBCodeParsingLevel::STRIP) { $bbcode = new BBCodeParser(); $val = $bbcode->stripBBCodeTags($val); }*/ return $val; } /** * Get the count of parts which are in stock * @param $with_unknown bool Set this, to true, if the unknown state should be returned as string. Otherwise -2 is returned. * * @return integer|string count of parts which are in stock, "Unknown" if $with_unknown is set and instock is unknown. */ public function getInstock(bool $with_unknown = false) : int { if ($with_unknown && $this->isInstockUnknown()) { return _('[Unbekannt]'); } return $this->instock; } /** * Check if the value of the Instock is unknown. * @return bool True, if the value of the instock is unknown. */ public function isInstockUnknown() : bool { return $this->instock <= static::INSTOCK_UNKNOWN; }/** @noinspection ReturnTypeCanBeDeclaredInspection */ /** * Get the count of parts which must be in stock at least * * @return integer count of parts which must be in stock at least */ public function getMinInstock() : int { return $this->mininstock; } /** * Get the comment * * @param boolean|int $bbcode_parsing_level Should BBCode converted to HTML, before returning * @return string the comment */ public function getComment($bbcode_parsing_level = BBCodeParsingLevel::PARSE) : string { $val = htmlspecialchars($this->comment); //TODO /*if ($bbcode_parsing_level === BBCodeParsingLevel::PARSE) { $bbcode = new BBCodeParser(); $bbcode->setParser('brLinebreak', "/\[br\]/s", '
', ''); $bbcode->setParser('namedlink', '/\[url\=(.*?)\](.*?)\[\/url\]/s', '$2', '$2'); $bbcode->setParser('link', '/\[url\](.*?)\[\/url\]/s', '$1', '$1'); $val = $bbcode->parse($val); } elseif ($bbcode_parsing_level === BBCodeParsingLevel::STRIP) { $bbcode = new BBCodeParser(); $val = str_replace("\n", ' ', $val); $val = $bbcode->stripBBCodeTags($val); }*/ return $val; } /** * Get if this part is obsolete * * @note A Part is marked as "obsolete" if all their orderdetails are marked as "obsolete". * If a part has no orderdetails, the part isn't marked as obsolete. * * @return boolean @li true if this part is obsolete * @li false if this part isn't obsolete * @throws Exception */ public function getObsolete() : bool { $all_orderdetails = $this->getOrderdetails(); if (count($all_orderdetails) == 0) { return false; } foreach ($all_orderdetails as $orderdetails) { if (! $orderdetails->getObsolete()) { return false; } } return true; } /** * Get if this part is visible * * @return boolean @li true if this part is visible * @li false if this part isn't visible */ public function getVisible() : bool { return (bool) $this->visible; } /** * Get if this part is a favorite. * * @return bool * true if this part is a favorite * * false if this part is not a favorite. */ public function getFavorite() : bool { return (bool) $this->favorite; } /** * Get the selected order orderdetails of this part * * @return Orderdetail the selected order orderdetails * @return NULL if there is no order supplier selected * @throws Exception */ public function getOrderOrderdetails() : ?Orderdetail { //TODO /* if ($this->order_orderdetails->getObsolete()) { $this->setOrderOrderdetailsID(null); $this->order_orderdetails = null; }*/ return $this->order_orderdetail; } /** * Get the order quantity of this part * * @return integer the order quantity */ public function getOrderQuantity() : int { return (int) $this->order_quantity; } /** * Get the minimum quantity which should be ordered * * @param boolean $with_devices @li if true, all parts from devices which are marked as "to order" will be included in the calculation * @li if false, only max(mininstock - instock, 0) will be returned * * @return integer the minimum order quantity * @throws Exception */ public function getMinOrderQuantity(bool $with_devices = true) : int { //TODO throw new \Exception("Not implemented yet..."); /** if ($with_devices) { $count_must_order = 0; // for devices with "order_only_missing_parts == false" $count_should_order = 0; // for devices with "order_only_missing_parts == true" $deviceparts = DevicePart::getOrderDeviceParts($this->database, $this->current_user, $this->log, $this->getID()); foreach ($deviceparts as $devicepart) { /** @var $devicepart DevicePart */ /** @var $device Device */ /** $device = $devicepart->getDevice(); if ($device->getOrderOnlyMissingParts()) { $count_should_order += $device->getOrderQuantity() * $devicepart->getMountQuantity(); } else { $count_must_order += $device->getOrderQuantity() * $devicepart->getMountQuantity(); } } return $count_must_order + max(0, $this->getMinInstock() - $this->getInstock() + $count_should_order); } else { return max(0, $this->getMinInstock() - $this->getInstock()); } **/ } /** * Get the "manual_order" attribute * * @return boolean the "manual_order" attribute */ public function getManualOrder() : bool { return (bool) $this->manual_order; } /** * Check if the part is automatically marked for Ordering, because the instock value is smaller than the min instock value. * @return bool True, if the part should be ordered. */ public function getAutoOrder() : bool { //Parts with negative instock never gets ordered. if ($this->getInstock() < 0) { return false; } return $this->getInstock() < $this->getMinInstock(); } /** * Get the link to the website of the article on the manufacturers website * * @param * * @return string the link to the article * @throws Exception */ public function getManufacturerProductUrl(bool $no_auto_url = false) : string { if ($no_auto_url || $this->manufacturer_product_url != '') { return $this->manufacturer_product_url; } elseif (\is_object($this->getManufacturer())) { return $this->getManufacturer()->getAutoProductUrl($this->name); } else { return ''; } // no url is available } /** * Get the category of this part * * There is always a category, for each part! * * @return Category the category of this part */ public function getCategory() : Category { return $this->category; } /** * Get the footprint of this part (if there is one) * * @return Footprint the footprint of this part (if there is one) * @return NULL if this part has no footprint */ public function getFootprint() : ?Footprint { return $this->footprint; } /** * Get the storelocation of this part (if there is one) * * @return Storelocation the storelocation of this part (if there is one) * @return NULL if this part has no storelocation */ public function getStorelocation() : ?Storelocation { return $this->storelocation; } /** * Get the manufacturer of this part (if there is one) * * @return Manufacturer the manufacturer of this part (if there is one) * @return NULL if this part has no manufacturer */ public function getManufacturer() : ?Manufacturer { return $this->manufacturer; } /** * Get the master picture "Attachement"-object of this part (if there is one) * * @return Attachment the master picture Attachement of this part (if there is one) * @return NULL if this part has no master picture */ public function getMasterPictureAttachement() : ?Attachment { return $this->master_picture_attachement; } /** * Get all orderdetails of this part * * @param boolean $hide_obsolete If true, obsolete orderdetails will NOT be returned * * @return Orderdetails[] @li all orderdetails as a one-dimensional array of Orderdetails objects * (empty array if there are no ones) * @li the array is sorted by the suppliers names / minimum order quantity * * @throws Exception if there was an error */ public function getOrderdetails(bool $hide_obsolete = false) { if ($hide_obsolete) { $orderdetails = $this->orderdetails; foreach ($orderdetails as $key => $details) { if ($details->getObsolete()) { unset($orderdetails[$key]); } } return $orderdetails; } else { return $this->orderdetails; } } /** * Get all devices which uses this part * * @return Device[] @li all devices which uses this part as a one-dimensional array of Device objects * (empty array if there are no ones) * @li the array is sorted by the devices names * * @throws Exception if there was an error */ public function getDevices() : array { return $this->devices; } /** * Get all suppliers of this part * * This method simply gets the suppliers of the orderdetails and prepare them.\n * You can get the suppliers as an array or as a string with individual delimeter. * * @param boolean $object_array @li if true, this method returns an array of Supplier objects * @li if false, this method returns an array of strings * @param string|NULL $delimeter @li if this is a string and "$object_array == false", * this method returns a string with all * supplier names, delimeted by "$delimeter" * @param boolean $full_paths @li if true and "$object_array = false", the returned * suppliernames are full paths (path + name) * @li if true and "$object_array = false", the returned * suppliernames are only the names (without path) * @param boolean $hide_obsolete If true, suppliers from obsolete orderdetails will NOT be returned * * @return array all suppliers as a one-dimensional array of Supplier objects * (if "$object_array == true") * @return array all supplier-names as a one-dimensional array of strings * ("if $object_array == false" and "$delimeter == NULL") * @return string a sting of all supplier names, delimeted by $delimeter * ("if $object_array == false" and $delimeter is a string) * * @throws Exception if there was an error */ public function getSuppliers(bool $object_array = true, $delimeter = null, bool $full_paths = false, bool $hide_obsolete = false) { $suppliers = array(); $orderdetails = $this->getOrderdetails($hide_obsolete); foreach ($orderdetails as $details) { $suppliers[] = $details->getSupplier(); } if ($object_array) { return $suppliers; } else { $supplier_names = array(); foreach ($suppliers as $supplier) { /** @var Supplier $supplier */ if ($full_paths) { $supplier_names[] = $supplier->getFullPath(); } else { $supplier_names[] = $supplier->getName(); } } if (\is_string($delimeter)) { return implode($delimeter, $supplier_names); } else { return $supplier_names; } } } /** * Get all supplier-part-Nrs * * This method simply gets the suppliers-part-Nrs of the orderdetails and prepare them.\n * You can get the numbers as an array or as a string with individual delimeter. * * @param string|NULL $delimeter @li if this is a string, this method returns a delimeted string * @li otherwise, this method returns an array of strings * @param boolean $hide_obsolete If true, supplierpartnrs from obsolete orderdetails will NOT be returned * * @return array all supplierpartnrs as an array of strings (if "$delimeter == NULL") * @return string all supplierpartnrs as a string, delimeted ba $delimeter (if $delimeter is a string) * * @throws Exception if there was an error */ public function getSupplierPartNrs($delimeter = null, bool $hide_obsolete = false) { $supplierpartnrs = array(); foreach ($this->getOrderdetails($hide_obsolete) as $details) { $supplierpartnrs[] = $details->getSupplierPartNr(); } if (\is_string($delimeter)) { return implode($delimeter, $supplierpartnrs); } else { return $supplierpartnrs; } } /** * Get all prices of this part * * This method simply gets the prices of the orderdetails and prepare them.\n * In the returned array/string there is a price for every supplier. * * @param boolean $float_array @li if true, the returned array is an array of floats * @li if false, the returned array is an array of strings * @param string|NULL $delimeter if this is a string, this method returns a delimeted string * instead of an array. * @param integer $quantity this is the quantity to choose the correct priceinformation * @param integer|NULL $multiplier @li This is the multiplier which will be applied to every single price * @li If you pass NULL, the number from $quantity will be used * @param boolean $hide_obsolete If true, prices from obsolete orderdetails will NOT be returned * * @return array all prices as an array of floats (if "$delimeter == NULL" & "$float_array == true") * @return array all prices as an array of strings (if "$delimeter == NULL" & "$float_array == false") * @return string all prices as a string, delimeted by $delimeter (if $delimeter is a string) * * @warning If there are orderdetails without prices, for these orderdetails there * will be a "NULL" in the returned float array (or a "-" in the string array)!! * (This is needed for the HTML output, if there are all orderdetails and prices listed.) * * @throws Exception if there was an error */ public function getPrices(bool $float_array = false, $delimeter = null, int $quantity = 1, $multiplier = null, bool $hide_obsolete = false) { $prices = array(); foreach ($this->getOrderdetails($hide_obsolete) as $details) { $prices[] = $details->getPrice(! $float_array, $quantity, $multiplier); } if (\is_string($delimeter)) { return implode($delimeter, $prices); } else { return $prices; } } /** * Get the average price of all orderdetails * * With the $multiplier you're able to multiply the price before it will be returned. * This is useful if you want to have the price as a string with currency, but multiplied with a factor. * * @param boolean $as_money_string @li if true, the retruned value will be a string incl. currency, * ready to print it out. See float_to_money_string(). * @li if false, the returned value is a float * @param integer $quantity this is the quantity to choose the correct priceinformations * @param integer|NULL $multiplier @li This is the multiplier which will be applied to every single price * @li If you pass NULL, the number from $quantity will be used * * @return float price (if "$as_money_string == false") * @return NULL if there are no prices for this part and "$as_money_string == false" * @return string price with currency (if "$as_money_string == true") * * @throws Exception if there was an error */ public function getAveragePrice(bool $as_money_string = false, int $quantity = 1, $multiplier = null) { $prices = $this->getPrices(true, null, $quantity, $multiplier, true); $average_price = null; $count = 0; foreach ($prices as $price) { if ($price !== null) { $average_price += $price; $count++; } } if ($count > 0) { $average_price /= $count; } if ($as_money_string) { return floatToMoneyString($average_price); } else { return $average_price; } } /** * Get the filename of the master picture (absolute path from filesystem root) * * @param boolean $use_footprint_filename @li if true, and this part has no picture, this method * will return the filename of its footprint (if available) * @li if false, and this part has no picture, * this method will return NULL * * @return string the whole path + filename from filesystem root as a UNIX path (with slashes) * @return NULL if there is no picture * * @throws Exception if there was an error */ public function getMasterPictureFilename(bool $use_footprint_filename = false) { $master_picture = $this->getMasterPictureAttachement(); // returns an Attachement-object if (\is_object($master_picture)) { return $master_picture->getFilename(); } if ($use_footprint_filename) { $footprint = $this->getFootprint(); if (\is_object($footprint)) { return $footprint->getFilename(); } } return null; } /** * Parses the selected fields and extract Properties of the part. * @param bool $use_description Use the description field for parsing * @param bool $use_comment Use the comment field for parsing * @param bool $use_name Use the name field for parsing * @param bool $force_output Properties are parsed even if properties are disabled. * @return array A array of PartProperty objects. * @return array If Properties are disabled or nothing was detected, then an empty array is returned. * @throws Exception */ public function getProperties(bool $use_description = true, bool $use_comment = true, bool $use_name = true, bool $force_output = false) : array { //TODO throw new \Exception("Not implemented yet!"); /* global $config; if ($config['properties']['active'] || $force_output) { if ($this->getCategory()->getDisableProperties(true)) { return array(); } $name = array(); $desc = array(); $comm = array(); if ($use_name === true) { $name = $this->getCategory()->getPartnameRegexObj()->getProperties($this->getName()); } if ($use_description === true) { $desc = PartProperty::parseDescription($this->getDescription()); } if ($use_comment === true) { $comm = PartProperty::parseDescription($this->getComment(false)); } return array_merge($name, $desc, $comm); } else { return array(); }*/ } /** * Returns a loop (array) of the array representations of the properties of this part. * @param bool $use_description Use the description field for parsing * @param bool $use_comment Use the comment field for parsing * @return array A array of arrays with the name and value of the properties. */ public function getPropertiesLoop(bool $use_description = true, bool $use_comment = true, bool $use_name = true) : array { //TODO throw new \Exception("Not implemented yet!"); $arr = array(); foreach ($this->getProperties($use_description, $use_comment, $use_name) as $property) { /* @var PartProperty $property */ $arr[] = $property->getArray(true); } return $arr; } /* public function hasValidName() : bool { return self::isValidName($this->getName(), $this->getCategory()); } */ public function getAttachmentTypes() : array { return parent::getAttachmentTypes(); } public function getAttachments($type_id = null, bool $only_table_attachements = false) : array { return parent::getAttachments($type_id, $only_table_attachements); } /******************************************************************************** * * Setters * *********************************************************************************/ /** * Set the description * * @param string $new_description the new description * * @throws Exception if there was an error */ public function setDescription(string $new_description) { $this->description = $new_description; } /** * Set the count of parts which are in stock * * @param integer $new_instock the new count of parts which are in stock * * @throws Exception if the new instock is not valid * @throws Exception if there was an error */ public function setInstock(int $new_instock, $comment = null) { $old_instock = (int) $this->getInstock(); $this->instock = $new_instock; //TODO /* InstockChangedEntry::add( $this->database, $this->current_user, $this->log, $this, $old_instock, $new_instock, $comment );*/ } /** * Withdrawal the given number of parts. * @param $count int The number of parts which should be withdrawan. * @param $comment string A comment that should be associated with the withdrawal. * @throws Exception if there was an error */ public function withdrawalParts(int $count, $comment = null) { if ($count <= 0) { throw new \Exception('Zahl der entnommenen Bauteile muss größer 0 sein!'); } if ($count > $this->getInstock()) { throw new Exception('Es können nicht mehr Bauteile entnommen werden, als vorhanden sind!'); } $old_instock = (int) $this->getInstock(); $new_instock = $old_instock - $count; //TODO /* InstockChangedEntry::add( $this->database, $this->current_user, $this->log, $this, $old_instock, $new_instock, $comment );*/ $this->instock = $new_instock; } /** * Add the given number of parts. * @param $count int The number of parts which should be withdrawan. * @param $comment string A comment that should be associated with the withdrawal. * @throws Exception if there was an error */ public function addParts(int $count, string $comment = null) { //TODO if ($count <= 0) { throw new Exception('Zahl der entnommenen Bauteile muss größer 0 sein!'); } $old_instock = (int) $this->getInstock(); $new_instock = $old_instock + $count; //TODO /* InstockChangedEntry::add( $this->database, $this->current_user, $this->log, $this, $old_instock, $new_instock, $comment );*/ $this->instock = $new_instock; } /** * Set the count of parts which should be in stock at least * * @param integer $new_mininstock the new count of parts which should be in stock at least * * @throws Exception if the new mininstock is not valid * @throws Exception if there was an error */ public function setMinInstock(int $new_mininstock) { $this->mininstock = $new_mininstock; } /** * Set the comment * * @param string $new_comment the new comment * * @throws Exception if there was an error */ public function setComment(string $new_comment) { $this->comment = $new_comment; } /** * Set the "manual_order" attribute * * @param boolean $new_manual_order the new "manual_order" attribute * @param integer $new_order_quantity the new order quantity * @param integer|NULL $new_order_orderdetails_id @li the ID of the new order orderdetails * @li or Zero for "no order orderdetails" * @li or NULL for automatic order orderdetails * (if the part has exactly one orderdetails, * set this orderdetails as order orderdetails. * Otherwise, set "no order orderdetails") * * @throws Exception if there was an error */ public function setManualOrder(bool $new_manual_order, int $new_order_quantity = 1, $new_order_orderdetails_id = null) { $this->manual_order = $new_manual_order; //TODO; /* $this->order_orderdetail = $new_order_orderdetails_id; */ $this->order_quantity = $new_order_quantity; } /** * Set the ID of the order orderdetails * * @param integer|NULL $new_order_orderdetails_id @li the new order orderdetails ID * @li Or, to remove the orderdetails, pass a NULL * * @throws Exception if there was an error */ public function setOrderOrderdetailsID($new_order_orderdetails_id) : void { //TODO throw new \Exception("Not implemented yet..."); } /** * Set the order quantity * * @param integer $new_order_quantity the new order quantity */ public function setOrderQuantity(int $new_order_quantity) : void { $this->order_quantity = $new_order_quantity; } /** * Set the ID of the category * * @note Every part must have a valid category (in contrast to the * attributes "footprint", "storelocation", ...)! * * @param integer $new_category_id the ID of the category * * @throws Exception if the new category ID is not valid * @throws Exception if there was an error */ public function setCategoryID(int $new_category_id) { //TODO throw new \Exception("Not implemented yet!"); } /** * Set the footprint ID * * @param integer|NULL $new_footprint_id @li the ID of the footprint * @li NULL means "no footprint" * * @throws Exception if the new footprint ID is not valid * @throws Exception if there was an error */ public function setFootprintID($new_footprint_id) { //TODO throw new \Exception("Not implemented yet!"); } /** * Set the storelocation ID * * @param integer|NULL $new_storelocation_id @li the ID of the storelocation * @li NULL means "no storelocation" * * @throws Exception if the new storelocation ID is not valid * @throws Exception if there was an error */ public function setStorelocationID($new_storelocation_id) { //TODO throw new \Exception("Not implemented yet!"); } /** * Set the manufacturer ID * * @param integer|NULL $new_manufacturer_id @li the ID of the manufacturer * @li NULL means "no manufacturer" * * @throws Exception if the new manufacturer ID is not valid * @throws Exception if there was an error */ public function setManufacturerID($new_manufacturer_id) { //TODO throw new \Exception("Not implemented yet!"); } /** * Set the favorite status for this part. * @param $new_favorite_status bool The new favorite status, that should be applied on this part. * Set this to true, when the part should be a favorite. */ public function setFavorite(bool $new_favorite_status) { $this->favorite = $new_favorite_status; } /** * Sets the URL to the manufacturer site about this Part. Set to "" if this part should use the automatically URL based on its manufacturer. * @param string $new_url The new url * @throws Exception when an error happens. */ public function setManufacturerProductURL(string $new_url) { $this->manufacturer_product_url = $new_url; } /** * Set the ID of the master picture Attachement * * @param integer|NULL $new_master_picture_attachement_id @li the ID of the Attachement object of the master picture * @li NULL means "no master picture" * * @throws Exception if the new ID is not valid * @throws Exception if there was an error */ public function setMasterPictureAttachementID($new_master_picture_attachement_id) { //TODO throw new \Exception("Not implemented yet!"); } }