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 Relation

The Relation complex data type.

Alpha\Model\Type\Type
Extended by Alpha\Model\Type\Relation 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/Relation.php
Methods summary
public
# __construct( )

Constructor.

Constructor.

Since

1.0
public
# setRelatedClass( string $RC, string $side = '' )

Set the name of the business object class that this class is related to.

Set the name of the business object class that this class is related to.

Parameters

$RC
string $RC
$side
string $side Only required for MANY-TO-MANY relations

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public string
# getRelatedClass( string $side = '' )

Get the name of the business object class that this class is related to.

Get the name of the business object class that this class is related to.

Parameters

$side
string $RC

Returns

string
string

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public
# setRelatedClassField( string $RCF )

Setter for the field of the related class.

Setter for the field of the related class.

Parameters

$RCF
string $RCF

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public string
# getRelatedClassField( )

Getter for the field of the related class.

Getter for the field of the related class.

Returns

string
string

Since

1.0
public
# setRelatedClassHeaderFields( array $fieldNames )

Setter for ONE-TO-MANY relations, which sets the header fields to render from the related class.

Setter for ONE-TO-MANY relations, which sets the header fields to render from the related class.

Parameters

$fieldNames
array $fieldNames

Since

1.0
public array
# getRelatedClassHeaderFields( )

Getter for the selection widget field headings of the related class.

Getter for the selection widget field headings of the related class.

Returns

array
array

Since

1.0
public
# setRelatedClassDisplayField( string $RCDF, string $side = '' )

Setter for the display field from the related class.

Setter for the display field from the related class.

Parameters

$RCDF
string $RCDF
$side
string $side Only required for MANY-TO-MANY relations

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public string
# getRelatedClassDisplayField( string $side = '' )

Getter for the display field from the related class.

Getter for the display field from the related class.

Parameters

$side
string $side Only required for MANY-TO-MANY relations

Returns

string
string

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public
# setRelationType( string $RT )

Setter for the relation type.

Setter for the relation type.

Parameters

$RT
string $RT

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException
Alpha\Exception\FailedLookupCreateException
Alpha\Exception\FailedLookupCreateException

Since

1.0
public string
# getRelationType( )

Getter for the relation type.

Getter for the relation type.

Returns

string
string

Since

1.0
public
# setValue( integer $val )

Setter for the value (OID of related object) of this relation.

Setter for the value (OID of related object) of this relation.

Parameters

$val
int $val

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0

Implementation of

Alpha\Model\Type\TypeInterface::setValue()
public array
# getRelatedOIDs( )

Getter for the array of OIDs used by MANY-TO-MANY instances.

Getter for the array of OIDs used by MANY-TO-MANY instances.

Returns

array
array

Since

2.0
public
# setRelatedOIDs( array $OIDs )

Setter for the array of OIDs used by MANY-TO-MANY instances.

Setter for the array of OIDs used by MANY-TO-MANY instances.

Parameters

$OIDs
array $OIDs

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

2.0
public mixed
# getValue( )

Getter for the Relation value.

Getter for the Relation value.

Returns

mixed
mixed

Since

1.0

Implementation of

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

Get the validation rule.

Get the validation rule.

Returns

string
string

Since

1.0
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
# getRelatedClassDisplayFieldValue( string $accessingClassName = '' )

Getter for the display value of the related class field. In the case of a MANY-TO-MANY Relation, a comma-seperated sorted list of values is returned.

Getter for the display value of the related class field. In the case of a MANY-TO-MANY Relation, a comma-seperated sorted list of values is returned.

Parameters

$accessingClassName
string $accessingClassName Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types)

Returns

string
string

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public array
# getRelatedObjects( mixed $accessingClassName = '' )

For one-to-many and many-to-many relations, get the objects on the other side.

For one-to-many and many-to-many relations, get the objects on the other side.

string $accessingClassName Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types)

Returns

array
array

Throws

Alpha\Exception\IllegalArguementException
Alpha\Exception\IllegalArguementException

Since

1.0
public array
# getRelatedObject( )

For one-to-one relations, get the object on the other side.

For one-to-one relations, get the object on the other side.

Returns

array
array

Throws

Alpha\Model\Type\IllegalArguementException
Alpha\Model\Type\IllegalArguementException

Since

1.0
public integer
# getSize( )

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

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

Returns

integer
int

Since

1.0
public Alpha\Model\Type\RelationLookup
# getLookup( )

Get the lookup object if available (only on MANY-TO-MANY relations, null otherwise).

Get the lookup object if available (only on MANY-TO-MANY relations, null otherwise).

Returns

Alpha\Model\Type\RelationLookup
RelationLookup

Since

1.0
public string
# getSide( string $BOClassname )

Gets the side ('left' or 'right') of the passed classname on the current Relation object.

Gets the side ('left' or 'right') of the passed classname on the current Relation object.

Parameters

$BOClassname
string $BOClassname

Returns

string
string

Throws

Alpha\Model\Type\IllegalArguementException
Alpha\Model\Type\IllegalArguementException

Since

1.0
public
# setTaggedClass( mixed $taggedClass )

Set the taggedClass property to the name of the tagged class when building relations to the TagObject BO.

Set the taggedClass property to the name of the tagged class when building relations to the TagObject BO.

Parameters

$taggedClass
$taggedClass

Since

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

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

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

Since

1.0
Properties summary
protected string $helper
#

The error message for the Relation type when validation fails.

The error message for the Relation type when validation fails.

Since

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