Interface StatusCodeContract

Contract interfaces enforce expected behavior in a non-colliding way. They are tasked with enforcing methods, and extending interfaces provided by standards and other packages for compatibility.

All valid oroboros classes MUST extend at

least one Contract Interface to be considered valid.

oroboros\core\interfaces\contract\utilities\http\StatusCodeContract implements oroboros\core\interfaces\contract\utilities\UtilityContract

Direct known implementers

oroboros\core\abstracts\utilities\http\AbstractStatusCode

Indirect known implementers

oroboros\core\utilities\http\StatusCode

Namespace: oroboros\core\interfaces\contract\utilities\http
Package: oroboros\core\utilities
Category: contract-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4-alpha
Since: 0.2.4-alpha
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
Located at core/interfaces/contract/utilities/http/StatusCodeContract.php

Methods summary

`public`	# `__construct( integer $code = 200 )` Instantiates an object representing a valid http status code, as defined in \oroboros\core\interfaces\enumerated\http\StatusCodes Instantiates an object representing a valid http status code, as defined in \oroboros\core\interfaces\enumerated\http\StatusCodes Parameters `$code` (optional) Sets the status code that the object represents. Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid status code is passed.
`public string`	# `__toString( )` Returns the status code message when the object is cast to a string. Returns the status code message when the object is cast to a string. Returns string
`public integer`	# `getCode( )` Returns the status code Returns the status code Returns integer
`public string`	# `getMessage( )` Returns the current status code title. Returns the current status code title. Returns string
`public`	# `setMessage( mixed $message )` Sets a custom status code title. If this method is not called, the default value will be used. Sets a custom status code title. If this method is not called, the default value will be used. Parameters `$message` Must be either a string, scalar, or any value that can be cast to a non-empty string (eg: object that has method __toString) Throws `oroboros\core\utilities\exception\InvalidArgumentException` if a value is passed that cannot resolve to a string that is not empty

Namespaces

Interfaces

Interface StatusCodeContract

least one Contract Interface to be considered valid.

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Throws

Returns

Returns

Returns

Parameters

Throws