railroad/railcontent

Very simple and flexible CMS system for developers.

Tuesday, July 31, 2018
by calebfavor
Repository
3 Watchers
0 Stars
6,450 Installations

PHP
0 Dependents
0 Suggesters
2 Forks
0 Open issues
100 Versions
37 % Grown

The README.md

Railcontent

Data first simple CMS., _(*1)

Railcontent

Progress-Bubbling

When a content has its progress saved, a UserContentProgressSaved event is fired. This event triggers the bubbleProgress method of UserContentProgressService. If the content saved—that triggered the event—has a parent, the type of that parent will be evaluated against config values defined in you're application's copy of /config/railcontent.php., _(*2)

This is useful when you have a kind of content (like "course" for Drumeo) that should be marked as started when a child is started. However, if you have a kind of content that you don't want marked as started (say perhaps because it has it's own system, like Learning-Paths for Drumeo), you don't want the parent started when the child is. Keep in mind that children can have multiple parents, thus if a lesson is started we may want that to cause one parent to be started, but another to remain unstarted., _(*3)

You can restrict which content parent types should be marked as started or completed when their children are started by omitting them from the allowed_types lists., _(*4)

'allowed_types_for_bubble_progress' => [
    'started' =>    [
        'foo','bar', 'baz' 
    ],
    'completed' =>  [ 
        'foo','bar', 'qux'
    ]
];

You can have a value in both list if it has no restrictions, or just one, or neither., _(*5)

Note that this only applies for progress bubbling. This does not effect the startContent, completeContent, or saveContentProgress methods of UserContentProgressService., _(*6)

Example

Say you have a parent of a type for which bubbling of started progress event is not allowed., _(*7)

If that parent is itself not yet started, it will not have progress record written or updated when one of it's children is. If it's in the "completed" allowed-types list, it can be marked as completed if all it's children are, but unless exactly that happens, it will not have it's progress_percent saved. That is unless it is already started of it's own accord. If the parent is already started, then when a child is updated, the progress_percent value of the parent will be edited as per any other content of a type allowed as per the allowed-for-started config settings., _(*8)

Validation

Non-technical Introduction

This is business rules validation that helps ensure content requiring specific information|components is protected from not meeting said requirements. For example, you may have a state like "published", which you want only assigned to content this is ready for viewing by your customers. You don't want to accidentally launch content that is missing significant components and would reflect poorly on the brand. Thus, rules can be set within the Content Management System (CMS) to help ensure content meets set criteria., _(*9)

Without validation, all edits are persisted "unchecked" - even if nonsensical*. This can produce a site with incomplete content, and thus a poor user experience. To prevent this, rules can be configured by technical administrators. Edits to content will - as they're submitted - be "checked" against these set rules. That is, they will be "validated"., _(*10)

When initially creating a piece of content, we need to assume a period where it will fail all validation - as all the fields will empty! Thus, "states" such as "draft", "scheduled", and "published" can be set on content. The Validation rules are then set to only apply to certain "protected" states - typically "scheduled", and "published"., _(*11)

Knowing this, we can now look at the two situations which trigger validation: 1. Request to change a content's state to a "protected" state. 2. A content has a "protected" state, any details changes will trigger validation., _(*12)

In each of the above cases, a validation failure will result (respectively) in: 1. the requested change to a protected state will not be executed - the state will remain unchanged. Note that if the current|previous state was a protected or unprotected state is irrelevant. All that happens is the requested state change is not persisted. 2. the requested change will not be made. To do so would result in having content that breaks the business rules for its type., _(*13)

* except for Musora CMS, for Musora Media, 2018, where currently video IDs, and exercise IDs are first validated by another system that will not enable setting a nonsensical value, regardless of content state., _(*14)

Technical Introduction

This is "business rules" validation. This does not validate that the content is suitable for the the database. That is handled by rules hard-coded into a "rules" method in entity-and-action-specific Request classes (extension of Railroad\Railcontent\Requests\FormRequest, all in /src/Requests). Rather, this "business rules" validation is used when content unique to your application requires specific infomation according to it's intended use within your domain. For example, for consumable consumer education and entertainment, you may have states like "public" or "published", which you want only assigned to content that has all components required to meet your requirements for quality and completeness., _(*15)

In your application's config/ directory, you should have a railcontent.php file. In there under 'validation', you can list the brands for which you want validation. If a brand is not present, validation will not run., _(*16)

The rules are organized thusly:, _(*17)

brand -> content type -> protected states -> rules*, _(*18)

* see "About Defining Rules" section below, _(*19)

About Defining Rules

The key for each content-type must be the same as the string representing content-type used in the application. Each content-type's rules has two required components, and can have an additional optional component:, _(*20)

fields
data
number_of_children (optional)

If a content-type exists in these rules, then validation will run as described above. If the content-type is not represented in the rules, the validation rules will not protect that content type according to the rules., _(*21)

(There is not currently a way to provide custom "restrictions" for a select content-type. See the "todo.md" file for notes about how to change this package to make that possible.), _(*22)

