Overview

Namespaces

  • Alpha
    • Controller
      • Front
    • Exception
    • Model
      • Type
    • Task
    • Util
      • Backup
      • Cache
      • Code
        • Highlight
        • Metric
      • Config
      • Convertor
      • Email
      • Extension
      • Feed
      • File
      • Graph
      • Helper
      • Http
        • Filter
        • Session
      • Image
      • Logging
      • Search
      • Security
    • View
      • Renderer
        • Html
        • Json
      • Widget

Classes

  • Boolean
  • Date
  • DEnum
  • DEnumItem
  • Double
  • Enum
  • Integer
  • Relation
  • RelationLookup
  • Sequence
  • String
  • Text
  • Timestamp
  • Type

Interfaces

  • TypeInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class String

The String complex data type.

Alpha\Model\Type\Type
Extended by Alpha\Model\Type\String implements Alpha\Model\Type\TypeInterface
Namespace: Alpha\Model\Type
Copyright: Copyright (c) 2015, John Collins (founder of Alpha Framework). All rights reserved. <pre> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </pre>
License: The BSD License
Author: John Collins <dev@alphaframework.org>
Since: 1.0
Located at Model/Type/String.php
Methods summary
public
# __construct( string $val = '' )

Constructor.

Constructor.

Parameters

$val
string $val

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public
# setValue( string $val )

Setter for the value.

Setter for the value.

Parameters

$val
string $val

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0

Implementation of

Alpha\Model\Type\TypeInterface::setValue()
public string
# getValue( )

Getter for the value.

Getter for the value.

Returns

string
string

Since

1.0

Implementation of

Alpha\Model\Type\TypeInterface::getValue()
public
# setRule( string $rule )

Setter to override the default validation rule.

Setter to override the default validation rule.

Parameters

$rule
string $rule

Since

1.0
public string
# getRule( )

Get the validation rule.

Get the validation rule.

Returns

string
string

Since

1.0
public
# setSize( integer $size )

Used to set the allowable size of the String in the database field.

Used to set the allowable size of the String in the database field.

Parameters

$size
int $size

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public integer
# getSize( )

Get the allowable size of the Double in the database field.

Get the allowable size of the Double in the database field.

Returns

integer
int

Since

1.0
public
# isRequired( boolean $req = true )

Sets up an appropriate validation rule for a required field.

Sets up an appropriate validation rule for a required field.

Parameters

$req
bool $req

Since

1.0
public
# isPassword( boolean $pass = true )

Define the string as a password (making it required by validation rule).

Define the string as a password (making it required by validation rule).

Parameters

$pass
bool $pass

Since

1.0
public boolean
# checkIsPassword( )

Checks to see if the string is a password or not.

Checks to see if the string is a password or not.

Returns

boolean
bool

Since

1.0
Methods inherited from Alpha\Model\Type\Type
__toString(), getHelper(), setHelper()
Constants summary
integer MAX_SIZE 255
#

The absolute maximum size of the value for the this String.

The absolute maximum size of the value for the this String.

Since

1.0
Properties summary
protected string $helper 'Not a valid string value!'
#

The error message for the string type when validation fails.

The error message for the string type when validation fails.

Since

1.0
Alpha Framework 2.0.4 API Documentation API documentation generated by ApiGen 2.8.0