Test/PHPUnit/ControllerTestCase.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Test
version: $Id: ControllerTestCase.php 20484 2010-01-21 18:13:31Z matthew $
Classes: Zend_Test_PHPUnit_ControllerTestCase

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Test_PHPUnit_ControllerTestCase
jump to top

Extends from: PHPUnit_Framework_TestCase
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Test
subpackage: PHPUnit
uses: PHPUnit_Framework_TestCase
Properties: $bootstrap; $_frontController; $_query; $_request; $_response
Methods: __set; __get; setUp; bootstrap; dispatch; reset; _resetPlaceholders; resetRequest; resetResponse; assertQuery; assertNotQuery; assertQueryContentContains; assertNotQueryContentContains; assertQueryContentRegex; assertNotQueryContentRegex; assertQueryCount; assertNotQueryCount; assertQueryCountMin; assertQueryCountMax; assertXpath; assertNotXpath; assertXpathContentContains; assertNotXpathContentContains; assertXpathContentRegex; assertNotXpathContentRegex; assertXpathCount; assertNotXpathCount; assertXpathCountMin; assertXpathCountMax; assertRedirect; assertNotRedirect; assertRedirectTo; assertNotRedirectTo; assertRedirectRegex; assertNotRedirectRegex; assertResponseCode; assertNotResponseCode; assertHeader; assertNotHeader; assertHeaderContains; assertNotHeaderContains; assertHeaderRegex; assertNotHeaderRegex; assertModule; assertNotModule; assertController; assertNotController; assertAction; assertNotAction; assertRoute; assertNotRoute; getFrontController; getRequest; getResponse; getQuery; _incrementAssertionCount

Description

Functional testing scaffold for MVC applications

Properties

$_frontController
jump to class

Zend_Controller_Front $_frontController = ''

Details

$_frontController: Zend_Controller_Front
visibility: protected
default
final: false
static: false

$_query
jump to class

Zend_Dom_Query $_query = ''

Details

$_query: Zend_Dom_Query
visibility: protected
default
final: false
static: false

$_request
jump to class

Zend_Controller_Request_Abstract $_request = ''

Details

$_request: Zend_Controller_Request_Abstract
visibility: protected
default
final: false
static: false

$_response
jump to class

Zend_Controller_Response_Abstract $_response = ''

Details

$_response: Zend_Controller_Response_Abstract
visibility: protected
default
final: false
static: false

$bootstrap
jump to class

mixed $bootstrap = ''

Details

$bootstrap: mixed
Bootstrap file path or callback
visibility: public
default
final: false
static: false

Methods

__get
jump to class

__get(
          mixed $name
          )
        
        :
        void

Overloading for common properties

Provides overloading for request, response, and frontController objects.

Arguments

$name: mixed

Details

visibility: public
final: false
static: false

__set
jump to class

__set(
          string $name, mixed $value
          )
        
        :
        void

Overloading: prevent overloading to special properties

Arguments

$name: string
$value: mixed

Details

visibility: public
final: false
static: false

_incrementAssertionCount
jump to class

_incrementAssertionCount(
          
          )
        
        :
        void

Increment assertion count

Details

visibility: protected
final: false
static: false

_resetPlaceholders
jump to class

_resetPlaceholders(
          
          )
        
        :
        void

Rest all view placeholders

Details

visibility: protected
final: false
static: false

assertAction
jump to class

assertAction(
          string $action, string $message
          )
        
        :
        void

Assert that the last handled request used the given action

Arguments

$action: string
$message: string

Details

visibility: public
final: false
static: false

assertController
jump to class

assertController(
          string $controller, string $message
          )
        
        :
        void

Assert that the last handled request used the given controller

Arguments

$controller: string
$message: string

Details

visibility: public
final: false
static: false

assertHeader
jump to class

assertHeader(
          string $header, string $message
          )
        
        :
        void

Assert response header exists

Arguments

$header: string
$message: string

Details

visibility: public
final: false
static: false

assertHeaderContains
jump to class

assertHeaderContains(
          string $header, string $match, string $message
          )
        
        :
        void

Assert response header exists and contains the given string

Arguments

$header: string
$match: string
$message: string

Details

visibility: public
final: false
static: false

assertHeaderRegex
jump to class

assertHeaderRegex(
          string $header, string $pattern, string $message
          )
        
        :
        void

Assert response header exists and matches the given pattern

Arguments

$header: string
$pattern: string
$message: string

Details

visibility: public
final: false
static: false

assertModule
jump to class

assertModule(
          string $module, string $message
          )
        
        :
        void

Assert that the last handled request used the given module

Arguments

$module: string
$message: string

Details

visibility: public
final: false
static: false