Note about field or datum that reference another piece of content

When a content has a field or datum that is itself a reference to another piece of content, the id of that referenced content is what is evaluated., _(*23)

Thus, your rule must accommodate|use this., _(*24)

For example: A video has a field with the id of a video... and that video is a piece of content itself. The rule might look like this:, _(*25)

'video' => [
    'rules' => [
        Rule::exists($connectionMaskPrefix . 'content', 'id')->where(
            function ($query) { $query->where('type', 'vimeo-video'); }
        ),
        'required'
    ]
],

This is done using the following logic within the "validateContent" method of the "\Railroad\Railcontent\Requests\CustomFormRequest" class:, _(*26)

if (($contentProperty['type'] ?? null) === 'content' && isset($inputToValidate['id'])) {
    $inputToValidate = $inputToValidate['id'];
}

You can see that if the ($contentProperty['type'] is "content" and the, _(*27)

Important Note about the "numeric" rule

If you don't include the "numeric" rule here, this doesn't work. I don't know why and it
doesn't make sense. Laravel' validator should - for the min, max, and size rules according to the
documentation - evaluate the evaluated value in regards to these rules based on the data-type
of the value under evaluation. If it's a string, it will evaluate the length. Thus, if min:5,
the string must have at least 5 characters. If the value is an integer min:5 will pass only if
the value of the integer is 5 or higher. If an array it evaluates the count. You get the idea.
But here it's failing to do that. Even if casting the value to an int just to be sure, and then
debugging to make sure it's not changed into a string somehow (because that would break it of
course because the string "6" would only pass for "min:1" and would fail for "min:2" and upwards
but the integer 6 would pass for "min:2" to "min:6". Maybe something about the "numeric" rule
is casting it to an int somewhere I didn't see. Anyways this is smelly af because that "numeric"
condition is just there as a hack to circumvent failure of the system to act as expected. But
it works, so fuck.

(^ Crudely written note copied here from comment in code), _(*28)

Specifying rules

You can "...specify the validation rules as an array instead of using the | character to delimit them" (from "Specifying A Custom Column Name" section here)., _(*29)

For example; both bar and bax here would have the same effect:, _(*30)

foo => [
    'bar' => ['max:2|required'],
    'bax' => [
        'max:2',
        'required'
    ]
]

Details of options available for each brand

fields

(required), _(*31)

Array of rules keyed by the field they apply to. Each keyed value in this "fields" array represents one field. The value for each can be either a string or array representing the rules available in the Laravel version used. For details about Laravel rules, see their documentation., _(*32)

data

(required), _(*33)

Same as fields, except data., _(*34)

number_of_children

(optional), _(*35)

See "Important Note about the "numeric" rule" note above., _(*36)

Provide this in cases where a content type requires a set number of children before it can be set to a "restricted" state (perhaps "published" or "scheduled")., _(*37)

Can be defined either of the two ways:, _(*38)

'number_of_children' => 'min:3', 
'number_of_children' => ['rules' => 'min:3'],

Unlike the rest of the rules, this doesn't need to be an item called "rules" in an array. It can be, or not. Either way will work., _(*39)

Configuration Example

'validation' => [
    'brand' => [
        'content-type' => [
            'content-status|content-status|...' => [
                'number_of_children' => 'min:3',
                'fields' => [
                    'key' => [
                        rules => ['validation-rule', 'validation-rule', ...],
                        'can_have_multiple' => true/false],
                    ],
                    'key' => [
                        rules => 'validation-rule|validation-rule|...',
                        'can_have_multiple' => true/false],
                    ],
                ],
                'data' => [
                    'key' => [
                        rules => ['validation-rule', 'validation-rule', ...],
                        'can_have_multiple' => true/false],
                    ],
                    'key' => [
                        rules => 'validation-rule|validation-rule|...',
                        'can_have_multiple' => true/false],
                    ],
                ]
            ]
        ],
    ]
]

MultipleColumnExistsValidator

NOTE: This actually doesn't work properly right now, so if the above may not quuuuite be accurate., _(*40)

Is ^ this still accurate? (Jonathan, July 2018), _(*41)

You may not be able to use the Rule::Exists() feature of the Laravel's validator where you specify your validation rules. Perhaps you specify your rules in configuration files that are cache calling a method statically like that breaks them for some reason., _(*42)

To overcome this, there exists a custom rule in this package called (Railroad\Railcontent\Validators) "MultipleColumnExistsValidator". Also, there is a test for it: (Tests\Feature) "MultipleColumnExistsRuleTest"., _(*43)

Look at the class to understand fully how it works, if need be. If you only need a quick look, this is what it does:, _(*44)

$exists = $this->databaseManager->connection($connection)
    ->table($table)
    ->where($row, $value)
    ->exists();

You pass these arguments via your rules:, _(*45)

$connection = $parameterParts[0];
$table = $parameterParts[1];
$row = $parameterParts[2];
$value = isset($parameterParts[3]) ? $parameterParts[3] : $value;

