* Does the specified offset exist in cache?
*
* @param $offset The offset we are looking for
- * @return $exists Wether the offset exists
+ * @return $exists Whether the offset exists
*/
function offsetExists($offset);
function getField ($fieldName);
/**
- * Checks wether an object equals this object. You should overwrite this
+ * Checks whether an object equals this object. You should overwrite this
* method to implement own equality checks
*
* @param $objectInstance An instance of a FrameworkInterface object
- * @return $equals Wether both objects equals
+ * @return $equals Whether both objects equals
*/
function equals (FrameworkInterface $objectInstance);
*/
interface BookablePoints extends FrameworkInterface {
/**
- * Checks wether the user has the required amount of points left for the specified action
+ * Checks whether the user has the required amount of points left for the specified action
*
* @param $action The action or configuration entry plus prefix the user wants to perform
- * @return $hasRequired Wether the user has the required points
+ * @return $hasRequired Whether the user has the required points
*/
function ifUserHasRequiredPoints ($action);
*/
interface Register extends FrameworkInterface {
/**
- * Checks wether an instance key was found
+ * Checks whether an instance key was found
*
* @param $instanceKey The key holding an instance in registry
- * @return $exists Wether the key exists in registry
+ * @return $exists Whether the key exists in registry
*/
function instanceExists ($instanceKey);
*/
interface RegisterableSocket extends Registerable {
/**
- * Checks wether given socket resource is registered. If $socketResource is
+ * Checks whether given socket resource is registered. If $socketResource is
* false only the instance will be checked.
*
* @param $protocolInstance An instance of a ProtocolHandler class
* @param $socketResource A valid socket resource
- * @return $isRegistered Wether the given socket resource is registered
+ * @return $isRegistered Whether the given socket resource is registered
*/
function isSocketRegistered (ProtocolHandler $protocolInstance, $socketResource);
function prepareRequestData ();
/**
- * Checks wether a request element is set
+ * Checks whether a request element is set
* @param $element Name of the request element we want to check
- * @return $isSet Wether the request element is set
+ * @return $isSet Whether the request element is set
* @throws MissingArrayElementsException Thrown if a request element is not set
*/
function isRequestElementSet ($element);
function getHeader ($headerName);
/**
- * Sets wether the request was valid (default: true)
+ * Sets whether the request was valid (default: true)
*
- * @param $isValid Wether the request is valid
+ * @param $isValid Whether the request is valid
* @return void
*/
function requestIsValid ($isValid = true);
function resolveActionByRequest (Requestable $requestInstance);
/**
- * Checks wether the given action is valid
+ * Checks whether the given action is valid
*
* @param $actionName The default action we shall execute
- * @return $isValid Wether the given action is valid
+ * @return $isValid Whether the given action is valid
* @throws EmptyVariableException Thrown if given action is not set
*/
function isActionValid ($actionName);
function resolveCommandByRequest (Requestable $requestInstance);
/**
- * Checks wether the given command is valid
+ * Checks whether the given command is valid
*
* @param $commandName The default command we shall execute
- * @return $isValid Wether the given command is valid
+ * @return $isValid Whether the given command is valid
* @throws EmptyVariableException Thrown if given command is not set
*/
function isCommandValid ($commandName);
static function resolveStateByPackage (ConnectionHelper $helperInstance, array $packageData, $socketResource);
/**
- * Checks wether the given state is valid
+ * Checks whether the given state is valid
*
* @param $stateName The default state we shall execute
- * @return $isValid Wether the given state is valid
+ * @return $isValid Whether the given state is valid
* @throws EmptyVariableException Thrown if given state is not set
*/
function isStateValid ($stateName);
/**
* Flushs the cached HTTP response to the outer world
*
- * @param $force Wether we shall force the output or abort if headers are
+ * @param $force Whether we shall force the output or abort if headers are
* already sent with an exception
* @return void
* @throws ResponseHeadersAlreadySentException Thrown if headers are
function getNamed ($stackerName);
/**
- * Checks wether the given stack is initialized (set in array $stackers)
+ * Checks whether the given stack is initialized (set in array $stackers)
*
* @param $stackerName Name of the stack
- * @return $isInitialized Wether the stack is initialized
+ * @return $isInitialized Whether the stack is initialized
*/
function isStackInitialized ($stackerName);
/**
- * Checks wether the given stack is empty
+ * Checks whether the given stack is empty
*
* @param $stackerName Name of the stack
- * @return $isEmpty Wether the stack is empty
+ * @return $isEmpty Whether the stack is empty
* @throws NoStackerException If given stack is missing
*/
function isStackEmpty ($stackerName);
function enableLanguageSupport ($languageSupport = true);
/**
- * Checks wether language support is enabled
+ * Checks whether language support is enabled
*
- * @return $languageSupport Wether language support is enabled or disabled
+ * @return $languageSupport Whether language support is enabled or disabled
*/
function isLanguageSupportEnabled ();
function enableXmlCompacting ($xmlCompacting = true);
/**
- * Checks wether XML compacting is enabled
+ * Checks whether XML compacting is enabled
*
- * @return $xmlCompacting Wether XML compacting is enabled or disabled
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
*/
function isXmlCompactingEnabled ();
*/
interface ManageableAccount extends FrameworkInterface {
/**
- * Determines wether the username exists or not
+ * Determines whether the username exists or not
*
- * @return $exists Wether the username exists
+ * @return $exists Whether the username exists
*/
function ifUsernameExists ();
/**
- * Determines wether the email exists or not
+ * Determines whether the email exists or not
*
- * @return $exists Wether the email exists
+ * @return $exists Whether the email exists
*/
function ifEmailAddressExists ();
* database.
*
* @param $requestInstance A requestable class instance
- * @return $matches Wether the supplied password hash matches
+ * @return $matches Whether the supplied password hash matches
*/
function ifPasswordHashMatches (Requestable $requestInstance);
}
* Does the specified offset exist in cache?
*
* @param $offset The offset we are looking for
- * @return $exists Wether the offset exists
+ * @return $exists Whether the offset exists
*/
public function offsetExists ($offset) {
$exists = $this->dataCache->offsetExists($offset);
}
/**
- * Checks wether an object equals this object. You should overwrite this
+ * Checks whether an object equals this object. You should overwrite this
* method to implement own equality checks
*
* @param $objectInstance An instance of a FrameworkInterface object
- * @return $equals Wether both objects equals
+ * @return $equals Whether both objects equals
*/
public function equals (FrameworkInterface $objectInstance) {
// Now test it
}
/**
- * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
+ * Outputs a debug message whether to debug instance (should be set!) or dies with or pints the message
*
* @param $message Message we shall send out...
- * @param $doPrint Wether we shall print or die here which first is the default
+ * @param $doPrint Whether we shall print or die here which first is the default
* @return void
*/
public function debugOutput ($message, $doPrint = true) {
}
/**
- * Checks wether the given PHP extension is loaded
+ * Checks whether the given PHP extension is loaded
*
* @param $phpExtension The PHP extension we shall check
- * @return $isLoaded Wether the PHP extension is loaded
+ * @return $isLoaded Whether the PHP extension is loaded
*/
public final function isPhpExtensionLoaded ($phpExtension) {
// Is it loaded?
/**
* Idles (sleeps) for given milliseconds
*
- * @return $hasSlept Wether it goes fine
+ * @return $hasSlept Whether it goes fine
*/
public function idle ($milliSeconds) {
// Sleep is fine by default
}
/**
- * Checks wether the given encoded data was encoded with Base64
+ * Checks whether the given encoded data was encoded with Base64
*
* @param $encodedData Encoded data we shall check
- * @return $isBase64 Wether the encoded data is Base64
+ * @return $isBase64 Whether the encoded data is Base64
*/
protected function isBase64Encoded ($encodedData) {
// Determine it
}
/**
- * Checks wether the given address (IP) matches with the one from the socket resource
+ * Checks whether the given address (IP) matches with the one from the socket resource
*
* @param $addressPort The address:port (IP to check
- * @return $matches Wether $address matches with the one from socket resource
+ * @return $matches Whether $address matches with the one from socket resource
*/
public final function ifAddressMatches ($addressPort) {
// Get current package data
* Get criteria element or null if not found
*
* @param $criteria The criteria we want to have
- * @return $value Wether the value of the critera or null
+ * @return $value Whether the value of the critera or null
*/
public function getCriteriaElemnent ($criteria) {
// Default is not found
}
/**
- * Checks wether given array entry matches
+ * Checks whether given array entry matches
*
* @param $entryArray Array with the entries to find
- * @return $matches Wether the entry matches or not
+ * @return $matches Whether the entry matches or not
*/
public function ifEntryMatches (array $entryArray) {
// First nothing matches and nothing is counted
private $lastContents = array();
/**
- * Wether the "connection is already up
+ * Whether the "connection is already up
*/
private $alreadyConnected = false;
* Settter for variable group
*
* @param $groupName Name of variable group
- * @param $add Wether add this group
+ * @param $add Whether add this group
* @return void
*/
public function setVariableGroup ($groupName, $add = true) {
}
/**
- * Checks wether language support is enabled
+ * Checks whether language support is enabled
*
- * @return $languageSupport Wether language support is enabled or disabled
+ * @return $languageSupport Whether language support is enabled or disabled
*/
public final function isLanguageSupportEnabled () {
// Call the inner class' method
}
/**
- * Checks wether XML compacting is enabled
+ * Checks whether XML compacting is enabled
*
- * @return $xmlCompacting Wether XML compacting is enabled or disabled
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
*/
public final function isXmlCompactingEnabled () {
// Call the inner class' method
}
/**
- * Check wether the email as already been taken
+ * Check whether the email as already been taken
*
* @param $email Email to check for existence
- * @return $alreadyTaken Wether the email has been taken
+ * @return $alreadyTaken Whether the email has been taken
*/
private function ifEmailIsTaken ($email) {
// Default is already taken
}
/**
- * Check wether the username as already been taken
+ * Check whether the username as already been taken
*
* @param $userName Username to check for existence
- * @return $alreadyTaken Wether the username has been taken
+ * @return $alreadyTaken Whether the username has been taken
*/
private function ifUserNameIsTaken ($userName) {
// Default is already taken
}
/**
- * Check wether the username as already been taken
+ * Check whether the username as already been taken
*
* @param $userName Username to check for existence
- * @return $alreadyTaken Wether the username has been taken
+ * @return $alreadyTaken Whether the username has been taken
*/
private function ifUserGuestIsTaken ($userName) {
// Default is already taken
}
/**
- * Check wether the username as already been taken
+ * Check whether the username as already been taken
*
* @param $userName Username to check for existence
- * @return $alreadyTaken Wether the username has been taken
+ * @return $alreadyTaken Whether the username has been taken
*/
private function ifUserNameIsTaken ($userName) {
// Default is already taken
}
/**
- * Checks wether the specified group is opened
+ * Checks whether the specified group is opened
*
* @param $groupId Id of group to check
- * @return $isOpened Wether the specified group is open
+ * @return $isOpened Whether the specified group is open
*/
protected function ifGroupIsOpened ($groupId) {
// Is the group open?
}
/**
- * Check wether a group was opened previously
+ * Check whether a group was opened previously
*
- * @return $groupOpened Wether any group was opened before
+ * @return $groupOpened Whether any group was opened before
*/
protected final function ifGroupOpenedPreviously () {
$groupOpened = (!empty($this->previousGroupId));
}
/**
- * Check wether a group was opened previously
+ * Check whether a group was opened previously
*
- * @return $subGroupOpened Wether any group was opened before
+ * @return $subGroupOpened Whether any group was opened before
*/
protected final function ifSubGroupOpenedPreviously () {
$subGroupOpened = (!empty($this->previousSubGroupId));
}
/**
- * Checks wether include registration date in this block
+ * Checks whether include registration date in this block
*
- * @return $withRegistration Wether with registration date
+ * @return $withRegistration Whether with registration date
*/
public function ifIncludeRegistrationStamp () {
$withRegistration = ($this->getConfigInstance()->getConfigEntry('block_shows_registration') == 'Y');
*/
class WebFormHelper extends BaseWebHelper implements HelpableTemplate {
/**
- * Wether the form tag is opened (keep at false or else your forms will
+ * Whether the form tag is opened (keep at false or else your forms will
* never work!)
*/
private $formOpened = false;
private $formName = '';
/**
- * Wether form tag is enabled (default: true)
+ * Whether form tag is enabled (default: true)
*/
private $formEnabled = true;
* @param $templateInstance An instance of a valid template engine
* @param $formName Name of the form
* @param $formId Value for 'id' attribute (default: $formName)
- * @param $withForm Wether include the form tag
+ * @param $withForm Whether include the form tag
* @return $helperInstance A preparedf instance of this helper
*/
public static final function createWebFormHelper (CompileableTemplate $templateInstance, $formName, $formId = false, $withForm = true) {
// Close the form is default
$formContent = '</form>';
- // Check wether we shall open or close the form
+ // Check whether we shall open or close the form
if (($this->formOpened === false) && ($this->formEnabled === true)) {
// Add HTML code
$formContent = sprintf("<form name=\"%s\" class=\"forms\" action=\"%s/%s\" method=\"%s\" target=\"%s\"",
* yet opened. The field's name will be set as id.
*
* @param $fieldName Input field name
- * @param $fieldChecked Wether the field is checked (defaut: checked)
+ * @param $fieldChecked Whether the field is checked (defaut: checked)
* @return void
* @throws FormClosedException If the form is not yet opened
*/
throw new FormClosedException (array($this, $fieldName), self::EXCEPTION_CLOSED_FORM);
} // END - if
- // Set wether the check box is checked...
+ // Set whether the check box is checked...
$checked = " checked=\"checked\"";
if ($fieldChecked === false) $checked = ' ';
/**
* Enables/disables the form tag usage
*
- * @param $formEnabled Wether form is enabled or disabled
+ * @param $formEnabled Whether form is enabled or disabled
* @return void
*/
public final function enableForm ($formEnabled = true) {
}
/**
- * Checks wether the registration requires a valid email address
+ * Checks whether the registration requires a valid email address
*
- * @return $required Wether the email address is required
+ * @return $required Whether the email address is required
*/
public function ifRegisterRequiresEmailVerification () {
$required = ($this->getConfigInstance()->getConfigEntry('register_requires_email') == 'Y');
}
/**
- * Checks wether profile data shall be asked
+ * Checks whether profile data shall be asked
*
- * @return $required Wether profile data shall be asked
+ * @return $required Whether profile data shall be asked
*/
public function ifRegisterIncludesProfile () {
$required = ($this->getConfigInstance()->getConfigEntry('register_includes_profile') == 'Y');
}
/**
- * Checks wether this form is secured by a CAPTCHA
+ * Checks whether this form is secured by a CAPTCHA
*
- * @return $isSecured Wether this form is secured by a CAPTCHA
+ * @return $isSecured Whether this form is secured by a CAPTCHA
*/
public function ifFormSecuredWithCaptcha () {
$isSecured = ($this->getConfigInstance()->getConfigEntry($this->getFormName().'_captcha_secured') == 'Y');
}
/**
- * Checks wether personal data shall be asked
+ * Checks whether personal data shall be asked
*
- * @return $required Wether personal data shall be asked
+ * @return $required Whether personal data shall be asked
*/
public function ifRegisterIncludesPersonaData () {
$required = ($this->getConfigInstance()->getConfigEntry('register_personal_data') == 'Y');
}
/**
- * Checks wether for birthday shall be asked
+ * Checks whether for birthday shall be asked
*
- * @return $required Wether birthday shall be asked
+ * @return $required Whether birthday shall be asked
*/
public function ifProfileIncludesBirthDay () {
$required = ($this->getConfigInstance()->getConfigEntry('profile_includes_birthday') == 'Y');
}
/**
- * Checks wether email addresses can only be once used
+ * Checks whether email addresses can only be once used
*
* @return $isUnique
*/
}
/**
- * Checks wether the specified chat protocol is enabled in this form
+ * Checks whether the specified chat protocol is enabled in this form
*
- * @return $required Wether the specified chat protocol is enabled
+ * @return $required Whether the specified chat protocol is enabled
*/
public function ifChatEnabled ($chatProtocol) {
$required = ($this->getConfigInstance()->getConfigEntry('chat_enabled_' . $chatProtocol) == 'Y');
}
/**
- * Checks wether login is enabled or disabled
+ * Checks whether login is enabled or disabled
*
- * @return $isEnabled Wether the login is enabled or disabled
+ * @return $isEnabled Whether the login is enabled or disabled
*/
public function ifLoginIsEnabled () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_enabled') == 'Y');
}
/**
- * Checks wether login shall be done by username
+ * Checks whether login shall be done by username
*
- * @return $isEnabled Wether the login shall be done by username
+ * @return $isEnabled Whether the login shall be done by username
*/
public function ifLoginWithUsername () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_type') == "username");
}
/**
- * Checks wether login shall be done by email
+ * Checks whether login shall be done by email
*
- * @return $isEnabled Wether the login shall be done by email
+ * @return $isEnabled Whether the login shall be done by email
*/
public function ifLoginWithEmail () {
$isEnabled = ($this->getConfigInstance()->getConfigEntry('login_type') == "email");
}
/**
- * Checks wether guest login is allowed
+ * Checks whether guest login is allowed
*
- * @return $isAllowed Wether guest login is allowed
+ * @return $isAllowed Whether guest login is allowed
*/
public function ifGuestLoginAllowed () {
$isAllowed = ($this->getConfigInstance()->getConfigEntry('guest_login_allowed') == 'Y');
}
/**
- * Checks wether the email address change must be confirmed
+ * Checks whether the email address change must be confirmed
*
- * @return $requireConfirm Wether email change must be confirmed
+ * @return $requireConfirm Whether email change must be confirmed
*/
public function ifEmailChangeRequireConfirmation () {
$requireConfirm = ($this->getConfigInstance()->getConfigEntry('email_change_confirmation') == 'Y');
}
/**
- * Checks wether the rules has been updated
+ * Checks whether the rules has been updated
*
- * @return $rulesUpdated Wether rules has been updated
+ * @return $rulesUpdated Whether rules has been updated
* @todo Implement check if rules have been changed
*/
public function ifRulesHaveChanged () {
}
/**
- * Checks wether email change is allowed
+ * Checks whether email change is allowed
*
- * @return $emailChange Wether changing email address is allowed
+ * @return $emailChange Whether changing email address is allowed
*/
public function ifEmailChangeAllowed () {
$emailChange = ($this->getConfigInstance()->getConfigEntry('email_change_allowed') == 'Y');
}
/**
- * Checks wether the user account is unconfirmed
+ * Checks whether the user account is unconfirmed
*
- * @return $isUnconfirmed Wether the user account is unconfirmed
+ * @return $isUnconfirmed Whether the user account is unconfirmed
*/
public function ifUserAccountUnconfirmed () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_unconfirmed'));
}
/**
- * Checks wether the user account is locked
+ * Checks whether the user account is locked
*
- * @return $isUnconfirmed Wether the user account is locked
+ * @return $isUnconfirmed Whether the user account is locked
*/
public function ifUserAccountLocked () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_locked'));
}
/**
- * Checks wether the user account is a guest
+ * Checks whether the user account is a guest
*
- * @return $isUnconfirmed Wether the user account is a guest
+ * @return $isUnconfirmed Whether the user account is a guest
*/
public function ifUserAccountGuest () {
$isUnconfirmed = ($this->getValueField(UserDatabaseWrapper::DB_COLUMN_USER_STATUS) === $this->getConfigInstance()->getConfigEntry('user_status_guest'));
}
/**
- * Checks wether the refill page is active which should be not the default
+ * Checks whether the refill page is active which should be not the default
* on non-web applications.
*
- * @return $refillActive Wether the refill page is active
+ * @return $refillActive Whether the refill page is active
*/
public function ifRefillPageActive () {
$refillActive = ($this->getConfigInstance()->getConfigEntry('refill_page_active') == 'Y');
/**
* Private setter for all colors
*
- * @param $colorMode Wether background or foreground color
+ * @param $colorMode Whether background or foreground color
* @param $colorChannel Red, green or blue channel?
* @param $colorValue Value to set
*/
/**
* Prepares the class for string (unused at the moment)
*
- * @param $groupable Wether this image string is groupable or single
+ * @param $groupable Whether this image string is groupable or single
* @return void
* @todo Find something usefull for this method.
*/
}
/**
- * Checks wether the user has the required amount of points left for the specified action
+ * Checks whether the user has the required amount of points left for the specified action
*
* @param $action The action or configuration entry plus prefix the user wants to perform
- * @return $hasRequired Wether the user has the required points
+ * @return $hasRequired Whether the user has the required points
* @todo Finish loading part of points
*/
public function ifUserHasRequiredPoints ($action) {
}
/**
- * Checks wether an instance key was found
+ * Checks whether an instance key was found
*
* @param $instanceKey The key holding an instance in registry
- * @return $exists Wether the key exists in registry
+ * @return $exists Whether the key exists in registry
*/
public function instanceExists ($instanceKey) {
// Does this key exists?
private $requestData = array();
/**
- * Wether this request is valid and can be further processed. The default is
+ * Whether this request is valid and can be further processed. The default is
* valid so make sure your intercepting filters sets this attribute to false
* when they need to intercept the data flow.
*/
}
/**
- * Checks wether a request element is set
+ * Checks whether a request element is set
* @param $element Name of the request element we want to check
- * @return $isSet Wether the request element is set
+ * @return $isSet Whether the request element is set
*/
public function isRequestElementSet ($element) {
// Is this element found?
}
/**
- * Sets wether the request was valid (default: true)
+ * Sets whether the request was valid (default: true)
*
- * @param $isValid Wether the request is valid
+ * @param $isValid Whether the request is valid
* @return void
*/
public final function requestIsValid ($isValid = true) {
}
/**
- * Returns wether this request is valid
+ * Returns whether this request is valid
*
- * @return $requestIsValid Wether this request is valid
+ * @return $requestIsValid Whether this request is valid
*/
public final function isRequestValid () {
return $this->requestIsValid;
}
/**
- * Checks wether the given action is valid
+ * Checks whether the given action is valid
*
* @param $actionName The default action we shall execute
- * @return $isValid Wether the given action is valid
+ * @return $isValid Whether the given action is valid
* @throws EmptyVariableException Thrown if given action is not set
*/
public function isActionValid ($actionName) {
}
/**
- * Checks wether the given command is valid
+ * Checks whether the given command is valid
*
* @param $commandName The default command we shall execute
- * @return $isValid Wether the given command is valid
+ * @return $isValid Whether the given command is valid
* @throws EmptyVariableException Thrown if given command is not set
*/
public function isCommandValid ($commandName) {
/**
* "Loads" a given controller and instances it if not yet cached. If the
* controller was not found one of the default controllers will be used
- * depending on wether news shall be displayed.
+ * depending on whether news shall be displayed.
*
* @param $controllerName A controller name we shall look for
* @return $controllerInstance A loaded controller instance
}
/**
- * Checks wether the given controller is valid
+ * Checks whether the given controller is valid
*
* @param $controllerName The default controller we shall execute
- * @return $isValid Wether the given controller is valid
+ * @return $isValid Whether the given controller is valid
* @throws EmptyVariableException Thrown if given controller is not set
* @throws DefaultControllerException Thrown if default controller was not found
*/
/**
* Flushs the cached HTTP response to the outer world
*
- * @param $force Wether we shall force the output or abort if headers are
+ * @param $force Whether we shall force the output or abort if headers are
* already sent with an exception
* @return void
* @throws ResponseHeadersAlreadySentException Thrown if headers are
/**
* Flushs the cached console response to the console
*
- * @param $force Wether we shall force the output or abort if headers are
+ * @param $force Whether we shall force the output or abort if headers are
* already sent with an exception
* @return void
* @throws ResponseHeadersAlreadySentException Thrown if headers are
/**
* Flushs the cached HTTP response to the outer world
*
- * @param $force Wether we shall force the output or abort if headers are
+ * @param $force Whether we shall force the output or abort if headers are
* already sent with an exception
* @return void
*/
* "Iterator" method next() to advance to the next valid entry. This method
* does also check if result is invalid
*
- * @return $nextValid Wether the next entry is valid
+ * @return $nextValid Whether the next entry is valid
*/
public function next () {
// Default is not valid
/**
* Checks if next() and rewind will give a valid result
*
- * @return $isValid Wether the next/rewind entry is valid
+ * @return $isValid Whether the next/rewind entry is valid
*/
public function valid () {
// By default nothing is valid
}
/**
- * Determines wether the status of the query was fine (LocalfileDatabase::RESULT_OKAY)
+ * Determines whether the status of the query was fine (LocalfileDatabase::RESULT_OKAY)
*
- * @return $ifStatusOkay Wether the status of the query was okay
+ * @return $ifStatusOkay Whether the status of the query was okay
*/
public function ifStatusIsOkay () {
return ((isset($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS])) && ($this->resultArray[BaseDatabaseFrontend::RESULT_INDEX_STATUS] === LocalfileDatabase::RESULT_OKAY));
}
/**
- * Checks wether we have out-dated entries or not
+ * Checks whether we have out-dated entries or not
*
- * @return $needsUpdate Wether we have out-dated entries
+ * @return $needsUpdate Whether we have out-dated entries
*/
public function ifDataNeedsFlush () {
$needsUpdate = (count($this->outDated) > 0);
* Find a key inside the result array
*
* @param $key The key we shall find
- * @return $found Wether the key was found or not
+ * @return $found Whether the key was found or not
*/
public function find ($key) {
// By default nothing is found
}
/**
- * Checks wether the given stack is initialized (set in array $stackers)
+ * Checks whether the given stack is initialized (set in array $stackers)
*
* @param $stackerName Name of the stack
- * @return $isInitialized Wether the stack is initialized
+ * @return $isInitialized Whether the stack is initialized
*/
public final function isStackInitialized ($stackerName) {
// Is is there?
}
/**
- * Checks wether the given stack is full
+ * Checks whether the given stack is full
*
* @param $stackerName Name of the stack
- * @return $isFull Wether the stack is full
+ * @return $isFull Whether the stack is full
* @throws NoStackerException If given stack is missing
*/
protected final function isStackFull ($stackerName) {
}
/**
- * Checks wether the given stack is empty
+ * Checks whether the given stack is empty
*
* @param $stackerName Name of the stack
- * @return $isEmpty Wether the stack is empty
+ * @return $isEmpty Whether the stack is empty
* @throws NoStackerException If given stack is missing
*/
public final function isStackEmpty ($stackerName) {
}
/**
- * Checks wether the given variable stack is set
+ * Checks whether the given variable stack is set
*
* @param $stack Variable stack to check
- * @return $isSet Wether the given variable stack is set
+ * @return $isSet Whether the given variable stack is set
*/
protected final function isVarStackSet ($stack) {
// Check it
/**
* Returns all variables of current group or empty array
*
- * @return $result Wether array of found variables or empty array
+ * @return $result Whether array of found variables or empty array
*/
private function readCurrentGroup () {
// Default is not found
* Settter for variable group
*
* @param $groupName Name of variable group
- * @param $add Wether add this group
+ * @param $add Whether add this group
* @return void
*/
public function setVariableGroup ($groupName, $add = true) {
}
/**
- * Checks wether language support is enabled
+ * Checks whether language support is enabled
*
- * @return $languageSupport Wether language support is enabled or disabled
+ * @return $languageSupport Whether language support is enabled or disabled
*/
public final function isLanguageSupportEnabled () {
return $this->languageSupport;
}
/**
- * Checks wether XML compacting is enabled
+ * Checks whether XML compacting is enabled
*
- * @return $xmlCompacting Wether XML compacting is enabled or disabled
+ * @return $xmlCompacting Whether XML compacting is enabled or disabled
*/
public final function isXmlCompactingEnabled () {
return $this->xmlCompacting;
/**
* "Setter" for image-string. For more details see above method!
*
- * @param $groupable Wether this image string is groupable
+ * @param $groupable Whether this image string is groupable
* @return void
* @see ImageTemplateEngine::setImageResolution
*/
}
/**
- * Determines wether the username exists or not
+ * Determines whether the username exists or not
*
- * @return $exists Wether the username exists
+ * @return $exists Whether the username exists
*/
public function ifUsernameExists () {
// By default the username does not exist
}
/**
- * Determines wether the email exists or not
+ * Determines whether the email exists or not
*
- * @return $exists Wether the email exists
+ * @return $exists Whether the email exists
*/
public function ifEmailAddressExists () {
// By default the email does not exist
* database.
*
* @param $requestInstance A requestable class instance
- * @return $matches Wether the supplied password hash matches
+ * @return $matches Whether the supplied password hash matches
*/
public function ifPasswordHashMatches (Requestable $requestInstance) {
// By default nothing matches... ;)
}
/**
- * Checks wether the given configuration entry is set
+ * Checks whether the given configuration entry is set
*
* @param $configEntry The configuration entry we shall check
- * @return $isset Wether the given configuration entry is set
+ * @return $isset Whether the given configuration entry is set
*/
protected function isConfigurationEntrySet ($configEntry) {
// Is it set?
}
/**
- * Checks wether HTTPS is set in $_SERVER
+ * Checks whether HTTPS is set in $_SERVER
*
- * @return $isset Wether HTTPS is set
+ * @return $isset Whether HTTPS is set
*/
public function isHttpSecured () {
return (isset($_SERVER['HTTPS']));
}
/**
- * Checks wether an object equals this object. You should overwrite this
+ * Checks whether an object equals this object. You should overwrite this
* method to implement own equality checks
*
* @param $objectInstance An instance of a FrameworkInterface object
- * @return $equals Wether both objects equals
+ * @return $equals Whether both objects equals
*/
public function equals (FrameworkInterface $objectInstance) {
// Now test it
private $debug = false;
/**
- * Wether the file list is cached or not
+ * Whether the file list is cached
*/
private $listCached = false;
projects / core.git / commitdiff