Overview

Packages

  • None
  • Yaga

Classes

  • ActedModel
  • ActionController
  • ActionModel
  • AwardCombo
  • BadgeAwardModel
  • BadgeController
  • BadgeModel
  • BadgesController
  • BadgesModule
  • BestController
  • BestFilterModule
  • CakeDayPost
  • CommentCount
  • CommentMarathon
  • DiscussionBodyLength
  • DiscussionCategory
  • DiscussionCount
  • DiscussionPageCount
  • HasMentioned
  • HolidayVisit
  • LeaderBoardModule
  • LengthOfService
  • ManualAward
  • NecroPost
  • NewbieComment
  • PhotoExists
  • PostCount
  • PostReactions
  • QnAAnserCount
  • RankController
  • RankModel
  • ReactController
  • ReactionCount
  • ReactionModel
  • ReflexComment
  • RulesController
  • SocialConnection
  • Yaga
  • YagaController
  • YagaHooks

Interfaces

  • YagaRule
  • Overview
  • Package
  • Class
  • Tree
  • Todo
  • Download

Class YagaController

Manage the yaga application including configuration and import/export

DashboardController
Extended by YagaController
Package: Yaga
Since: 1.0
Located at controllers/class.yagacontroller.php
Methods summary
public
# Initialize( )

Make this look like a dashboard page and add the resources

Make this look like a dashboard page and add the resources

Since

1.0
public
# Index( )

Redirect to settings by default

Redirect to settings by default

public
# Settings( )

This handles all the core settings for the gamification application.

This handles all the core settings for the gamification application.

public
# Import( )

Import a Yaga transport file

Import a Yaga transport file

public
# Export( )

Create a Yaga transport file

Create a Yaga transport file

protected array
# _FindIncludes( )

This searches through the submitted checkboxes and constructs an array of Yaga sections to be included in the transport file.

This searches through the submitted checkboxes and constructs an array of Yaga sections to be included in the transport file.

Returns

array
protected mixed
# _ExportData( array $Include = array(), string $Path = NULL )

Creates a transport file for easily transferring Yaga configurations across installs

Creates a transport file for easily transferring Yaga configurations across installs

Parameters

$Include
array
An array containing the config areas to transfer
$Path
string
Where to save the transport file

Returns

mixed
False on failure, the path to the transport file on success
protected boolean
# _ExtractZip( string $Filename )

Extract the transport file and validate

Extract the transport file and validate

Parameters

$Filename
string
The transport file path

Returns

boolean
Whether or not the transport file was extracted successfully
protected boolean
# _ImportData( stdClass $Info, array $Include )

Overwrites Yaga configurations, dumps Yaga db tables, inserts data via the model, and copies uploaded files to the server

Overwrites Yaga configurations, dumps Yaga db tables, inserts data via the model, and copies uploaded files to the server

Parameters

$Info
stdClass
The info object read in from the archive
$Include
array
Which tables should be overwritten

Returns

boolean
Pass/Fail on the import being executed. Errors can exist on the form with a passing return value.
protected array
# _NestedToDotNotation( array $Configs, string $Prefix = '' )

Converted a nest config array into an array where indexes are the configuration strings and the value is the value

Converted a nest config array into an array where indexes are the configuration strings and the value is the value

Parameters

$Configs
array
The nested array
$Prefix
string
What should the configuration strings be prefixed with

Returns

array
protected boolean
# _ValidateChecksum( stdClass $MetaData )

Inspects the Yaga transport files and calculates a checksum

Inspects the Yaga transport files and calculates a checksum

Parameters

$MetaData
stdClass
The metadata object read in from the transport file

Returns

boolean
Whether or not the checksum is valid
protected array
# _GetFiles( string $Directory )

Returns a list of all files in a directory, recursively (Thanks @businessdad)

Returns a list of all files in a directory, recursively (Thanks @businessdad)

Parameters

$Directory
string
Directory The directory to scan for files

Returns

array
A list of Files and, optionally, Directories.
Properties summary
public array $Uses array('Form')
#

These objects will be created on instantiation and available via $this->ObjectName

These objects will be created on instantiation and available via $this->ObjectName

Yaga API documentation generated by ApiGen 2.8.0