A configured rule looks like this:, _(*46)

'video' => 'exists_multiple_columns:mysql,railcontent_content,id&mysql,railcontent_content,type,vimeo-video'

unpacked we get this:, _(*47)

exists_multiple_columns:
    mysql,railcontent_content,id
    &
    mysql,railcontent_content,type,vimeo-video

Breaking down each line:, _(*48)

exists_multiple_columns is the name of the custom rule, _(*49)

mysql,railcontent_content,id is a set or rules for a single "where exists" clause to the database validation that will run., _(*50)

& (ampersand) is our delimiter - since the pipe, or vertical bar (|) is already used by laravel to delimit rules., _(*51)

mysql,railcontent_content,type,vimeo-video is another *"where exists" clause added to the database validation that will run when all clauses are compiled., _(*52)

For the validation to pass in this case, both "where exists" validations must pass., _(*53)

Within each "where exists" validation, values are delimited by commas (,)., _(*54)

So, the first set has THREE (3) values, _(*55)

mysql
railcontent_content
id

And the second set has FOUR (4) values:, _(*56)

mysql
railcontent_content
type
vimeo-video

The first THREE (3) parameters are required, the FOURTH (4th)) is optional., _(*57)

As you may have guessed by the code snippet above, the parameters are as such:, _(*58)

connection (required)
table (required)
$row (required)
$value (optional)

If the FOURTH (4th) parameter is not passed, the value used for the "where exists" evaluation will be the value which the whole rule is validating., _(*59)

Reviewing the example, we see that we're validating the value submitted to the video input against the rule 'exists_multiple_columns:mysql,railcontent_content,id&mysql,railcontent_content,type,vimeo-video' to ensure that the value matches the two clauses mysql,railcontent_content,id and mysql,railcontent_content,type,vimeo-video. The first ensures that by the connection "mysql", in the table "railcontent_content", the value under validation matches a value in the "id" column. The second does the same, but the value isn't the values passed in, but rather the value hard-coded in rule as the FOURTH parameter - "vimeo-video". Thus, it ensures that there exists a record where the value passes in matches something in the "id" column and at least one records matching that also has value or "vimeo-video" in it's "type" column., _(*60)

WHERE AND

The above example describes a "WHERE ... AND ... " query. This is standard behaviour - everything must be present in at least one row for the validation to pass., _(*61)

WHERE OR

This describes a "WHERE ... OR ... " query., _(*62)

You can prepend your "clause rule string" (remember these are demarcated from each other with ampersands(&)) with or:, so that for the examples above, the second one instead of looking like this:, _(*63)

mysql,railcontent_content,type,vimeo-video

would look like this, _(*64)

or:mysql,railcontent_content,type,vimeo-video

This works with the preceding rule and when there exists an or: "between" them, they're connected is an or statement., _(*65)

Note that because you can have more than two "clause rule strings" in a rule, you can combine ORs and ANDs thusly:, _(*66)

exists_multiple_columns:
    mysql,railcontent_content,id
    &
    or:mysql,railcontent_content,foo_id
    &
    mysql,railcontent_content,type,vimeo-video
    &
    or:mysql,railcontent_content,slug,'bar baz'

Means that one of the first two "clause rule strings" must match with one of the two last "clause rule strings"., _(*67)

(
    mysql,railcontent_content,id
    OR
    mysql,railcontent_content,foo_id
)
AND
(
    mysql,railcontent_content,type,vimeo-video
    OR
    mysql,railcontent_content,slug,'bar baz'
)

The Versions

31/07 2018

dev-dot-notation

Very simple and flexible CMS system for developers.

library railcontent

Very simple and flexible CMS system for developers.

railroad/railcontent

The README.md

Railcontent

Progress-Bubbling

Example

Validation

Non-technical Introduction

Technical Introduction

About Defining Rules

Note about field or datum that reference another piece of content

Important Note about the "numeric" rule

Specifying rules

Details of options available for each brand

fields

data

number_of_children

Configuration Example

MultipleColumnExistsValidator

WHERE AND

WHERE OR

The Versions

dev-dot-notation

The Requires

The Development Requires

by Caleb Favor

5.61.24

The Requires

The Development Requires

by Caleb Favor

5.61.23

The Requires

The Development Requires

by Caleb Favor

dev-master

The Requires

The Development Requires

by Caleb Favor

dev-user-permission

The Requires

The Development Requires

by Caleb Favor

v0.4.02

The Requires

The Development Requires

by Caleb Favor

v0.4.01

The Requires

The Development Requires

by Caleb Favor

5.61.22

The Requires

The Development Requires

by Caleb Favor

v5.6.27

The Requires

The Development Requires

by Caleb Favor

5.61.21

The Requires

The Development Requires

by Caleb Favor

v0.4.0

The Requires

The Development Requires

by Caleb Favor

5.61.20

The Requires

The Development Requires

by Caleb Favor

v5.6.26

The Requires

The Development Requires

by Caleb Favor

5.61.19

The Requires

The Development Requires

by Caleb Favor

5.61.18