Your browser must have JavaScript enabled in order to view this page.
> >
 
Welcome Guest#216 Login/register    Go to Bottom


INSTALL | LICENSE | README | CHANGES | Class Tree | Index
Go to Top

Source for file mass.php

Documentation is available at mass.php

  1. <?php
  2. /**
  3.  * Coinherit for adding mass (volume and weight) abstraction to an object
  4.  *
  5.  * DutchPIPE version 0.4; PHP version 5
  6.  *
  7.  * LICENSE: This source file is subject to version 1.0 of the DutchPIPE license.
  8.  * If you did not receive a copy of the DutchPIPE license, you can obtain one at
  9.  * http://dutchpipe.org/license/1_0.txt or by sending a note to
  10.  * license@dutchpipe.org, in which case you will be mailed a copy immediately.
  11.  *
  12.  * @package    DutchPIPE
  13.  * @subpackage dpuniverse_std
  14.  * @author     Lennert Stock <ls@dutchpipe.org>
  15.  * @copyright  2006, 2007 Lennert Stock
  16.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  17.  * @version    Subversion: $Id: mass.php 277 2007-08-19 18:15:10Z ls $
  18.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  19.  */
  20.  
  21. /**
  22.  * The DutchPIPE property and coinherit system which all objects extend on
  23.  */
  24. inherit(DPUNIVERSE_STD_PATH . 'DpProperties.php');
  25.  
  26. /**
  27.  * Gets mass constants
  28.  */
  29. inherit(DPUNIVERSE_INCLUDE_PATH . 'mass.php');
  30.  
  31. /**
  32.  * Coinherit for adding mass (volume and weight) abstraction to an object
  33.  *
  34.  * Creates the following DutchPIPE properties, depending on settings:<br />
  35.  *
  36.  * - int|float <b>weight</b> - Weight of object without inventory
  37.  * - int|float <b>totalWeight</b> - Weight including inventory, cannot be set
  38.  * - int|float <b>volume</b> - Volume of object
  39.  *
  40.  * @package    DutchPIPE
  41.  * @subpackage dpuniverse_std
  42.  * @author     Lennert Stock <ls@dutchpipe.org>
  43.  * @copyright  2006, 2007 Lennert Stock
  44.  * @license    http://dutchpipe.org/license/1_0.txt  DutchPIPE License
  45.  * @version    Release: 0.2.1
  46.  * @link       http://dutchpipe.org/manual/package/DutchPIPE
  47.  */
  48. class Mass extends DpProperties
  49. {
  50.    /**
  51.      * Mother object which is using this coinherit object
  52.      *
  53.      * @var        object 
  54.      * @access     private
  55.      */
  56.     private $mrMotherObject;
  57.  
  58.     /**
  59.      * Directly set the value of an existing DutchPIPE property
  60.      *
  61.      * @param      object    &$motherObject  Mother object which is using this coinherit object
  62.      * @access     private
  63.      */
  64.     final function __construct(&$motherObject)
  65.     {
  66.         $this->mrMotherObject = $motherObject;
  67.  
  68.         if (WEIGHT_TYPE_NONE !== WEIGHT_TYPE) {
  69.             $this->weight = new_dp_property(0, '_setWeight');
  70.             $this->totalWeight = new_dp_property(0, NULL, '_getTotalWeight');
  71.         }
  72.  
  73.         if (VOLUME_TYPE_NONE !== VOLUME_TYPE) {
  74.             $this->volume = new_dp_property(0, '_setVolume');
  75.         }
  76.     }
  77.  
  78.     /**
  79.      * Sets weight using member overloading if giving value if a valid weight
  80.      *
  81.      * @param      int|float$weight    Weight of this object
  82.      * @access     private
  83.      */
  84.     protected function _setWeight($val)
  85.     {
  86.         if ((is_integer($val) || is_float($val)) && $val >= 0) {
  87.             $this->setDpProperty('weight', $val);
  88.         }
  89.     }
  90.  
  91.     /**
  92.      * Sets volume using member overloading if giving value if a valid weight
  93.      *
  94.      * @param      int|float$weight    Volume of this object
  95.      * @access     private
  96.      */
  97.     protected function _setVolume($val)
  98.     {
  99.         if ((is_integer($val) || is_float($val)) && $val >= 0) {
  100.             $this->setDpProperty('volume', $val);
  101.         }
  102.     }
  103.  
  104.     /**
  105.      * Gets total weight - weight of object including weight of inventory
  106.      *
  107.      * @return     int|floatWeight including inventory
  108.      * @access     private
  109.      */
  110.     protected function _getTotalWeight()
  111.     {
  112.         /* Calculates our own weight plus everything we carry/contain */
  113.         $weight = $this->getDpProperty('weight');
  114.  
  115.         $inv = $this->mrMotherObject->getInventory();
  116.         foreach ($inv as &$ob) {
  117.             $tmp = $ob->weight;
  118.             if (is_int($tmp)) {
  119.                 $weight += $tmp;
  120.             }
  121.         }
  122.  
  123.         return $weight;
  124.     }
  125. }
  126. ?>
Documentation generated on Mon, 03 Sep 2007 22:22:03 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#216
 
 
 
  Go to Top
 
 
 Input Field OptionsClose Input Field Go to Top
 
Legal Notices | Copyright © 2006, 2007 Lennert Stock. All rights reserved. Last update: Mon Sep 03 2007, 21:50 CET.