/**
* {@inheritDoc}
*/
public function addPath($path)
{
if (is_string($path)) {
$this->paths->insert($this->normalizePath($path), 1);
return;
}
if (!is_array($path) && !$path instanceof ArrayAccess) {
throw new Exception\InvalidArgumentException(sprintf('Provided path must be an array or an instance of ArrayAccess, %s given', is_object($path) ? get_class($path) : gettype($path)));
}
if (isset($path['priority']) && isset($path['path'])) {
$this->paths->insert($this->normalizePath($path['path']), $path['priority']);
return;
}
throw new Exception\InvalidArgumentException('Provided array must contain both keys "priority" and "path"');
}
/**
* Make a deep clone of a fieldset
*
* @return void
*/
public function __clone()
{
$items = $this->iterator->toArray(PriorityQueue::EXTR_BOTH);
$this->byName = array();
$this->elements = array();
$this->fieldsets = array();
$this->iterator = new PriorityQueue();
foreach ($items as $item) {
$elementOrFieldset = clone $item['data'];
$name = $elementOrFieldset->getName();
$this->iterator->insert($elementOrFieldset, $item['priority']);
$this->byName[$name] = $elementOrFieldset;
if ($elementOrFieldset instanceof FieldsetInterface) {
$this->fieldsets[$name] = $elementOrFieldset;
} elseif ($elementOrFieldset instanceof ElementInterface) {
$this->elements[$name] = $elementOrFieldset;
}
}
// Also make a deep copy of the object in case it's used within a collection
if (is_object($this->object)) {
$this->object = clone $this->object;
}
}
public function add($elementOrFieldset, $flags = array())
{
if (is_array($elementOrFieldset) || $elementOrFieldset instanceof \Traversable && !$elementOrFieldset instanceof Element) {
$elementOrFieldset = $this->getFormFactory()->create($elementOrFieldset);
}
if (!$elementOrFieldset instanceof Element) {
throw new Exception\InvalidArgumentException(sprintf('%s requires that $elementOrFieldset be an object implementing %s; received "%s"', __METHOD__, __NAMESPACE__ . '\\Element', is_object($elementOrFieldset) ? get_class($elementOrFieldset) : gettype($elementOrFieldset)));
}
$name = $elementOrFieldset->getName();
if ((null === $name || '' === $name) && (!array_key_exists('name', $flags) || $flags['name'] === '')) {
throw new Exception\InvalidArgumentException(sprintf('%s: element or fieldset provided is not named, and no name provided in flags', __METHOD__));
}
if (array_key_exists('name', $flags) && $flags['name'] !== '') {
$name = $flags['name'];
// Rename the element or fieldset to the specified alias
$elementOrFieldset->setName($name);
}
$elementOrFieldset->setForm($this);
$order = 0;
if (array_key_exists('priority', $flags)) {
$order = $flags['priority'];
}
$this->iterator->insert($elementOrFieldset, $order);
$this->byName[$name] = $elementOrFieldset;
if ($elementOrFieldset instanceof Fieldset) {
$this->fieldsetArray[$name] = $elementOrFieldset;
return $this;
}
$this->elementArray[$name] = $elementOrFieldset;
return $this;
}
/**
* Adds a validator to the beginning of the chain
*
* If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain,
* if one exists, will not be executed.
*
* @param ValidatorInterface $validator
* @param bool $breakChainOnFailure
* @return ValidatorChain Provides a fluent interface
*/
public function prependValidator(ValidatorInterface $validator, $breakChainOnFailure = false)
{
$priority = self::DEFAULT_PRIORITY;
if (!$this->validators->isEmpty()) {
$extractedNodes = $this->validators->toArray(PriorityQueue::EXTR_PRIORITY);
rsort($extractedNodes, SORT_NUMERIC);
$priority = $extractedNodes[0] + 1;
}
$this->validators->insert(['instance' => $validator, 'breakChainOnFailure' => (bool) $breakChainOnFailure], $priority);
return $this;
}
/**
* Attach a filter to the chain
*
* @param callable|FilterInterface $callback A Filter implementation or valid PHP callback
* @param int $priority Priority at which to enqueue filter; defaults to 1000 (higher executes earlier)
* @throws Exception\InvalidArgumentException
* @return FilterChain
*/
public function attach($callback, $priority = self::DEFAULT_PRIORITY)
{
if (!is_callable($callback)) {
if (!$callback instanceof FilterInterface) {
throw new Exception\InvalidArgumentException(sprintf('Expected a valid PHP callback; received "%s"', is_object($callback) ? get_class($callback) : gettype($callback)));
}
$callback = array($callback, 'filter');
}
$this->filters->insert($callback, $priority);
return $this;
}
/**
* Adds a validator to the beginning of the chain
*
* If $breakChainOnFailure is true, then if the validator fails, the next validator in the chain,
* if one exists, will not be executed.
*
* @param ValidatorInterface $validator
* @param bool $breakChainOnFailure
* @return ValidatorChain Provides a fluent interface
*/
public function prependValidator(ValidatorInterface $validator, $breakChainOnFailure = false)
{
$priority = self::DEFAULT_PRIORITY;
if (!$this->validators->isEmpty()) {
$queue = $this->validators->getIterator();
$queue->setExtractFlags(PriorityQueue::EXTR_PRIORITY);
$extractedNode = $queue->extract();
$priority = $extractedNode[0] + 1;
}
$this->validators->insert(array('instance' => $validator, 'breakChainOnFailure' => (bool) $breakChainOnFailure), $priority);
return $this;
}
public function __construct(ServiceLocatorInterface $serviceManager, $options = array())
{
$this->serviceManager = $serviceManager;
//set the default theme paths (LIFO order)
$this->themePaths = new PriorityQueue();
if (isset($options['theme_paths'])) {
$priority = 1;
foreach ($options['theme_paths'] as $path) {
$this->themePaths->insert($path, $priority++);
}
}
//set up theme selector adapters (LIFO order)
$this->adapters = new PriorityQueue();
if (isset($options['adapters'])) {
$priority = 1;
foreach ($options['adapters'] as $adapterClass) {
$adapter = new $adapterClass($serviceManager);
$this->adapters->insert($adapter, $priority++);
}
}
}
/**
* Add a JS
* @param string $path
* @param int (optional) $priority
* @return self
*/
public function addJS($path, $priority = self::DEFAULT_ASSET_PRIORITY, $attributes = null)
{
$path = $this->calculateUrl($path, $this->jsPath);
$tagAttributes = array();
$tagAttributes['src'] = $path . '?v=' . $this->jsVersion;
$tagAttributes['type'] = 'text/javascript';
if (isset($attributes) && is_array($attributes)) {
$tagAttributes = array_merge($tagAttributes, $attributes);
}
$tag = new Tag('script', $tagAttributes);
$this->jsQueue->insert($tag, $priority);
return $this;
}
/**
* Adds a collector.
*
* @param Collector\CollectorInterface $collector
* @return self
* @throws Exception\CollectorException
*/
public function addCollector($collector)
{
if (!isset($this->collectors)) {
$this->collectors = new PriorityQueue();
}
if ($collector instanceof Collector\CollectorInterface) {
$this->collectors->insert($collector, $collector->getPriority());
} else {
$error = sprintf('%s must implement CollectorInterface.', get_class($collector));
if ($this->strict === true) {
throw new Exception\CollectorException($error);
}
$this->report->addError($error);
}
return $this;
}
/**
* Make a deep clone of a fieldset
*
* @return void
*/
public function __clone()
{
$this->iterator = new PriorityQueue();
foreach ($this->byName as $key => $value) {
$value = clone $value;
$this->byName[$key] = $value;
$this->iterator->insert($value);
if ($value instanceof FieldsetInterface) {
$this->fieldsets[$key] = $value;
} elseif ($value instanceof ElementInterface) {
$this->elements[$key] = $value;
}
}
// Also make a deep copy of the object in case it's used within a collection
if (is_object($this->object)) {
$this->object = clone $this->object;
}
}
/**
* Add an element or fieldset
*
* $flags could contain metadata such as the alias under which to register
* the element or fieldset, order in which to prioritize it, etc.
*
* @todo Should we detect if the element/fieldset name conflicts?
* @param ElementInterface $elementOrFieldset
* @param array $flags
* @return FieldsetInterface
*/
public function add($elementOrFieldset, array $flags = array())
{
if (!$elementOrFieldset instanceof ElementInterface) {
throw new Exception\InvalidArgumentException(sprintf(
'%s requires that $elementOrFieldset be an object implementing %s; received "%s"',
__METHOD__,
__NAMESPACE__ . '\ElementInterface',
(is_object($elementOrFieldset) ? get_class($elementOrFieldset) : gettype($elementOrFieldset))
));
}
$name = $elementOrFieldset->getName();
if (empty($name) && (!array_key_exists('name', $flags) || empty($flags['name']))) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: element or fieldset provided is not named, and no name provided in flags',
__METHOD__
));
}
if (array_key_exists('name', $flags) && !empty($flags['name'])) {
$name = $flags['name'];
// Rename the element or fieldset to the specified alias
$elementOrFieldset->setName($name);
}
$order = 0;
if (array_key_exists('priority', $flags)) {
$order = $flags['priority'];
}
$this->iterator->insert($elementOrFieldset, $order);
$this->byName[$name] = $elementOrFieldset;
if ($elementOrFieldset instanceof FieldsetInterface) {
$this->fieldsets[$name] = $elementOrFieldset;
return $this;
}
$this->elements[$name] = $elementOrFieldset;
return $this;
}
/**
* @param CartContextInterface $cartContext
* @param int $priority
*/
public function addContext(CartContextInterface $cartContext, $priority = 0)
{
$this->cartContexts->insert($cartContext, $priority);
}
/**
* Create the priority queue
*
* @return void
*/
protected function createPriorityQueue()
{
$queue = new PriorityQueue();
foreach ($this->prioritizedValues as $data) {
// Do not include priority 0 in list
if ($data['priority'] == 0) {
continue;
}
// Hack to ensure priorities are correct; was not treating
// fractional values correctly
$queue->insert($data['media_type'], (double) $data['priority'] * 10);
}
$this->priorityQueue = $queue;
}
/**
* @param LocaleChangeHandlerInterface $localeChangeHandler
* @param int $priority
*/
public function addHandler(LocaleChangeHandlerInterface $localeChangeHandler, $priority = 0)
{
$this->handlers->insert($localeChangeHandler, $priority);
}
/**
* Attach a resolver
*
* @param ResolverInterface $resolver
* @param int $priority
* @return self
*/
public function attach(ResolverInterface $resolver, $priority = 1)
{
$this->queue->insert($resolver, $priority);
}
/**
* Attach a resolver
*
* @param Resolver $resolver
* @param int $priority
* @return AggregateResolver
*/
public function attach(Resolver $resolver, $priority = 1)
{
$this->queue->insert($resolver, $priority);
return $this;
}
/**
* Create the priority queue
*
* @return void
*/
protected function createPriorityQueue()
{
$queue = new PriorityQueue();
foreach ($this->prioritizedValues as $data) {
// Do not include priority 0 in list
if ($data['priority'] == 0) {
continue;
}
// Hack to ensure priorities are correct; was not treating
// fractional values correctly
$suffix = '';
$level = 0;
if (!empty($data['level'])) {
$level = $data['level'];
$suffix = ";level=$level";
}
$queue->insert($data['type'].$suffix, (float) $data['priority'] * 1000 + $level);
}
$this->priorityQueue = $queue;
}
protected function renderEvent($name, EventManagerInterface $eventManager, $profile)
{
$listeners = new PriorityQueue();
foreach ($eventManager->getListeners($name) as $listener) {
$info = $this->getListenerInfo($listener);
$listeners->insert($info, $info['priority']);
}
$sharedEvents = $eventManager->getSharedManager();
foreach ($eventManager->getIdentifiers() as $identifier) {
$sharedListeners = $sharedEvents->getListeners($identifier, $name);
if ($sharedListeners) {
foreach ($sharedListeners as $sharedListener) {
$info = $this->getListenerInfo($sharedListener, $identifier);
$listeners->insert($info, $info['priority']);
}
}
}
$html = '';
foreach ($listeners as $listener) {
$html .= $this->renderListener($listener, $eventManager, $profile);
}
$html = <<<HDOC
<li><span class="name">{$this->escape($name)}</span>
<ol class="listeners">{$html}</ol></li>
HDOC;
return $html;
}
/**
* @param CurrencyChangeHandlerInterface $currencyChangeHandler
* @param int $priority
*/
public function addHandler(CurrencyChangeHandlerInterface $currencyChangeHandler, $priority = 0)
{
$this->handlers->insert($currencyChangeHandler, $priority);
}
/**
* {@inheritdoc}
*/
public function register($service, $priority = 0)
{
$this->assertServiceHaveType($service);
$this->services->insert($service, $priority);
}
/**
* @param RequestResolverInterface $requestResolver
* @param int $priority
*/
public function addResolver(RequestResolverInterface $requestResolver, $priority = 0)
{
$this->requestResolvers->insert($requestResolver, $priority);
}
/**
* @param ChannelContextInterface $channelContext
* @param int $priority
*/
public function addContext(ChannelContextInterface $channelContext, $priority = 0)
{
$this->channelContexts->insert($channelContext, $priority);
}
/**
* Add a converter
*
* @param ConverterInterface $converter
* @param int $priority
*/
public function addConverter(ConverterInterface $converter, $priority = 1)
{
$this->converters->insert($converter, $priority);
return $this;
}
/**
* @param OrderProcessorInterface $orderProcessor
* @param int $priority
*/
public function addProcessor(OrderProcessorInterface $orderProcessor, $priority = 0)
{
$this->orderProcessors->insert($orderProcessor, $priority);
}
public function testCloningAlsoClonesQueue()
{
$foo = new \stdClass();
$foo->name = 'bar';
$queue = new PriorityQueue();
$queue->insert($foo, 1);
$queue->insert($foo, 2);
$queueClone = clone $queue;
while (!$queue->isEmpty()) {
$this->assertSame($foo, $queue->top());
$queue->remove($queue->top());
}
$this->assertTrue($queue->isEmpty());
$this->assertFalse($queueClone->isEmpty());
$this->assertEquals(2, $queueClone->count());
while (!$queueClone->isEmpty()) {
$this->assertSame($foo, $queueClone->top());
$queueClone->remove($queueClone->top());
}
$this->assertTrue($queueClone->isEmpty());
}
/**
* @param CurrencyContextInterface $currencyContext
* @param int $priority
*/
public function addContext(CurrencyContextInterface $currencyContext, $priority = 0)
{
$this->currencyContexts->insert($currencyContext, $priority);
}
/**
* Add listeners to the master queue of listeners
*
* Used to inject shared listeners and wildcard listeners.
*
* @param PriorityQueue $masterListeners
* @param array|Traversable $listeners
* @return void
*/
protected function insertListeners($masterListeners, $listeners)
{
foreach ($listeners as $listener) {
$priority = $listener->getMetadatum('priority');
if (null === $priority) {
$priority = 1;
} elseif (is_array($priority)) {
// If we have an array, likely using PriorityQueue. Grab first
// element of the array, as that's the actual priority.
$priority = array_shift($priority);
}
$masterListeners->insert($listener, $priority);
}
}
/**
* @param StorageInterface $storage
* @param integer $priority
*/
public function add(StorageInterface $storage, $priority = 1)
{
$this->storageChain->insert($storage, $priority);
}
/**
*
* @param \Grid\Core\View\BeforeContentWidget\BeforeContentWidgetInterface $widget
* @return \Grid\Core\View\Helper\BeforeContentWidget
*/
public function addWidget(BeforeContentWidgetInterface $widget)
{
$this->widgets->insert($widget, (int) $widget->getPriority());
return $this;
}
/**
* @param LocaleContextInterface $localeContext
* @param int $priority
*/
public function addContext(LocaleContextInterface $localeContext, $priority = 0)
{
$this->localeContexts->insert($localeContext, $priority);
}
