Parameters

• stylesheet – the name of the stylesheet (without the .css extension)
• media (optional) default value: 'media' – the type of stylesheet being included
• path (optional) default value: 'public/stylesheets/' – the path of the location of the stylesheet (often set whenever pulling a stylesheet from an external location)
• ext (optional) default value: '.css' – the extension of the stylesheet file

Description

This function is called whenever the developer is adding a CSS file to the CSS queue to be included in the display of the page. The function is typically called in a controller file. NOTE: the files in the CSS queue are only included when in layout mode unless the developer has written code in the view to include the files in the CSS queue. The file extension can be set if the CSS is generated by a PHP or other script.

Example(s)

// example 1 - basic use
Fabriq::add_css('users');
// example 2 - a print stylesheet
Fabriq::add_css('users', 'print');
// example 3 - an external stylesheet
Fabriq::add_css('users', 'screen', 'http://example.com/');
// example 4 - a generated css script
Fabriq::add_css('blogs', 'screen', 'public/stylesheets/', ".php?user={$user->id}");

Parameters

• index – the index of the argument in the query arguments variable
• val (optional) default value: NULL – if a value is given, the argument at that index is set to val

Description

The Fabriq::arg() function is the getter/setter for arguments in the query arguments variable. If a second parameter is passed in, the argument at the given index is set to the given value of the second parameter.

NOTE: this function was moved to the /core/BaseMapping.class.php file. To use the action function, it can be called using PathMap::arg(). Please update your code to use the new version. The /app/PathMap.class.php extends the /core/BaseMapping.class.php. Only the /app/PathMap.class.php file should be edited.

Example(s)

//// deprecated examples
// example 1a - get an argument
echo Fabriq::arg(2);
// example 2a - set an argument
Fabriq::arg(2, $id);
//// examples that should be used
// example 1b - get an argument
echo PathMap::arg(2);
// example 2b - set an argument
PathMap::arg(2, $id);

Description

The Fabriq::build_path() function is used to build a path to be used in Fabriq applications. The function can be used when building a path for the action attribute of a form element in a view.

NOTE: this function was moved to the /core/BaseMapping.class.php file. To use the action function, it can be called using PathMap::build_path(). Please update your code to use the new version. The /app/PathMap.class.php extends the /core/BaseMapping.class.php. Only the /app/PathMap.class.php file should be edited.

Example(s)

// deprecated example
<form method="post" action="<?php echo Fabriq::build_path('blog', 'create'); ?>">
<!-- form code -->
</form>

// example that should be used
<form method="post" action="<?php echo PathMap::build_path('blog', 'create'); ?>">
<!-- form code -->
</form>

Description

Returns a string version of the boolean for whether or not the Fabriq application is using clean URLs based on the setting in the configuration file.

NOTE: this function was moved to the /core/BaseMapping.class.php file. To use the action function, it can be called using PathMap::clean_urls_str(). Please update your code to use the new version. The /app/PathMap.class.php extends the /core/BaseMapping.class.php. Only the /app/PathMap.class.php file should be edited.

Example(s)

// deprecated example
echo "This site uses clean URLs: " . Fabriq::clean_urls_str();
// example that should be used
echo "This site uses clean URLs: " . PathMap::clean_urls_str();

Description

Returns the list of CSS files that are in the CSS queue. This function is used in the default layout file located in /app/views/layouts/application.view.php to include the stylesheets in the queue.

Example

// code used in the /app/views/layouts/application.view.php
foreach (Fabriq::cssqueue() as $css) {
  echo "<link href=\"{$css['path']}{$css['css']}.css\" media=\"{$css['media']}\" rel=\"stylesheet\" type=\"text/css\" />\n";
}

Description

Used by the index.php file to determine whether or not the configuration file exists. If the configuration file does not exist, the index.php file attempts to call the install.php file to walk the developer through the steps of creating the configuration file.

Parameters

• l (optional) default: NULL – the layout to use

Description

Get or set the layout to be used. Called in controller actions.

Example(s)

// get the layout
echo Fabriq::layout();
// set the layout
Fabriq::layout('account');

Parameters

• model - the name of the model to include

Description

Includes the given model. NOTE: when naming model files, the name of the file should match the model (ex: a model named Users should be in the file Users.model.php)

Example(s)

Fabriq::model('Users');

Parameters

• r default value: NULL – the type of render to process

Description

This function tells Fabriq what type of render to process. The function works as a getter and setter for the render option. Recognized values are layout, view, none, and NULL. The default render set by Fabriq is layout. If NULL is passed in or the function is called with no parameters, the function returns the current render option.

Example(s)

// example blog controller class
class blog_controller extends Controller {
  public function create() {
    Fabriq::render('layout');
    // create action code...
  }
 
  public function read() {
    Fabriq::render('view');
    // read action code...
  }
 
  public function destroy() {
    Fabriq::render('none');
    // destroy action code...
  }
}

Parameters

• c default value: NULL –

Description

This function acts as a getter and setter for the render controller to be executed. If the value is different from controller, then the render action in the render controller is executed after the action in the controller. If NULL is passed in, the render controller name is returned.

NOTE: this function was moved to the /core/BaseMapping.class.php file. To use the action function, it can be called using PathMap::render_controller(). Please update your code to use the new version. The /app/PathMap.class.php extends the /core/BaseMapping.class.php. Only the /app/PathMap.class.php file should be edited.

Example(s)

// deprecated example
echo "The render controller that may execute the render action is: " . Fabriq::render_controller();
// example that should be followed
echo "The render controller that may execute the render action is: " . PathMap::render_controller();