\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{{[}deleted{]}} \pdfinfo{ /Title (magento-2.pdf) /Creator (Cheatography) /Author ({[}deleted{]}) /Subject (Magento 2 Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{3F2875} \definecolor{LightBackground}{HTML}{F3F1F6} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Magento 2 Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{{[}deleted{]}} via \textcolor{DarkBackground}{\uline{cheatography.com/34559/cs/10816/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}{[}deleted{]} \\ \uline{cheatography.com/deleted-34559} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 15th February, 2017.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{x{2.58804 cm} x{2.38896 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Command line}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{Cache Management}} & {\bf{Example of use}} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} {\emph{Clear all caches:}} & php magento cache:clean \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} {\emph{Clearing a single cache:}} & php magento cache:clean config \tn % Row Count 5 (+ 2) % Row 3 \SetRowColor{white} {\emph{Flush all caches:}} & php magento cache:flush \tn % Row Count 7 (+ 2) % Row 4 \SetRowColor{LightBackground} {\emph{Flushing a single cache:}} & php magento cache:flush config \tn % Row Count 9 (+ 2) % Row 5 \SetRowColor{white} {\bf{Index Management}} & {\bf{Example of use}} \tn % Row Count 10 (+ 1) % Row 6 \SetRowColor{LightBackground} {\emph{Runs all available indexes:}} & php magento indexer:reindex \tn % Row Count 12 (+ 2) % Row 7 \SetRowColor{white} {\bf{Cron}} & {\bf{Example of use}} \tn % Row Count 13 (+ 1) % Row 8 \SetRowColor{LightBackground} {\emph{Runs all cron jobs by schedule:}} & php magento cron:run \tn % Row Count 15 (+ 2) % Row 9 \SetRowColor{white} {\bf{Help \& Knowledge}} & {\bf{Example of use}} \tn % Row Count 16 (+ 1) % Row 10 \SetRowColor{LightBackground} {\emph{Display help/infos about a command}} & php magento help indexer:reindex \tn % Row Count 18 (+ 2) % Row 11 \SetRowColor{white} {\emph{Lists all available CLI commands}} & php magento list \tn % Row Count 20 (+ 2) % Row 12 \SetRowColor{LightBackground} {\bf{Developement \& Production}} & {\bf{Example of use}} \tn % Row Count 22 (+ 2) % Row 13 \SetRowColor{white} {\emph{Set to the production mode to harden your setup}} & php magento \seqsplit{deploy:mode:setproduction} \tn % Row Count 25 (+ 3) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{{\emph{(exceptions are not displayed to the user, only logged to log files)}}} \tn % Row Count 27 (+ 2) % Row 15 \SetRowColor{white} {\emph{Developer mode is less secure than Production mode}} & php magento \seqsplit{deploy:mode:setdeveloper} \tn % Row Count 30 (+ 3) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{x{2.58804 cm} x{2.38896 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Command line (cont)}} \tn % Row 16 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{{\emph{provides verbose logging (errors displayed in browser) enhanced debuggingand disables static view file caching}}} \tn % Row Count 3 (+ 3) % Row 17 \SetRowColor{white} {\bf{Recompile Store}} & {\bf{Example of use}} \tn % Row Count 4 (+ 1) % Row 18 \SetRowColor{LightBackground} Recompile the Magento 2 codebase & php magento setup:di:compile \tn % Row Count 6 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.18988 cm} x{2.78712 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{EVENTS.XML FILE}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Custom events can be dispatched by simply passing in a unique event name to the event manager when you call the dispatch function. Your unique event name is referenced in your module's {\bf{events.xml}} file where you specify which observers will react to that event.} \tn % Row Count 6 (+ 6) % Row 1 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{The observer xml element has the following properties} \tn % Row Count 8 (+ 2) % Row 2 \SetRowColor{LightBackground} {\bf{name (required)}}\{\{noshy\}\} & The name of the observer for the event definition \tn % Row Count 11 (+ 3) % Row 3 \SetRowColor{white} {\bf{instance (required)}}\{\{noshy\}\} & The fully qualified class name of the observer \tn % Row Count 14 (+ 3) % Row 4 \SetRowColor{LightBackground} {\bf{disabled}}\{\{noshy\}\} & Determines whether this observer is active or not. Default value is false \tn % Row Count 18 (+ 4) % Row 5 \SetRowColor{white} {\bf{shared}}\{\{noshy\}\} & etermines the lifestyle of the class. Default is false \tn % Row Count 21 (+ 3) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{{\bf{Example}}} \tn % Row Count 22 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{`\textless{}event name="my\_module\_event\_before"\textgreater{}\{\{nl\}\}\textless{}observer name="myObserverName" instance="MyCompany\textbackslash{}MyModule\textbackslash{}Observer\textbackslash{}MyObserver" /\textgreater{}\{\{nl\}\}\textless{}/event\textgreater{}`} \tn % Row Count 25 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.09034 cm} x{2.88666 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{DI.XML File}} \tn % Row 0 \SetRowColor{LightBackground} {\bf{What case we use di.xml ?}} & \{\{fa-bolt\}\} We can use di.xml for (rewrite) preference of a particular class. \tn % Row Count 4 (+ 4) % Row 1 \SetRowColor{white} & \{\{fa-bolt\}\} We can send a new or replace the existing class arguments. \tn % Row Count 8 (+ 4) % Row 2 \SetRowColor{LightBackground} & \{\{fa-bolt\}\} Use plugins to do some stuff before, after and around a function \tn % Row Count 12 (+ 4) % Row 3 \SetRowColor{white} & \{\{fa-bolt\}\} By using virtualTypes creating a sub-class of another class. \tn % Row Count 16 (+ 4) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{{\bf{Example for Preference}}} \tn % Row Count 17 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{`\textless{}preference for="Magento\textbackslash{}Customer\textbackslash{}Api\textbackslash{}AddressRepositoryInterface" type="Magento\textbackslash{}Customer\textbackslash{}Model\textbackslash{}ResourceModel\textbackslash{}AddressRepository" /\textgreater{}`} \tn % Row Count 20 (+ 3) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Above code, When someone asks you to instantiate a Magento\textbackslash{}Customer\textbackslash{}Api\textbackslash{}AddressRepositoryInterface it will instantiate a Magento\textbackslash{}Customer\textbackslash{}Model\textbackslash{}ResourceModel\textbackslash{}AddressRepository object (the type attribute).} \tn % Row Count 25 (+ 5) % Row 7 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{{\bf{Example for Arguments}}} \tn % Row Count 26 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{`\textless{}type name="Magento\textbackslash{}Customer\textbackslash{}Model\textbackslash{}ResourceModel\textbackslash{}Group" shared="false"\textgreater{} \textless{}arguments\textgreater{} \textless{}argument name="groupManagement" xsi:type="object"\textgreater{}Magento\textbackslash{}Customer\textbackslash{}Api\textbackslash{}GroupManagementInterface\textbackslash{}Proxy\textless{}/argument\textgreater{} \textless{}/arguments\textgreater{} \textless{}/type\textgreater{}`} \tn % Row Count 31 (+ 5) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{x{2.09034 cm} x{2.88666 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{DI.XML File (cont)}} \tn % Row 9 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{In the above code, We are sending object as an argument, we are saying system to insert {\bf{"Proxy"}} class as an object with the name of groupManagement. Also we can use Arguments for replacing the existing argument too.} \tn % Row Count 5 (+ 5) % Row 10 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{{\bf{Example for Plugin}}} \tn % Row Count 6 (+ 1) % Row 11 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{`\textless{}type name="Magento\textbackslash{}Customer\textbackslash{}Model\textbackslash{}ResourceModel\textbackslash{}Visitor"\textgreater{} \textless{}plugin name="catalogLog" type="Magento\textbackslash{}Catalog\textbackslash{}Model\textbackslash{}Plugin\textbackslash{}Log" /\textgreater{} \textless{}/type\textgreater{}`} \tn % Row Count 9 (+ 3) % Row 12 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{In the above code , public function clean(\$object) in visitor class is called after public function afterClean(Visitor \$subject, \$logResourceModel) which is in Log class.} \tn % Row Count 13 (+ 4) % Row 13 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{{\bf{Example for Virtual Types}}} \tn % Row Count 14 (+ 1) % Row 14 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{\textless{}virtualType \seqsplit{name="ourVirtualTypeName"} type="Pulsestorm\textbackslash{}TutorialVirtualType\textbackslash{}Model\textbackslash{}Argument1"\textgreater{} \textless{}/virtualType\textgreater{}} \tn % Row Count 17 (+ 3) % Row 15 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Creating a virtual type is sort of like creating a sub-class for an existing class. With virtual types, the only behavior you can change in your virtual sub-class is which dependencies are injected.} \tn % Row Count 21 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Design Patterns In Magento}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Model View Controller Pattern (MVC)}}} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Design pattern where business, presentation and coupling logic are separated} \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Front Controller Pattern}}} \tn % Row Count 4 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Makes sure that there is one and only one point of entry. All requests are investigated, routed to the designated controller and then processed accordingly to the specification} \tn % Row Count 8 (+ 4) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Factory Pattern}}} \tn % Row Count 9 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Responsible of factorizing (instantiating) classes.} \tn % Row Count 11 (+ 2) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Singleton Pattern}}} \tn % Row Count 12 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Checks the whether this class has already been instantiated before, this results in a shared instance.} \tn % Row Count 15 (+ 3) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Registry Pattern}}} \tn % Row Count 16 (+ 1) % Row 9 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Internal registry: a global scoped container for storing data} \tn % Row Count 18 (+ 2) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Prototype Pattern}}} \tn % Row Count 19 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{It defines that instances of classes can retrieve a specific other class instance depending on its parent class (the prototype)} \tn % Row Count 22 (+ 3) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Object Pool Pattern}}} \tn % Row Count 23 (+ 1) % Row 13 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{A box with objects so that they do not have to be allocated and destroyed over and over again.} \tn % Row Count 25 (+ 2) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Iterator Pattern}}} \tn % Row Count 26 (+ 1) % Row 15 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{The iterator pattern defines that there is a shared way to iterate over a container with objects.} \tn % Row Count 28 (+ 2) % Row 16 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Lazy Loading Pattern}}} \tn % Row Count 29 (+ 1) % Row 17 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Lazy loading ensures that loading data is delayed until the point when it is actually needed.} \tn % Row Count 31 (+ 2) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Design Patterns In Magento (cont)}} \tn % Row 18 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Service Locator Pattern}}} \tn % Row Count 1 (+ 1) % Row 19 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{The service locator pattern abstracts away the retrieval of a certain service. This allows for changing the service without breaking anything.} \tn % Row Count 4 (+ 3) % Row 20 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Module Pattern}}} \tn % Row Count 5 (+ 1) % Row 21 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{An implementation of the module pattern would make sure that each element can be removed or swapped.} \tn % Row Count 7 (+ 2) % Row 22 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\bf{Observer Pattern}}} \tn % Row Count 8 (+ 1) % Row 23 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{By defining observers (or listeners), extra code can be hooked which will be called upon as the observed event fires.} \tn % Row Count 11 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}