Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 655 lines (584 sloc) 13.629 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\DependencyInjection;

use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
use Symfony\Component\DependencyInjection\Exception\OutOfBoundsException;

/**
* Definition represents a service definition.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class Definition
{
    private $class;
    private $file;
    private $factoryClass;
    private $factoryMethod;
    private $factoryService;
    private $scope;
    private $properties;
    private $calls;
    private $configurator;
    private $tags;
    private $public;
    private $synthetic;
    private $abstract;

    protected $arguments;

    /**
* Constructor.
*
* @param string $class The service class
* @param array $arguments An array of arguments to pass to the service constructor
*
* @api
*/
    public function __construct($class = null, array $arguments = array())
    {
        $this->class = $class;
        $this->arguments = $arguments;
        $this->calls = array();
        $this->scope = ContainerInterface::SCOPE_CONTAINER;
        $this->tags = array();
        $this->public = true;
        $this->synthetic = false;
        $this->abstract = false;
        $this->properties = array();
    }

    /**
* Sets the name of the class that acts as a factory using the factory method,
* which will be invoked statically.
*
* @param string $factoryClass The factory class name
*
* @return Definition The current instance
*
* @api
*/
    public function setFactoryClass($factoryClass)
    {
        $this->factoryClass = $factoryClass;

        return $this;
    }

    /**
* Gets the factory class.
*
* @return string The factory class name
*
* @api
*/
    public function getFactoryClass()
    {
        return $this->factoryClass;
    }

    /**
* Sets the factory method able to create an instance of this class.
*
* @param string $factoryMethod The factory method name
*
* @return Definition The current instance
*
* @api
*/
    public function setFactoryMethod($factoryMethod)
    {
        $this->factoryMethod = $factoryMethod;

        return $this;
    }

    /**
* Gets the factory method.
*
* @return string The factory method name
*
* @api
*/
    public function getFactoryMethod()
    {
        return $this->factoryMethod;
    }

    /**
* Sets the name of the service that acts as a factory using the factory method.
*
* @param string $factoryService The factory service id
*
* @return Definition The current instance
*
* @api
*/
    public function setFactoryService($factoryService)
    {
        $this->factoryService = $factoryService;

        return $this;
    }

    /**
* Gets the factory service id.
*
* @return string The factory service id
*
* @api
*/
    public function getFactoryService()
    {
        return $this->factoryService;
    }

    /**
* Sets the service class.
*
* @param string $class The service class
*
* @return Definition The current instance
*
* @api
*/
    public function setClass($class)
    {
        $this->class = $class;

        return $this;
    }

    /**
* Gets the service class.
*
* @return string The service class
*
* @api
*/
    public function getClass()
    {
        return $this->class;
    }

    /**
* Sets the arguments to pass to the service constructor/factory method.
*
* @param array $arguments An array of arguments
*
* @return Definition The current instance
*
* @api
*/
    public function setArguments(array $arguments)
    {
        $this->arguments = $arguments;

        return $this;
    }

    /**
* @api
*/
    public function setProperties(array $properties)
    {
        $this->properties = $properties;

        return $this;
    }

    /**
* @api
*/
    public function getProperties()
    {
        return $this->properties;
    }

    /**
* @api
*/
    public function setProperty($name, $value)
    {
        $this->properties[$name] = $value;

        return $this;
    }

    /**
* Adds an argument to pass to the service constructor/factory method.
*
* @param mixed $argument An argument
*
* @return Definition The current instance
*
* @api
*/
    public function addArgument($argument)
    {
        $this->arguments[] = $argument;

        return $this;
    }

    /**
* Sets a specific argument
*
* @param integer $index
* @param mixed $argument
*
* @return Definition The current instance
*
* @api
*/
    public function replaceArgument($index, $argument)
    {
        if ($index < 0 || $index > count($this->arguments) - 1) {
            throw new OutOfBoundsException(sprintf('The index "%d" is not in the range [0, %d].', $index, count($this->arguments) - 1));
        }

        $this->arguments[$index] = $argument;

        return $this;
    }

    /**
* Gets the arguments to pass to the service constructor/factory method.
*
* @return array The array of arguments
*
* @api
*/
    public function getArguments()
    {
        return $this->arguments;
    }

    /**
* Gets an argument to pass to the service constructor/factory method.
*
* @param integer $index
*
* @return mixed The argument value
*
* @api
*/
    public function getArgument($index)
    {
        if ($index < 0 || $index > count($this->arguments) - 1) {
            throw new OutOfBoundsException(sprintf('The index "%d" is not in the range [0, %d].', $index, count($this->arguments) - 1));
        }

        return $this->arguments[$index];
    }

    /**
* Sets the methods to call after service initialization.
*
* @param array $calls An array of method calls
*
* @return Definition The current instance
*
* @api
*/
    public function setMethodCalls(array $calls = array())
    {
        $this->calls = array();
        foreach ($calls as $call) {
            $this->addMethodCall($call[0], $call[1]);
        }

        return $this;
    }

    /**
* Adds a method to call after service initialization.
*
* @param string $method The method name to call
* @param array $arguments An array of arguments to pass to the method call
*
* @return Definition The current instance
*
* @throws InvalidArgumentException on empty $method param
*
* @api
*/
    public function addMethodCall($method, array $arguments = array())
    {
        if (empty($method)) {
            throw new InvalidArgumentException(sprintf('Method name cannot be empty.'));
        }
        $this->calls[] = array($method, $arguments);

        return $this;
    }

    /**
* Removes a method to call after service initialization.
*
* @param string $method The method name to remove
*
* @return Definition The current instance
*
* @api
*/
    public function removeMethodCall($method)
    {
        foreach ($this->calls as $i => $call) {
            if ($call[0] === $method) {
                unset($this->calls[$i]);
                break;
            }
        }

        return $this;
    }

    /**
* Check if the current definition has a given method to call after service initialization.
*
* @param string $method The method name to search for
*
* @return Boolean
*
* @api
*/
    public function hasMethodCall($method)
    {
        foreach ($this->calls as $call) {
            if ($call[0] === $method) {
                return true;
            }
        }

        return false;
    }

    /**
* Gets the methods to call after service initialization.
*
* @return array An array of method calls
*
* @api
*/
    public function getMethodCalls()
    {
        return $this->calls;
    }

    /**
* Sets tags for this definition
*
* @param array $tags
*
* @return Definition the current instance
*
* @api
*/
    public function setTags(array $tags)
    {
        $this->tags = $tags;

        return $this;
    }

    /**
* Returns all tags.
*
* @return array An array of tags
*
* @api
*/
    public function getTags()
    {
        return $this->tags;
    }

    /**
* Gets a tag by name.
*
* @param string $name The tag name
*
* @return array An array of attributes
*
* @api
*/
    public function getTag($name)
    {
        return isset($this->tags[$name]) ? $this->tags[$name] : array();
    }

    /**
* Adds a tag for this definition.
*
* @param string $name The tag name
* @param array $attributes An array of attributes
*
* @return Definition The current instance
*
* @api
*/
    public function addTag($name, array $attributes = array())
    {
        $this->tags[$name][] = $attributes;

        return $this;
    }

    /**
* Whether this definition has a tag with the given name
*
* @param string $name
*
* @return Boolean
*
* @api
*/
    public function hasTag($name)
    {
        return isset($this->tags[$name]);
    }

    /**
* Clears all tags for a given name.
*
* @param string $name The tag name
*
* @return Definition
*/
    public function clearTag($name)
    {
        if (isset($this->tags[$name])) {
            unset($this->tags[$name]);
        }

        return $this;
    }

    /**
* Clears the tags for this definition.
*
* @return Definition The current instance
*
* @api
*/
    public function clearTags()
    {
        $this->tags = array();

        return $this;
    }

    /**
* Sets a file to require before creating the service.
*
* @param string $file A full pathname to include
*
* @return Definition The current instance
*
* @api
*/
    public function setFile($file)
    {
        $this->file = $file;

        return $this;
    }

    /**
* Gets the file to require before creating the service.
*
* @return string The full pathname to include
*
* @api
*/
    public function getFile()
    {
        return $this->file;
    }

    /**
* Sets the scope of the service
*
* @param string $scope Whether the service must be shared or not
*
* @return Definition The current instance
*
* @api
*/
    public function setScope($scope)
    {
        $this->scope = $scope;

        return $this;
    }

    /**
* Returns the scope of the service
*
* @return string
*
* @api
*/
    public function getScope()
    {
        return $this->scope;
    }

    /**
* Sets the visibility of this service.
*
* @param Boolean $boolean
*
* @return Definition The current instance
*
* @api
*/
    public function setPublic($boolean)
    {
        $this->public = (Boolean) $boolean;

        return $this;
    }

    /**
* Whether this service is public facing
*
* @return Boolean
*
* @api
*/
    public function isPublic()
    {
        return $this->public;
    }

    /**
* Sets whether this definition is synthetic, that is not constructed by the
* container, but dynamically injected.
*
* @param Boolean $boolean
*
* @return Definition the current instance
*
* @api
*/
    public function setSynthetic($boolean)
    {
        $this->synthetic = (Boolean) $boolean;

        return $this;
    }

    /**
* Whether this definition is synthetic, that is not constructed by the
* container, but dynamically injected.
*
* @return Boolean
*
* @api
*/
    public function isSynthetic()
    {
        return $this->synthetic;
    }

    /**
* Whether this definition is abstract, that means it merely serves as a
* template for other definitions.
*
* @param Boolean $boolean
*
* @return Definition the current instance
*
* @api
*/
    public function setAbstract($boolean)
    {
        $this->abstract = (Boolean) $boolean;

        return $this;
    }

    /**
* Whether this definition is abstract, that means it merely serves as a
* template for other definitions.
*
* @return Boolean
*
* @api
*/
    public function isAbstract()
    {
        return $this->abstract;
    }

    /**
* Sets a configurator to call after the service is fully initialized.
*
* @param mixed $callable A PHP callable
*
* @return Definition The current instance
*
* @api
*/
    public function setConfigurator($callable)
    {
        $this->configurator = $callable;

        return $this;
    }

    /**
* Gets the configurator to call after the service is fully initialized.
*
* @return mixed The PHP callable to call
*
* @api
*/
    public function getConfigurator()
    {
        return $this->configurator;
    }
}
Something went wrong with that request. Please try again.