*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
const EXCEPTION_NO_STACKER_FOUND = 0x052;
const EXCEPTION_STACKER_IS_EMPTY = 0x053;
- /**
- * An array holding all stacks
- */
- private $stacks = array();
-
/**
* Protected constructor
*
* Initializes given stacker
*
* @param $stackerName Name of the stack
+ * @param $forceReInit Force re-initialization
* @return void
* @throws AlreadyInitializedStackerException If the stack is already initialized
*/
- public final function initStacker ($stackerName) {
+ public final function initStacker ($stackerName, $forceReInit = FALSE) {
// Is the stack already initialized?
- if ($this->isStackInitialized($stackerName)) {
+ if (($forceReInit === FALSE) && ($this->isStackInitialized($stackerName))) {
// Then throw the exception
throw new AlreadyInitializedStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_ALREADY_INITIALIZED);
} // END - if
// Initialize the given stack
- $this->stacks[$stackerName] = array(
- 'max_size' => $this->getConfigInstance()->getConfigEntry('stacker_' . $stackerName . '_max_size'),
- 'entries' => array()
- );
+ $this->pushValueToGenericArrayElement('stacks', $stackerName, 'max_size', $this->getConfigInstance()->getConfigEntry('stacker_' . $stackerName . '_max_size'));
}
/**
- * Checks wether the given stack is initialized (set in array $stackers)
+ * Checks whether the given stack is initialized (set in array $stackers)
*
* @param $stackerName Name of the stack
- * @return $isInitialized Wether the stack is initialized
+ * @return $isInitialized Whether the stack is initialized
*/
public final function isStackInitialized ($stackerName) {
// Is is there?
- $isInitialized = ((isset($this->stacks[$stackerName])) && (is_array($this->stacks[$stackerName])));
+ $isInitialized = ($this->isValidGenericArrayGroup('stacks', $stackerName));
// Return result
return $isInitialized;
}
/**
- * Checks wether the given stack is full
+ * Checks whether the given stack is full
*
* @param $stackerName Name of the stack
- * @return $isFull Wether the stack is full
+ * @return $isFull Whether the stack is full
* @throws NoStackerException If given stack is missing
*/
protected final function isStackFull ($stackerName) {
}
/**
- * Checks wether the given stack is empty
+ * Checks whether the given stack is empty
*
- * @param $stackerName Name of the stack
- * @return $isEmpty Wether the stack is empty
+ * @param $stackerName Name of the stack
+ * @return $isEmpty Whether the stack is empty
* @throws NoStackerException If given stack is missing
*/
public final function isStackEmpty ($stackerName) {
} // END - if
// So, is the stack empty?
- $isFull = (($this->getStackCount($stackerName)) == 0);
+ $isEmpty = (($this->getStackCount($stackerName)) == 0);
// Return result
- return $isFull;
+ return $isEmpty;
}
/**
} // END - if
// Now, count the array of entries
- $count = count($this->stacks[$stackerName]['entries']);
+ $count = $this->countGenericArrayElements('stacks', $stackerName, 'entries');
// Return result
return $count;
}
// Now add the value to the stack
- array_push($this->stacks[$stackerName]['entries'], $value);
+ $this->pushValueToGenericArrayElement('stacks', $stackerName, 'entries', $value);
}
/**
}
// Now get the last value
- $value = $this->stacks[$stackerName]['entries'][$this->getStackCount($stackerName) - 1];
+ $value = $this->getGenericArrayKey('stacks', $stackerName, 'entries', $this->getStackCount($stackerName) - 1);
// Return it
return $value;
throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
}
- // Now get the last value
- $value = $this->stacks[$stackerName]['entries'][0];
+ // Now get the first value
+ $value = $this->getGenericArrayKey('stacks', $stackerName, 'entries', 0);
// Return it
return $value;
}
// Now, remove the last entry, we don't care about the return value here, see elseif() block above
- array_pop($this->stacks[$stackerName]['entries']);
+ $this->popGenericArrayElement('stacks', $stackerName, 'entries');
}
/**
}
// Now, remove the last entry, we don't care about the return value here, see elseif() block above
- array_shift($this->stacks[$stackerName]['entries']);
+ $this->shiftGenericArrayElement('stacks', $stackerName, 'entries');
}
}