Overview

Namespaces

  • expect
    • config
    • configurator
    • context
    • factory
    • matcher
      • strategy
    • package
    • registry
    • reporter

Classes

  • expect\config\ConfigurationLoader
  • expect\config\DefaultConfiguration
  • expect\config\RuntimeConfiguration
  • expect\configurator\DefaultConfigurator
  • expect\configurator\FileConfigurator
  • expect\context\DefaultContextFactory
  • expect\context\EvaluateContext
  • expect\Dictionary
  • expect\Expect
  • expect\factory\DefaultMatcherFactory
  • expect\FailedMessage
  • expect\matcher\PatternMatcher
  • expect\matcher\strategy\ArrayInclusionStrategy
  • expect\matcher\strategy\InclusionResult
  • expect\matcher\strategy\StringInclusionStrategy
  • expect\matcher\ToBe
  • expect\matcher\ToBeA
  • expect\matcher\ToBeAbove
  • expect\matcher\ToBeAn
  • expect\matcher\ToBeAnInstanceOf
  • expect\matcher\ToBeArray
  • expect\matcher\ToBeBelow
  • expect\matcher\ToBeBoolean
  • expect\matcher\ToBeEmpty
  • expect\matcher\ToBeFalse
  • expect\matcher\ToBeFalsey
  • expect\matcher\ToBeFloat
  • expect\matcher\ToBeGreaterThan
  • expect\matcher\ToBeInteger
  • expect\matcher\ToBeLessThan
  • expect\matcher\ToBeNull
  • expect\matcher\ToBeString
  • expect\matcher\ToBeTrue
  • expect\matcher\ToBeTruthy
  • expect\matcher\ToBeWithin
  • expect\matcher\ToContain
  • expect\matcher\ToEndWith
  • expect\matcher\ToEqual
  • expect\matcher\ToHaveKey
  • expect\matcher\ToHaveLength
  • expect\matcher\ToMatch
  • expect\matcher\ToPrint
  • expect\matcher\ToStartWith
  • expect\matcher\ToThrow
  • expect\matcher\TruthyMatcher
  • expect\MatcherDictionary
  • expect\MatcherEvaluator
  • expect\MatcherPackage
  • expect\package\DefaultMatcherPackage
  • expect\package\DefaultPackageRegistrar
  • expect\package\MatcherClass
  • expect\package\ReflectionIterator
  • expect\registry\DefaultMatcherRegistry
  • expect\reporter\ExceptionReporter
  • expect\reporter\TextMessageReporter
  • expect\Result

Interfaces

  • expect\Configurable
  • expect\Configuration
  • expect\Configurator
  • expect\Context
  • expect\ContextFactory
  • expect\Evaluator
  • expect\Matcher
  • expect\matcher\ReportableMatcher
  • expect\matcher\strategy\InclusionStrategy
  • expect\MatcherContainer
  • expect\MatcherFactory
  • expect\MatcherRegistry
  • expect\Message
  • expect\PackageRegistrar
  • expect\RegisterablePackage
  • expect\ResultReporter

Traits

  • expect\config\ConfigurableConfiguration
  • expect\matcher\EqualMatcherDelegatable
  • expect\matcher\GreaterThanMatcherDelegatable
  • expect\matcher\LengthMatcherDelegatable
  • expect\matcher\LessThanMatcherDelegatable
  • expect\matcher\TypeMatcherDelegatable
  • expect\MatcherLookupTable

Exceptions

  • expect\config\ConfigurationFileNotFoundException
  • expect\config\NotAvailableException
  • expect\package\ComposerJsonNotFoundException
  • expect\registry\MatcherAlreadyRegisteredException
  • expect\registry\MatcherNotRegisteredException
  • expect\reporter\FailedException

Functions

  • expect\expect
  • Overview
  • Namespace
  • Class
  1: <?php
  2: 
  3: /**
  4:  * This file is part of expect package.
  5:  *
  6:  * (c) Noritaka Horio <holy.shared.design@gmail.com>
  7:  *
  8:  * This source file is subject to the MIT license that is bundled
  9:  * with this source code in the file LICENSE.
 10:  */
 11: namespace expect\matcher;
 12: 
 13: use expect\FailedMessage;
 14: 
 15: /**
 16:  * Verify whether a particular instance.
 17:  *
 18:  * <code>
 19:  * $matcher = new ToBeAnInstanceOf('stdClass');
 20:  * $matcher->match(new stdClass()); //return true
 21:  *
 22:  * $matcher->match(new Exception()); //return false
 23:  * </code>
 24:  *
 25:  * @author Noritaka Horio <holy.shared.design@gmail.com>
 26:  * @copyright Noritaka Horio <holy.shared.design@gmail.com>
 27:  */
 28: final class ToBeAnInstanceOf implements ReportableMatcher
 29: {
 30:     /**
 31:      * @var mixed
 32:      */
 33:     private $actual;
 34: 
 35:     /**
 36:      * @var string
 37:      */
 38:     private $expected;
 39: 
 40:     /**
 41:      * @var string
 42:      */
 43:     private $className;
 44: 
 45:     /**
 46:      * Create a new matcher.
 47:      *
 48:      * @param string $expected
 49:      */
 50:     public function __construct($expected)
 51:     {
 52:         $this->expected = $expected;
 53:     }
 54: 
 55:     /**
 56:      * {@inheritdoc}
 57:      */
 58:     public function match($actual)
 59:     {
 60:         $result = false;
 61:         $this->actual = $actual;
 62: 
 63:         if (is_object($this->actual)) {
 64:             $this->className = get_class($this->actual);
 65:             $result = $this->actual instanceof $this->expected;
 66:         } else {
 67:             $this->className = $actual;
 68:         }
 69: 
 70:         return $result;
 71:     }
 72: 
 73:     /**
 74:      * {@inheritdoc}
 75:      */
 76:     public function reportFailed(FailedMessage $message)
 77:     {
 78:         $message->appendText('Expected ')
 79:             ->appendText($this->className)
 80:             ->appendText(' to be an instance of ')
 81:             ->appendText($this->expected)
 82:             ->appendText("\n\n")
 83:             ->appendText('    expected: ')
 84:             ->appendText($this->expected)
 85:             ->appendText("\n")
 86:             ->appendText('         got: ')
 87:             ->appendText($this->className);
 88:     }
 89: 
 90:     /**
 91:      * {@inheritdoc}
 92:      */
 93:     public function reportNegativeFailed(FailedMessage $message)
 94:     {
 95:         $message->appendText('Expected ')
 96:             ->appendText($this->className)
 97:             ->appendText(' not to be an instance of ')
 98:             ->appendText($this->expected)
 99:             ->appendText("\n\n")
100:             ->appendText('    expected not: ')
101:             ->appendText($this->expected)
102:             ->appendText("\n")
103:             ->appendText('             got: ')
104:             ->appendText($this->className);
105:     }
106: }
107: 
Expect API documentation generated by ApiGen