summaryrefslogtreecommitdiffstats
path: root/src/Project
diff options
context:
space:
mode:
authorDracony <draconyster@gmail.com>2016-02-08 18:12:26 +0100
committerDracony <draconyster@gmail.com>2016-02-08 18:12:26 +0100
commitb3452705d63b078fd6437897640db7a16612177a (patch)
tree2849f9db6812be152495d9aa3322e591bd28917d /src/Project
parentbd328d349b6c171f6b0a78ffac7471a52791308a (diff)
downloadPHPixie-b3452705d63b078fd6437897640db7a16612177a.zip
PHPixie-b3452705d63b078fd6437897640db7a16612177a.tar.gz
PHPixie-b3452705d63b078fd6437897640db7a16612177a.tar.bz2
added docblocks3.2.1
Diffstat (limited to 'src/Project')
-rwxr-xr-xsrc/Project/Framework.php11
-rwxr-xr-xsrc/Project/Framework/Builder.php21
-rwxr-xr-xsrc/Project/Framework/Bundles.php13
-rw-r--r--src/Project/Framework/Extensions.php36
4 files changed, 72 insertions, 9 deletions
diff --git a/src/Project/Framework.php b/src/Project/Framework.php
index c71b85a..b1b2209 100755
--- a/src/Project/Framework.php
+++ b/src/Project/Framework.php
@@ -1,8 +1,17 @@
<?php
namespace Project;
-class Framework extends \PHPixie\BundleFramework
+use \PHPixie\BundleFramework;
+
+/**
+ * Project class extending the PHPixie Framework.
+ */
+class Framework extends BundleFramework
{
+ /**
+ * Project factory
+ * @return Framework\Builder
+ */
protected function buildBuilder()
{
return new Framework\Builder();
diff --git a/src/Project/Framework/Builder.php b/src/Project/Framework/Builder.php
index d467ec1..c4b5640 100755
--- a/src/Project/Framework/Builder.php
+++ b/src/Project/Framework/Builder.php
@@ -2,18 +2,35 @@
namespace Project\Framework;
+/**
+ * Your projects main factory, usually referenced as $frameworkBuilder.
+ *
+ * You can use it to override and customize the framework.
+ */
class Builder extends \PHPixie\BundleFramework\Builder
{
+ /**
+ * Your Bundles registry
+ * @return Bundles
+ */
protected function buildBundles()
{
return new Bundles($this);
}
-
+
+ /**
+ * Your extension registry registry
+ * @return Bundles
+ */
protected function buildExtensions()
{
return new Extensions($this);
}
-
+
+ /**
+ * Projects root directory
+ * @return Bundles
+ */
protected function getRootDirectory()
{
return realpath(__DIR__.'/../../../');
diff --git a/src/Project/Framework/Bundles.php b/src/Project/Framework/Bundles.php
index 52a7c31..d98eb88 100755
--- a/src/Project/Framework/Bundles.php
+++ b/src/Project/Framework/Bundles.php
@@ -2,17 +2,20 @@
namespace Project\Framework;
+/**
+ * Your projects bundle registry.
+ * Every bundle you add must be registered here.
+ */
class Bundles extends \PHPixie\BundleFramework\Bundles
{
+ /**
+ * Should return an array of Bundle instances
+ * @return array
+ */
protected function buildBundles()
{
return array(
new \Project\App($this->builder)
);
}
-
- protected function getRootFolder()
- {
- return realpath(__DIR__.'/../../');
- }
} \ No newline at end of file
diff --git a/src/Project/Framework/Extensions.php b/src/Project/Framework/Extensions.php
index ad972fa..156bd7d 100644
--- a/src/Project/Framework/Extensions.php
+++ b/src/Project/Framework/Extensions.php
@@ -2,7 +2,41 @@
namespace Project\Framework;
+/**
+ * Extensions registry.
+ */
class Extensions extends \PHPixie\Framework\Extensions
{
-
+ /**
+ * Extensions for the Template component
+ * @return array
+ */
+ public function templateExtensions()
+ {
+ return array_merge(parent::templateExtensions(), array(
+ //add your Template Extensions here
+ ));
+ }
+
+ /**
+ * Format compilers for the Template component
+ * @return array
+ */
+ public function templateFormats()
+ {
+ return array_merge(parent::templateFormats(), array(
+ //add your Template Formats here
+ ));
+ }
+
+ /**
+ * Provider Builders for the Auth component
+ * @return array
+ */
+ public function authProviderBuilders()
+ {
+ return array_merge(parent::authProviderBuilders(), array(
+ //add your Auth Provider Builders here
+ ));
+ }
} \ No newline at end of file