OssnObject Class Reference
Inheritance diagram for OssnObject:
OssnEntities OssnDatabase OssnBase

Public Member Functions

 initAttributes ()
 
 addObject ()
 
 getObjectByOwner ()
 
 getObjectsByTypes ()
 
 getObjectById ()
 
 getObjectId ()
 
 updateObject ($name, $value, $guid)
 
 deleteObject ($object)
 
 searchObject (array $params=array())
 
- Public Member Functions inherited from OssnEntities
 add ()
 
 get_entity ()
 
 save ()
 
 get_entities ()
 
 AddedEntityGuid ()
 
 updateEntity ()
 
 deleteByOwnerGuid ($guid, $type)
 
 deleteEntity ($guid)
 
 searchEntities (array $params=array())
 
 canChange ($user= '')
 
- Public Member Functions inherited from OssnDatabase
 Connect ()
 
 insert ($params)
 
 statement ($query)
 
 execute ()
 
 update ($params=array())
 
 select ($params, $multi= '')
 
 fetch ($data=false)
 
 delete ($params)
 
 getLastEntry ()
 
 constructWheres (array $array, $operator="AND")
 
 generateLimit ($data_limit=false, $page_limit=false, $offset=false)
 
- Public Member Functions inherited from OssnBase
 getGUID ()
 
 getID ()
 
 getParam ($param)
 
 isParam ($param)
 

Detailed Description

Definition at line 11 of file OssnObject.php.

Member Function Documentation

addObject ( )

Create objects

requires $object->(owner_guid, type, subtype, title, description)

Returns
boolean

Definition at line 35 of file OssnObject.php.

deleteObject (   $object)

Delete object;

Parameters
integer$objectObject guid
Returns
boolean

Definition at line 216 of file OssnObject.php.

getObjectById ( )

Get object by object guid;

Requires : $object->object_guid

Returns
object;

Definition at line 132 of file OssnObject.php.

getObjectByOwner ( )

Get object by owner guid;

Requires $object->owner_guid $object->order_by To sort the data in a recordset

Returns
object

Definition at line 80 of file OssnObject.php.

getObjectId ( )

Get newly created object

Returns
void|integer

Definition at line 175 of file OssnObject.php.

getObjectsByTypes ( )

Get object by types;

Requires : $object->(type , subtype(optional)) $object->order_by To sort the data in a recordset

Returns
object

Definition at line 108 of file OssnObject.php.

initAttributes ( )

Initialize the objects.

Returns
void

Definition at line 18 of file OssnObject.php.

searchObject ( array  $params = array())

Search object by its title, description etc

Parameters
array$paramsA valid options in format: 'search_type' => true(default) to performs matching on a per-character basis false for performs matching on exact value. 'subtype' => Valid object subtype 'type' => Valid object type 'title' => Valid object title 'description' => Valid object description 'owner_guid' => A valid owner guid, which results integer value 'limit' => Result limit default, Default is 20 values 'order_by' => To show result in sepcific order. There is no default order.

reutrn array|false;

Definition at line 254 of file OssnObject.php.

updateObject (   $name,
  $value,
  $guid 
)

Update Object;

Parameters
array$nameNames
array$valueValues
integer$guidObject guid
Returns
boolean

Definition at line 190 of file OssnObject.php.


The documentation for this class was generated from the following file: