Class: Doctrine_Access

Source Location: /Doctrine/Access.php

Class Doctrine_Access

Class Overview

Implements interfaces:

  • ArrayAccess (internal interface)

Doctrine_Access

the purpose of Doctrine_Access is to provice array access and property overload interface for subclasses

Located in /Doctrine/Access.php [line 35]

Doctrine_Object
   |
   --Doctrine_Access
Author(s): API Tags:
Abstract:  

Information Tags:
Version:  $Revision: 1604 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Methods

[ Top ]
Direct descendents
Child Class Description
Doctrine_Collection Doctrine_Collection Collection of Doctrine_Record objects.
Doctrine_Column Doctrine_Column This class represents a database column
Doctrine_EventListener_Chain Doctrine_EventListener_Chain this class represents a chain of different listeners, useful for having multiple listeners listening the events at the same time
Doctrine_Record_Abstract Doctrine_Record_Abstract
Doctrine_Record_Listener_Chain Doctrine_Record_Listener_Chain this class represents a chain of different listeners, useful for having multiple listeners listening the events at the same time
Doctrine_Schema_Object class Doctrine_Schema_Object Catches any non-property call from child classes and throws an exception.
Doctrine_Validator_ErrorStack Doctrine_Validator_ErrorStack

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Object

Doctrine_Object::$_null

Inherited From Doctrine_Object

Doctrine_Object::getNullObject()
getNullObject returns the null object associated with this object
Doctrine_Object::initNullObject()
initNullObject initializes the null object

[ Top ]
Method Summary
boolean   offsetExists()  
mixed   offsetGet()   offsetGet an alias of get()
void   offsetSet()   sets $offset to $value
void   offsetUnset()   unset a given offset
Doctrine_Access   setArray()   setArray
mixed   __get()   __get -- an alias of get()
boolean   __isset()   __isset()
void   __set()   __set an alias of set()
void   __unset()   __unset()

[ Top ]
Properties
Methods
offsetExists  [line 103]

  boolean offsetExists( mixed $offset  )

Parameters:
mixed   $offset: 

API Tags:
Return:  whether or not this object contains $offset
Access:  public


Implementation of:
ArrayAccess::offsetExists

[ Top ]
offsetGet  [line 113]

  mixed offsetGet( mixed $offset  )

offsetGet an alias of get()

Parameters:
mixed   $offset: 

API Tags:
See:  get, Doctrine_Access::__get()
Access:  public


Implementation of:
ArrayAccess::offsetGet

[ Top ]
offsetSet  [line 124]

  void offsetSet( mixed $offset, mixed $value  )

sets $offset to $value

Parameters:
mixed   $offset: 
mixed   $value: 

API Tags:
See:  set, Doctrine_Access::__set()
Access:  public


Implementation of:
ArrayAccess::offsetSet

[ Top ]
offsetUnset  [line 137]

  void offsetUnset( mixed $offset  )

unset a given offset

Parameters:
mixed   $offset: 

API Tags:
See:  set, Doctrine_Access::offsetSet(), Doctrine_Access::__set()
Access:  public


Implementation of:
ArrayAccess::offsetUnset

[ Top ]
setArray  [line 44]

  Doctrine_Access setArray( $array  )

setArray

Parameters:
array   $array:  an array of key => value pairs

API Tags:
Access:  public

Information Tags:
Since:  1.0

[ Top ]
__get  [line 73]

  mixed __get( mixed $name  )

__get -- an alias of get()

Parameters:
mixed   $name: 

API Tags:
See:  get, Doctrine_Access::offsetGet()
Access:  public

Information Tags:
Since:  1.0

[ Top ]
__isset  [line 84]

  boolean __isset( string $name  )

__isset()

Parameters:
string   $name: 

API Tags:
Return:  whether or not this object contains $name
Access:  public

Information Tags:
Since:  1.0

[ Top ]
__set  [line 61]

  void __set( $name $name, $value $value  )

__set an alias of set()

Parameters:
$name   $name: 
$value   $value: 

API Tags:
See:  set, Doctrine_Access::offsetSet()
Access:  public

Information Tags:
Since:  1.0

[ Top ]
__unset  [line 95]

  void __unset( string $name  )

__unset()

Parameters:
string   $name: 

API Tags:
Access:  public

Information Tags:
Since:  1.0

Redefined in descendants as:

[ Top ]