class Profile in Zircon Profile 8

Profile.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\Profiler\Profile

3 files declare their use of Profile

AbstractProfilerStorageTest.php in vendor/symfony/http-kernel/Tests/Profiler/AbstractProfilerStorageTest.php

FileProfilerStorageTest.php in vendor/symfony/http-kernel/Tests/Profiler/FileProfilerStorageTest.php

MongoDbProfilerStorageTest.php in vendor/symfony/http-kernel/Tests/Profiler/MongoDbProfilerStorageTest.php

File

vendor/symfony/http-kernel/Profiler/Profile.php, line 21

Namespace

Symfony\Component\HttpKernel\Profiler

class Profile {
  private $token;

  /**
   * @var DataCollectorInterface[]
   */
  private $collectors = array();
  private $ip;
  private $method;
  private $url;
  private $time;
  private $statusCode;

  /**
   * @var Profile
   */
  private $parent;

  /**
   * @var Profile[]
   */
  private $children = array();

  /**
   * Constructor.
   *
   * @param string $token The token
   */
  public function __construct($token) {
    $this->token = $token;
  }

  /**
   * Sets the token.
   *
   * @param string $token The token
   */
  public function setToken($token) {
    $this->token = $token;
  }

  /**
   * Gets the token.
   *
   * @return string The token
   */
  public function getToken() {
    return $this->token;
  }

  /**
   * Sets the parent token.
   *
   * @param Profile $parent The parent Profile
   */
  public function setParent(Profile $parent) {
    $this->parent = $parent;
  }

  /**
   * Returns the parent profile.
   *
   * @return Profile The parent profile
   */
  public function getParent() {
    return $this->parent;
  }

  /**
   * Returns the parent token.
   *
   * @return null|string The parent token
   */
  public function getParentToken() {
    return $this->parent ? $this->parent
      ->getToken() : null;
  }

  /**
   * Returns the IP.
   *
   * @return string The IP
   */
  public function getIp() {
    return $this->ip;
  }

  /**
   * Sets the IP.
   *
   * @param string $ip
   */
  public function setIp($ip) {
    $this->ip = $ip;
  }

  /**
   * Returns the request method.
   *
   * @return string The request method
   */
  public function getMethod() {
    return $this->method;
  }
  public function setMethod($method) {
    $this->method = $method;
  }

  /**
   * Returns the URL.
   *
   * @return string The URL
   */
  public function getUrl() {
    return $this->url;
  }
  public function setUrl($url) {
    $this->url = $url;
  }

  /**
   * Returns the time.
   *
   * @return string The time
   */
  public function getTime() {
    if (null === $this->time) {
      return 0;
    }
    return $this->time;
  }
  public function setTime($time) {
    $this->time = $time;
  }

  /**
   * @param int $statusCode
   */
  public function setStatusCode($statusCode) {
    $this->statusCode = $statusCode;
  }

  /**
   * @return int
   */
  public function getStatusCode() {
    return $this->statusCode;
  }

  /**
   * Finds children profilers.
   *
   * @return Profile[] An array of Profile
   */
  public function getChildren() {
    return $this->children;
  }

  /**
   * Sets children profiler.
   *
   * @param Profile[] $children An array of Profile
   */
  public function setChildren(array $children) {
    $this->children = array();
    foreach ($children as $child) {
      $this
        ->addChild($child);
    }
  }

  /**
   * Adds the child token.
   *
   * @param Profile $child The child Profile
   */
  public function addChild(Profile $child) {
    $this->children[] = $child;
    $child
      ->setParent($this);
  }

  /**
   * Gets a Collector by name.
   *
   * @param string $name A collector name
   *
   * @return DataCollectorInterface A DataCollectorInterface instance
   *
   * @throws \InvalidArgumentException if the collector does not exist
   */
  public function getCollector($name) {
    if (!isset($this->collectors[$name])) {
      throw new \InvalidArgumentException(sprintf('Collector "%s" does not exist.', $name));
    }
    return $this->collectors[$name];
  }

  /**
   * Gets the Collectors associated with this profile.
   *
   * @return DataCollectorInterface[]
   */
  public function getCollectors() {
    return $this->collectors;
  }

  /**
   * Sets the Collectors associated with this profile.
   *
   * @param DataCollectorInterface[] $collectors
   */
  public function setCollectors(array $collectors) {
    $this->collectors = array();
    foreach ($collectors as $collector) {
      $this
        ->addCollector($collector);
    }
  }

  /**
   * Adds a Collector.
   *
   * @param DataCollectorInterface $collector A DataCollectorInterface instance
   */
  public function addCollector(DataCollectorInterface $collector) {
    $this->collectors[$collector
      ->getName()] = $collector;
  }

  /**
   * Returns true if a Collector for the given name exists.
   *
   * @param string $name A collector name
   *
   * @return bool
   */
  public function hasCollector($name) {
    return isset($this->collectors[$name]);
  }
  public function __sleep() {
    return array(
      'token',
      'parent',
      'children',
      'collectors',
      'ip',
      'method',
      'url',
      'time',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Profile::$children	private	property
Profile::$collectors	private	property
Profile::$ip	private	property
Profile::$method	private	property
Profile::$parent	private	property
Profile::$statusCode	private	property
Profile::$time	private	property
Profile::$token	private	property
Profile::$url	private	property
Profile::addChild	public	function	Adds the child token.
Profile::addCollector	public	function	Adds a Collector.
Profile::getChildren	public	function	Finds children profilers.
Profile::getCollector	public	function	Gets a Collector by name.
Profile::getCollectors	public	function	Gets the Collectors associated with this profile.
Profile::getIp	public	function	Returns the IP.
Profile::getMethod	public	function	Returns the request method.
Profile::getParent	public	function	Returns the parent profile.
Profile::getParentToken	public	function	Returns the parent token.
Profile::getStatusCode	public	function
Profile::getTime	public	function	Returns the time.
Profile::getToken	public	function	Gets the token.
Profile::getUrl	public	function	Returns the URL.
Profile::hasCollector	public	function	Returns true if a Collector for the given name exists.
Profile::setChildren	public	function	Sets children profiler.
Profile::setCollectors	public	function	Sets the Collectors associated with this profile.
Profile::setIp	public	function	Sets the IP.
Profile::setMethod	public	function
Profile::setParent	public	function	Sets the parent token.
Profile::setStatusCode	public	function
Profile::setTime	public	function
Profile::setToken	public	function	Sets the token.
Profile::setUrl	public	function
Profile::__construct	public	function	Constructor.
Profile::__sleep	public	function