Scorpio Framework for PHP

• Resources

  • Categories
  • News
  • Documentation
  • Tutorials
  • Roadmap

• Links

  • Madagasgar.com
  • SourceForge Project Page
  • Download Releases
  • Bug Tracker
  • Feature Requests
  • API Docs

wurflCapability

• You are in »
• Categories /
• Documentation /
• Documentation /

Provides access to records in wurfl.capabilities

Creating a new record:

$oWurflCapability = new wurflCapability();
$oWurflCapability->setCapabilityID($inCapabilityID);
$oWurflCapability->setCapabilityGroupID($inCapabilityGroupID);
$oWurflCapability->setDescription($inDescription);
$oWurflCapability->setVarType($inVarType);
$oWurflCapability->save();

Accessing a record by primary key on constructor:

$oWurflCapability = new wurflCapability($inCapabilityID);

Access by manually calling load:

$oWurflCapability = new wurflCapability();
$oWurflCapability->setCapabilityID($inCapabilityID);
$oWurflCapability->load();

Accessing a record by instance:

$oWurflCapability = wurflCapability::getInstance($inCapabilityID);

If there are other unique keys, separate methods should exist for each key.

---

Methods

public __construct([$inCapabilityID = null])

Returns a new instance of wurflCapability

public static factory([$inCapabilityGroupID = null], [$inDescription = null], [$inVarType = null])

Creates a new wurflCapability containing non-unique properties

public static getInstance($inCapabilityID)

Get an instance of wurflCapability by primary key, will accept capId as int or wurfl cap name

public static listOfObjects([$inOffset = null], [$inLimit = 30])

Returns an array of objects of wurflCapability

public load()

Loads a record from the database based on the primary key or first unique index

public loadFromArray($inArray)

Loads a record by array

public save()

Saves object to the table

public delete()

Deletes the object from the table

public reset()

Resets object properties to defaults

public toString([$newLine = ' '])

Returns object as a string with each property separated by $newLine

public toXml([$newLine = ' '])

Returns object as XML with each property separated by $newLine

public toArray()

Returns properties of object as an array

public isValid([$message = ''])

Returns true if object is valid

protected checkCapabilityID([$inMessage = ''])

Checks that $_CapabilityID has a valid value

protected checkCapabilityGroupID([$inMessage = ''])

Checks that $_CapabilityGroupID has a valid value

protected checkDescription([$inMessage = ''])

Checks that $_Description has a valid value

protected checkVarType([$inMessage = ''])

Checks that $_VarType has a valid value

public isModified()

Returns true if object has been modified

public setModified([$status = true])

Set the status of the object if it has been changed

public getPrimaryKey()

Returns the primary key value

public getCapabilityID()

Return value of $_CapabilityID

public setCapabilityID($inCapabilityID)

Set $_CapabilityID to CapabilityID

public getCapabilityGroupID()

Return value of $_CapabilityGroupID

public getCapabilityGroup()

Returns the wurflCapabilityGroup object

public setCapabilityGroupID($inCapabilityGroupID)

Set $_CapabilityGroupID to CapabilityGroupID

public getDescription()

Return value of $_Description

public getFormattedDescription()

Returns the description formatted for display

public setDescription($inDescription)

Set $_Description to Description

public getVarType()

Return value of $_VarType

public setVarType($inVarType)

Set $_VarType to VarType

public getHelpText()

Return value of $_HelpText

public setHelpText($inHelpText)

Set $_HelpText to HelpText