assertNotAction
jump to class

assertNotAction(
          string $action, string $message
          )
        
        :
        void

Assert that the last handled request did NOT use the given action

Arguments

$action: string
$message: string

Details

visibility: public
final: false
static: false

assertNotController
jump to class

assertNotController(
          string $controller, string $message
          )
        
        :
        void

Assert that the last handled request did NOT use the given controller

Arguments

$controller: string
$message: string

Details

visibility: public
final: false
static: false

assertNotHeader
jump to class

assertNotHeader(
          string $header, string $message
          )
        
        :
        void

Assert response header does not exist

Arguments

$header: string
$message: string

Details

visibility: public
final: false
static: false

assertNotHeaderContains
jump to class

assertNotHeaderContains(
          string $header, string $match, string $message
          )
        
        :
        void

Assert response header does not exist and/or does not contain the given string

Arguments

$header: string
$match: string
$message: string

Details

visibility: public
final: false
static: false

assertNotHeaderRegex
jump to class

assertNotHeaderRegex(
          string $header, string $pattern, string $message
          )
        
        :
        void

Assert response header does not exist and/or does not match the given regex

Arguments

$header: string
$pattern: string
$message: string

Details

visibility: public
final: false
static: false

assertNotModule
jump to class

assertNotModule(
          string $module, string $message
          )
        
        :
        void

Assert that the last handled request did NOT use the given module

Arguments

$module: string
$message: string

Details

visibility: public
final: false
static: false

assertNotQuery
jump to class

assertNotQuery(
          string $path, string $message
          )
        
        :
        void

Assert against DOM selection

Arguments

$path: string
CSS selector path
$message: string

Details

visibility: public
final: false
static: false

assertNotQueryContentContains
jump to class

assertNotQueryContentContains(
          string $path, string $match, string $message
          )
        
        :
        void

Assert against DOM selection; node should NOT contain content

Arguments

$path: string
CSS selector path
$match: string
content that should NOT be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertNotQueryContentRegex
jump to class

assertNotQueryContentRegex(
          string $path, string $pattern, string $message
          )
        
        :
        void

Assert against DOM selection; node should NOT match content

Arguments

$path: string
CSS selector path
$pattern: string
pattern that should NOT be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertNotQueryCount
jump to class

assertNotQueryCount(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against DOM selection; should NOT contain exact number of nodes

Arguments

$path: string
CSS selector path
$count: string
Number of nodes that should NOT match
$message: string

Details

visibility: public
final: false
static: false

assertNotRedirect
jump to class

assertNotRedirect(
          string $message
          )
        
        :
        void

Assert that response is NOT a redirect

Arguments

$message: string

Details

visibility: public
final: false
static: false

assertNotRedirectRegex
jump to class

assertNotRedirectRegex(
          string $pattern, string $message
          )
        
        :
        void

Assert that redirect location does not match pattern

Arguments

$pattern: string
$message: string

Details

visibility: public
final: false
static: false

assertNotRedirectTo
jump to class

assertNotRedirectTo(
          string $url, string $message
          )
        
        :
        void

Assert that response does not redirect to given URL

Arguments

$url: string
$message: string

Details

visibility: public
final: false
static: false

assertNotResponseCode
jump to class

assertNotResponseCode(
          int $code, string $message
          )
        
        :
        void

Assert response code

Arguments

$code: int
$message: string

Details

visibility: public
final: false
static: false

assertNotRoute
jump to class

assertNotRoute(
          string $route, string $message
          )
        
        :
        void

Assert that the route matched is NOT as specified

Arguments

$route: string
$message: string

Details

visibility: public
final: false
static: false

assertNotXpath
jump to class

assertNotXpath(
          string $path, string $message
          )
        
        :
        void

Assert against XPath selection

Arguments

$path: string
XPath path
$message: string

Details

visibility: public
final: false
static: false

assertNotXpathContentContains
jump to class

assertNotXpathContentContains(
          string $path, string $match, string $message
          )
        
        :
        void

Assert against XPath selection; node should NOT contain content

Arguments

$path: string
XPath path
$match: string
content that should NOT be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertNotXpathContentRegex
jump to class

assertNotXpathContentRegex(
          string $path, string $pattern, string $message
          )
        
        :
        void

Assert against XPath selection; node should NOT match content

Arguments

$path: string
XPath path
$pattern: string
pattern that should NOT be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertNotXpathCount
jump to class

assertNotXpathCount(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against XPath selection; should NOT contain exact number of nodes

Arguments

$path: string
XPath path
$count: string
Number of nodes that should NOT match
$message: string

Details

visibility: public
final: false
static: false

assertQuery
jump to class

assertQuery(
          string $path, string $message
          )
        
        :
        void

Assert against DOM selection

Arguments

$path: string
CSS selector path
$message: string

Details

visibility: public
final: false
static: false

assertQueryContentContains
jump to class

assertQueryContentContains(
          string $path, string $match, string $message
          )
        
        :
        void

Assert against DOM selection; node should contain content

Arguments

$path: string
CSS selector path
$match: string
content that should be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertQueryContentRegex
jump to class

assertQueryContentRegex(
          string $path, string $pattern, string $message
          )
        
        :
        void

Assert against DOM selection; node should match content

Arguments

$path: string
CSS selector path
$pattern: string
Pattern that should be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertQueryCount
jump to class

assertQueryCount(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against DOM selection; should contain exact number of nodes

Arguments

$path: string
CSS selector path
$count: string
Number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

assertQueryCountMax
jump to class

assertQueryCountMax(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against DOM selection; should contain no more than this number of nodes

Arguments

$path: string
CSS selector path
$count: string
Maximum number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

assertQueryCountMin
jump to class

assertQueryCountMin(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against DOM selection; should contain at least this number of nodes

Arguments

$path: string
CSS selector path
$count: string
Minimum number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

assertRedirect
jump to class

assertRedirect(
          string $message
          )
        
        :
        void

Assert that response is a redirect

Arguments

$message: string

Details

visibility: public
final: false
static: false

assertRedirectRegex
jump to class

assertRedirectRegex(
          string $pattern, string $message
          )
        
        :
        void

Assert that redirect location matches pattern

Arguments

$pattern: string
$message: string

Details

visibility: public
final: false
static: false

assertRedirectTo
jump to class

assertRedirectTo(
          string $url, string $message
          )
        
        :
        void

Assert that response redirects to given URL

Arguments

$url: string
$message: string

Details

visibility: public
final: false
static: false

assertResponseCode
jump to class

assertResponseCode(
          int $code, string $message
          )
        
        :
        void

Assert response code

Arguments

$code: int
$message: string

Details

visibility: public
final: false
static: false

assertRoute
jump to class

assertRoute(
          string $route, string $message
          )
        
        :
        void

Assert that the specified route was used

Arguments

$route: string
$message: string

Details

visibility: public
final: false
static: false

assertXpath
jump to class

assertXpath(
          string $path, string $message
          )
        
        :
        void

Assert against XPath selection

Arguments

$path: string
XPath path
$message: string

Details

visibility: public
final: false
static: false

assertXpathContentContains
jump to class

assertXpathContentContains(
          string $path, string $match, string $message
          )
        
        :
        void

Assert against XPath selection; node should contain content

Arguments

$path: string
XPath path
$match: string
content that should be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertXpathContentRegex
jump to class

assertXpathContentRegex(
          string $path, string $pattern, string $message
          )
        
        :
        void

Assert against XPath selection; node should match content

Arguments

$path: string
XPath path
$pattern: string
Pattern that should be contained in matched nodes
$message: string

Details

visibility: public
final: false
static: false

assertXpathCount
jump to class

assertXpathCount(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against XPath selection; should contain exact number of nodes

Arguments

$path: string
XPath path
$count: string
Number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

assertXpathCountMax
jump to class

assertXpathCountMax(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against XPath selection; should contain no more than this number of nodes

Arguments

$path: string
XPath path
$count: string
Maximum number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

assertXpathCountMin
jump to class

assertXpathCountMin(
          string $path, string $count, string $message
          )
        
        :
        void

Assert against XPath selection; should contain at least this number of nodes

Arguments

$path: string
XPath path
$count: string
Minimum number of nodes that should match
$message: string

Details

visibility: public
final: false
static: false

bootstrap
jump to class

bootstrap(
          
          )
        
        :
        void

Bootstrap the front controller

Resets the front controller, and then bootstraps it.

If {@link $bootstrap} is a callback, executes it; if it is a file, it include's it. When done, sets the test case request and response objects into the front controller.

Details

visibility: public
final: true
static: false

dispatch
jump to class

dispatch(
          string|null $url
              =
              null
          )
        
        :
        void

Dispatch the MVC

If a URL is provided, sets it as the request URI in the request object. Then sets test case request and response objects in front controller, disables throwing exceptions, and disables returning the response. Finally, dispatches the front controller.

Arguments

$url: stringnull

Details

visibility: public
final: false
static: false

getFrontController
jump to class

getFrontController(
          
          )
        
        :
        Zend_Controller_Front

Retrieve front controller instance

Output

Zend_Controller_Front

Details

visibility: public
final: false
static: false

getQuery
jump to class

getQuery(
          
          )
        
        :
        Zend_Dom_Query

Retrieve DOM query object

Output

Zend_Dom_Query

Details

visibility: public
final: false
static: false

getRequest
jump to class

getRequest(
          
          )
        
        :
        Zend_Controller_Request_Abstract

Retrieve test case request object

Output

Zend_Controller_Request_Abstract

Details

visibility: public
final: false
static: false

getResponse
jump to class

getResponse(
          
          )
        
        :
        Zend_Controller_Response_Abstract

Retrieve test case response object

Output

Zend_Controller_Response_Abstract

Details

visibility: public
final: false
static: false

reset
jump to class

Reset MVC state

Creates new request/response objects, resets the front controller instance, and resets the action helper broker.

Details

visibility: public
final: false
static: false
todo: Need to update Zend_Layout to add a resetInstance() method

resetRequest
jump to class

resetRequest(
          
          )
        
        :
        Zend_Test_PHPUnit_ControllerTestCase

Reset the request object

Useful for test cases that need to test multiple trips to the server.

Output

Zend_Test_PHPUnit_ControllerTestCase

Details

visibility: public
final: false
static: false

resetResponse
jump to class

resetResponse(
          
          )
        
        :
        Zend_Test_PHPUnit_ControllerTestCase

Reset the response object

Useful for test cases that need to test multiple trips to the server.

Output

Zend_Test_PHPUnit_ControllerTestCase

Details

visibility: public
final: false
static: false

setUp
jump to class

Set up MVC app

Calls {@link bootstrap()} by default

Details

visibility: protected
final: false
static: false

API Documentation

Test/PHPUnit/ControllerTestCase.php

Description

Zend_Test_PHPUnit_ControllerTestCasejump to top

Description

Properties

$_frontControllerjump to class

Details

$_queryjump to class

Details

$_requestjump to class

Details

$_responsejump to class

Details

$bootstrapjump to class

Details

Methods

__getjump to class

Arguments

Details

__setjump to class

Arguments

Details

_incrementAssertionCountjump to class

Details

_resetPlaceholdersjump to class

Details

assertActionjump to class

Arguments

Details

assertControllerjump to class

Arguments

Details

assertHeaderjump to class

Arguments

Details

assertHeaderContainsjump to class

Arguments

Details

assertHeaderRegexjump to class

Arguments

Details

assertModulejump to class

Arguments

Details

assertNotActionjump to class

Arguments

Details

assertNotControllerjump to class

Arguments

Details

assertNotHeaderjump to class

Arguments

Details

assertNotHeaderContainsjump to class

Arguments

Details

assertNotHeaderRegexjump to class

Arguments

Details

assertNotModulejump to class

Arguments

Details

assertNotQueryjump to class

Arguments

Details

assertNotQueryContentContainsjump to class

Arguments

Details

assertNotQueryContentRegexjump to class

Arguments

Details

assertNotQueryCountjump to class

Arguments

Details

assertNotRedirectjump to class

Arguments

Details

assertNotRedirectRegexjump to class

Arguments

Zend_Test_PHPUnit_ControllerTestCase
jump to top

$_frontController
jump to class

$_query
jump to class

$_request
jump to class

$_response
jump to class

$bootstrap
jump to class

__get
jump to class

__set
jump to class

_incrementAssertionCount
jump to class

_resetPlaceholders
jump to class

assertAction
jump to class

assertController
jump to class

assertHeader
jump to class

assertHeaderContains
jump to class

assertHeaderRegex
jump to class

assertModule
jump to class

assertNotAction
jump to class

assertNotController
jump to class

assertNotHeader
jump to class

assertNotHeaderContains
jump to class

assertNotHeaderRegex
jump to class

assertNotModule
jump to class

assertNotQuery
jump to class

assertNotQueryContentContains
jump to class

assertNotQueryContentRegex
jump to class

assertNotQueryCount
jump to class

assertNotRedirect
jump to class

assertNotRedirectRegex
jump to class

assertNotRedirectTo
jump to class

assertNotResponseCode
jump to class

assertNotRoute
jump to class

assertNotXpath
jump to class

assertNotXpathContentContains
jump to class

assertNotXpathContentRegex
jump to class

assertNotXpathCount
jump to class

assertQuery
jump to class

assertQueryContentContains
jump to class

assertQueryContentRegex
jump to class

assertQueryCount
jump to class

assertQueryCountMax
jump to class

assertQueryCountMin
jump to class

assertRedirect
jump to class

assertRedirectRegex
jump to class

assertRedirectTo
jump to class

assertResponseCode
jump to class

assertRoute
jump to class

assertXpath
jump to class

assertXpathContentContains
jump to class

assertXpathContentRegex
jump to class

assertXpathCount
jump to class

assertXpathCountMax
jump to class