+ To add a root element and/or its attributes, override the root method:
+
+ To disable the addition of the main element, specify its name as empty - null or
+ "".
+
+ To add information to the beginning of the root element (if present) or without it,
+ override the
+ info method in the feed class and call the creation of an object that extend the
+ DragonCode\LaravelFeed\Feeds\Info\FeedInfo class:
+
+ To change the header and footer, override the header and footer methods:
+
- In some cases, you need to add various information to the beginning of the file.
- To do this, use the info method:
-
- If it is necessary to change the file cap, override the header method in the feed class:
-
+ In some cases, you need to place an array of elements with the same names. +
-
+ To do this, add a @ symbol to the beginning of the key name:
+
+ Result: +
-- In some cases, you need to place an array of elements with the same names. -
+
- To do this, add a @ symbol to the beginning of the key name:
-
+ You can also use values for such elements. To insert them, use the reserved word @value.
+
+ For example: +
-- Result: -
++ Result: +
-
- You can also use values for such elements. To insert them, use the reserved word @value.
-
+ By default, feeds will be stored in the public storage,
+ and the file name will be automatically generated from the feed class name after
+ App\Feeds\ in kebab-case format.
For example:
- Result:
+ You can change these values by overriding the $storage property and the
+ filename method:
+ Database queries use chunks, which are 1000 bytes by default.
+ You can change this by overriding the chunkSize method:
+
- You can also create the desired classes using the - Laravel Idea plugin for - PhpStorm: -
- -
- - To create a feed class, use the console command: -
- -
- As a result of executing the console command, the file
- app/Feeds/UserFeed.php will be created.
-
- Also, this console command can create classes of the element and information along with the feed class.
- To do this, use --item and --info parameters.
-
- Shortcuts are also available: -
- -+ The most convenient way to create the necessary classes is to use the + Laravel Idea plugin for + PhpStorm. +
+ +
+
+ To create a feed class, use the %command-make-short% console command:
+
+ This will create a feed file. For example, app/Feeds/UserFeed.php.
+
+ Also, this console command can create classes of the element and information along with the feed class.
+ To do this, use --item and --info parameters.
+
+ Shortcuts are also available: +
+ ++ When creating a feed, an operation/migration will also be created to add it to the database. +
+ +
+ If the project uses the
+
+
+ This is necessary to add and manage information about feeds in the database. +
+- For example, we use this content for the Feed class: + Fill in the main feed class. For example:
-- For example, we use this content for the Feed Item class: -
+- According to this example, the XML file with the following contents will be generated as a result: -
++ Fill in the feed item class. For example: +
-
- To generate feeds, create the classes of feeds and its element, add links to the file
- %config-filename%, next call the console command:
-
+ To generate all active feeds, use the console command: +
-
+ As a result, all active feeds (is_active = true) will be launched from the
+ feeds table (or the one you specified in the %config-filename% file).
+
- To generate a specific feed class, specify the class reference or name relative to the
- App\Feeds namespace.
+ Please note that when you call the command without a parameter,
+ the console will display links to all feeds,
+ even those with the is_active property set to false.
- For example:
+ However, instead of being launched for execution, such feeds will be marked with the
+ SKIP status.
feeds table in the database.
+
- Each feed can be created in a certain folder of a certain storage.
+ To generate a specific feed, call the %command-generate-short% console command,
+ passing the feed ID from the feeds table as its parameter:
- To indicate the storage, override the property of $storage in the feed class:
+ To automate feed generation, use a
+ schedule.
+ To do this, specify the helper call in the
+ routes/console.php file (the default path, unless you have changed it):
- By default, storage is public.
+ This will enable you to register calls to all active feeds according to the launch schedule you specified in the
+ expression column of the database.
- The path to the file inside the storage is indicated in the filename method:
+ You can also specify the schedule directly according to your own rules.
+ In this case, only the feeds you specify will be executed.
- By default, the class name in kebab-case is used.
- For example, user-feed.xml for UserFeed class.
-
- To get the latest version of
-
- You can publish a %config-filename% configuration file using the console command:
-
- This is the contents of the published %config-filename% file:
-
- This setting contains information about the generated feeds. - They can be both turned on and turned off depending on the environment or other conditions. -
++ You should publish the + migration + and the + %config-filename% + config file with: +
-- This setting indicates in what form the XML records should be exported - using or without formatting. -
-
+ %config-filename% file.
+
+ Now you can run migrations and proceed to create feeds. +
-
- Add a link to the feed class in the %config-filename% file:
-
- Add a link to the feed class in the %config-filename% file:
-
- Add a link to the feed class in the %config-filename% file:
-
+ Check the operation/migration + file that was created for you and run the console command: +
+ +