fuel / docs Goto Github PK

Two questions.

Is anyone currently working on having migrations inside of modules?

If you are is there anywhere I can check in the future to answer these questions so I don't have to bug you?

Well, maybe three questions. If it's not currently in development, I'm going to develop it myself. Would you rather I develop a separate class or add it into the current one?

Fieldset needs a page that explains how to use it.

http://fuelphp.com/docs/general/classes.html has a wrong link to controllers http://fuelphp.com/docs/general/controllers.html should be http://fuelphp.com/docs/general/controllers/base.html

Probably just short intro and link to fieldset class usage.

In RC 3 to load config from a module is not :

Config::load('foo\custom', 'bar');

but

Config::load('foo::custom', 'bar');

Intro, config & advanced still need to be written.

Update missing from usage documentation for DB Class

http://fuelphp.com/docs/classes/database/usage.html#updating -> links to inserting

This should be set on the response object of the current controller, can't be used static as it's explained in the docs.

• In Fieldset page ( http://fuelphp.com/dev-docs/classes/fieldset.html ) there are two instance() methods
• All "Validation" links in this page are wrong ( go to a non existent page )
• Also in errors() and show_errors() methods, the example code use :
  $validated_values = $article_form->validated();
  instead of
  $validated_values = $article_form->errors(); and $validated_values = $article_form->show_errors();

The table at the bottom is still incomplete.

the "slightly advanced routing" makes reference to a 'routes' array just like

<?php
'routes' => array(
    'blog/(:any)'      => 'blog/entry/$1' //and so on...
);

which makes you think all your custom routes have to be placed under that 'specific' array, inside of the array returned in routes.php config file

It made me test like carzy! and solution was so easy ¬¬

https://github.com/fuel/docs/blob/master/classes/input.html#L78

Should be " .... when called via DELETE"

-J
(This fix seemed too small to be a "pull request")

In docs there isn't a section that explain Profiler class and supported methods

The "parameters" table for the output() method seems to be wrong. Probably copied from save().

In http://fuelphp.com/dev-docs/classes/uri.html missing Uri::base() function :

public static function base($include_index = true)
{
    $url = \Config::get('base_url');

    if ($include_index and \Config::get('index_file'))
    {
        $url .= \Config::get('index_file').'/';
    }

    return $url;
}

• logger() should be mentioned with the Log class
• __() should be mentioned alongside Lang::line()
• e() should be mentioned with Security::htmlentities() and on the Security page
• array_to_attr() and html_tag() should be mentioned with the HTML class somewhere
• in_arrayi() should be mentioned with the Arr class
• render() should be mentioned with the View class/general docs

https://github.com/fuel/core/blob/master/base.php

Packages aren't documented yet.

Modules & Hmvc should be separated as Modules aren't necessary for HMVC.

Wouldn't it be a better idea to start documentation as a managed wiki? Managed in the way that you only allow a few known developers to directly change anything and allow for everyone else to submit changes to the docs? That way it's a lot easier and faster to create documentation for anyone who wants to contribute, but doesn't have Git figured out yet.

Speaking for myself, I'd edit a wiki fast in between other stuff if I'd notice an error. But to contribute to Github would take me just that much longer that I'd postpone editing and most likely will forget what & why I thought an edit was needed.

in file:
docs / classes / file / usage.html @ 152

File::create(DOCROOT, 'test', 0755);

I think it should be

File::create_dir(DOCROOT, 'test', 0755);

http://fuelphp.com/docs/general/views.html

php code in boxes "Method 1" and "Method 2" is invalid. You can see for example - function call outside a method. It was probably meant to be in action method of the controller.

This needs more explanation and usage examples, might just link to something in the fieldset usage docs.

What I propose is:

• All clas methods have an ID in the article tag prefixed with "method_"
• Every h* should have a unique ID (at file level) corresponding with the following content.

In description about trouble "Oil cannot connect to DB but application can" text in tag <pre> is overlaying (hope i right formulated) border. May be it must have in css same params: "overflow: auto;". This parameter will do text more readable and remove horizontal scrolling of page.

No docs at all for this class...

There needs to be an overview of all the security measures Fuel offers.

In Fuel class missing "add_module()" and "module_exists()" methods

This isn't the Form::input() alias anymore, generates a button element.

Need explanation on how they work and how to configure the DB for them.

Double "folder" word in:
«This will set the asset path back to the default folder folder doctroot/public/assets­»

bad links in strong

protected static $_has_one, $_belongs_to, $_has_many, $_many_many, $_many_through

Relating models to each other is explained in Relating Models
protected static $_observers

Added observers is explained in Observers

A lot of DB methods return a QB object. But these objects, their methods and return values aren't documented anywhere.

In Validation page : http://fuelphp.com/dev-docs/classes/validation/validation.html

There's a "Fieldset" link in first paragraph :
"The Validation class helps you validate user input, if you want to create a form & its validation at the same time use the -->Fieldset<-- class instead."

This link go to a non existent page.

In /docs/installation/instructions.html under the heading 'Manual Installation' theres an example of the Fuel directory structure. The oil script resides in the public directory whereasby default it's in the root. If it's deliberately in public then there should be a note to change the paths variables in oil as well as in index.php.

There's another minor typo in the Asset class documentation. Under the js method there's an example that calls the css method instead of js.

Please do point this out if I just can’t see it, but there isn’t anywhere in the docs that explains how to write out a model. The Models page briefly mentions using Model_ as a prefix, but stops there.

Should an example model be included with Fuel? Or perhaps a few examples of different models included in the Docs? Right now I can’t find a simple answer to using the DB class with a model.

What do you think about translating docs on another language? I translated any pages on russian and want to complete translate all docs.

Should only be superficial, all extensive stuff should go with the specific relationship pages.

When going through the docs, I notice some pages where the 'default' column defines the default value of the parameter, and other define the type.

Should we not define both (i.e. add an extra column) because I feel both are relevant when documenting the method.

Some parts, the $_properties variable in particular, really need more explanation.

Steps to reproduce:

1. Create two migrations (001 & 002).
2. Refine to the latest Migration:
   $ php oil refine migrate
   Migrated to latest version: 2.
3. Refine to Migration 0:
   $ php oil refine migrate --version=0
   Error: Could not migrate to latest version, still using 2.
4. Refine to Migration 1:
   $ php oil refine migrate --version=1
   Migrated to version: 1.
5. Refine to Migration 0:
   $ php oil refine migrate --version=0
   Migrated to latest version: 2.

Not huge, but it would be nice to be able to go back to 0 using oil.

Should be in 1 place, these need to be merged. Probably with all method descriptions in Classes and a link to that page at the bottom of the General page.

Entered by Eric Barnes on 4/8/11

The paths in the phpunit bootstrap and xml file are hardcoded and if you change your app path the unit tests will no longer run.

$app_path        = '../app/';
$package_path    = '../fuel/packages/';
$core_path        = '../fuel/core/';

$ php oil test

Warning: require_once(/bootstrap.php): failed to open stream: No such file or directory in /Users/Sites/fuel/oil on line 33

Fatal error: require_once(): Failed opening required '/bootstrap.php' (include_path='.:/usr/lib/php') in /Users/Sites/fuel/oil on line 33

Wan Wizard Responded

Correct, you'll have to update these as you have to update your index.php.

There are no docs yet for unit tests, I'll leave this ticket open because this needs to be documented.